From 13da7449dd7d2cd6c3dabeb6ca5cbd11600499a9 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 16:34:35 +0100 Subject: [PATCH 01/41] add space between code and link --- scripts/lib/api/processHtml.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/lib/api/processHtml.ts b/scripts/lib/api/processHtml.ts index d924e0b7cee..a8d5f90936b 100644 --- a/scripts/lib/api/processHtml.ts +++ b/scripts/lib/api/processHtml.ts @@ -301,7 +301,7 @@ export function processMembersAndSetMeta( if (apiType == "class") { findByText($, $main, "em.property", "class").remove(); - return `

${$child.html()}${github}

`; + return `

${$child.html()} ${github}

`; } if (apiType == "property") { @@ -312,7 +312,7 @@ export function processMembersAndSetMeta( findByText($, $main, "em.property", "property").remove(); const signature = $child.find("em").text()?.replace(/^:\s+/, ""); if (signature.trim().length === 0) return; - return `

${signature}${github}

`; + return `

${signature} ${github}

`; } if (apiType == "method") { @@ -322,7 +322,7 @@ export function processMembersAndSetMeta( } else if (!$child.attr("id")) { // Overload methods have more than one
tag, but only the first one // contains an id. - return `

${$child.html()}${github}

`; + return `

${$child.html()} ${github}

`; } else { // Inline methods $(`

${getLastPartFromFullIdentifier(id)}

`).insertBefore( @@ -332,7 +332,7 @@ export function processMembersAndSetMeta( } findByText($, $main, "em.property", "method").remove(); - return `

${$child.html()}${github}

`; + return `

${$child.html()} ${github}

`; } if (apiType == "attribute") { @@ -344,7 +344,7 @@ export function processMembersAndSetMeta( findByText($, $main, "em.property", "attribute").remove(); const signature = $child.find("em").text()?.replace(/^:\s+/, ""); if (signature.trim().length === 0) return; - return `

${signature}${github}

`; + return `

${signature} ${github}

`; } // Else, the attribute is embedded on the class @@ -377,7 +377,7 @@ export function processMembersAndSetMeta( if (apiType === "function" || apiType === "exception") { findByText($, $main, "em.property", apiType).remove(); - const descriptionHtml = `

${$child.html()}${github}

`; + const descriptionHtml = `

${$child.html()} ${github}

`; const pageHeading = $dl.siblings("h1").text(); if (id.endsWith(pageHeading) && pageHeading != "") { From d01963fdd316673c10fae17873d2dec40ab13202 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 16:56:03 +0100 Subject: [PATCH 02/41] move space --- scripts/lib/api/processHtml.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/lib/api/processHtml.ts b/scripts/lib/api/processHtml.ts index a8d5f90936b..1d499e3f98d 100644 --- a/scripts/lib/api/processHtml.ts +++ b/scripts/lib/api/processHtml.ts @@ -285,7 +285,7 @@ export function processMembersAndSetMeta( .map((child) => { const $child = $(child); const id = $dl.find("dt").attr("id") || ""; - const github = prepareGitHubLink($, $child); + const github = ` ${prepareGitHubLink($, $child)}`; const apiType = getApiType($dl); @@ -301,7 +301,7 @@ export function processMembersAndSetMeta( if (apiType == "class") { findByText($, $main, "em.property", "class").remove(); - return `

${$child.html()} ${github}

`; + return `

${$child.html()}${github}

`; } if (apiType == "property") { @@ -312,7 +312,7 @@ export function processMembersAndSetMeta( findByText($, $main, "em.property", "property").remove(); const signature = $child.find("em").text()?.replace(/^:\s+/, ""); if (signature.trim().length === 0) return; - return `

${signature} ${github}

`; + return `

${signature}${github}

`; } if (apiType == "method") { @@ -332,7 +332,7 @@ export function processMembersAndSetMeta( } findByText($, $main, "em.property", "method").remove(); - return `

${$child.html()} ${github}

`; + return `

${$child.html()}${github}

`; } if (apiType == "attribute") { @@ -344,7 +344,7 @@ export function processMembersAndSetMeta( findByText($, $main, "em.property", "attribute").remove(); const signature = $child.find("em").text()?.replace(/^:\s+/, ""); if (signature.trim().length === 0) return; - return `

${signature} ${github}

`; + return `

${signature}${github}

`; } // Else, the attribute is embedded on the class @@ -377,7 +377,7 @@ export function processMembersAndSetMeta( if (apiType === "function" || apiType === "exception") { findByText($, $main, "em.property", apiType).remove(); - const descriptionHtml = `

${$child.html()} ${github}

`; + const descriptionHtml = `

${$child.html()}${github}

`; const pageHeading = $dl.siblings("h1").text(); if (id.endsWith(pageHeading) && pageHeading != "") { From 580895c769b96e6d6035ae70e1f05eadd9a84e9c Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 16:56:46 +0100 Subject: [PATCH 03/41] remove last space --- scripts/lib/api/processHtml.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/lib/api/processHtml.ts b/scripts/lib/api/processHtml.ts index 1d499e3f98d..195a5fec825 100644 --- a/scripts/lib/api/processHtml.ts +++ b/scripts/lib/api/processHtml.ts @@ -322,7 +322,7 @@ export function processMembersAndSetMeta( } else if (!$child.attr("id")) { // Overload methods have more than one
tag, but only the first one // contains an id. - return `

${$child.html()} ${github}

`; + return `

${$child.html()}${github}

`; } else { // Inline methods $(`

${getLastPartFromFullIdentifier(id)}

`).insertBefore( From 4ebce0e67b8eda39f06f9a5a04860cc3bde3ff2d Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:00:38 +0100 Subject: [PATCH 04/41] Regenerate qiskit 0.19.6 --- docs/api/qiskit/0.19/execute.md | 2 +- docs/api/qiskit/0.19/logging.md | 2 +- docs/api/qiskit/0.19/qiskit.aqua.AquaError.md | 2 +- .../0.19/qiskit.aqua.QuantumInstance.md | 14 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 6 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 4 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 4 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 4 +- .../qiskit/0.19/qiskit.aqua.algorithms.EOH.md | 4 +- .../0.19/qiskit.aqua.algorithms.Grover.md | 4 +- .../qiskit/0.19/qiskit.aqua.algorithms.HHL.md | 10 +- .../0.19/qiskit.aqua.algorithms.IQPE.md | 6 +- ...algorithms.IterativeAmplitudeEstimation.md | 4 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 6 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 6 +- ...qua.algorithms.MinimumEigensolverResult.md | 6 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 4 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.19/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.19/qiskit.aqua.algorithms.QGAN.md | 10 +- .../qiskit/0.19/qiskit.aqua.algorithms.QPE.md | 6 +- .../0.19/qiskit.aqua.algorithms.QSVM.md | 24 +-- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 6 +- .../0.19/qiskit.aqua.algorithms.Shor.md | 4 +- .../0.19/qiskit.aqua.algorithms.Simon.md | 4 +- .../0.19/qiskit.aqua.algorithms.SklearnSVM.md | 12 +- .../qiskit/0.19/qiskit.aqua.algorithms.VQC.md | 24 +-- .../qiskit/0.19/qiskit.aqua.algorithms.VQE.md | 16 +- .../qiskit/0.19/qiskit.aqua.circuits.CNF.md | 4 +- .../qiskit/0.19/qiskit.aqua.circuits.DNF.md | 4 +- .../qiskit/0.19/qiskit.aqua.circuits.ESOP.md | 4 +- ...skit.aqua.circuits.FixedValueComparator.md | 8 +- ....aqua.circuits.FourierTransformCircuits.md | 4 +- .../qiskit.aqua.circuits.LinearRotation.md | 4 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 4 +- ...t.aqua.circuits.PiecewiseLinearRotation.md | 8 +- ...qiskit.aqua.circuits.PolynomialRotation.md | 8 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 4 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 10 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 10 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 8 +- ...aqua.components.feature_maps.FeatureMap.md | 8 +- ...onents.feature_maps.FirstOrderExpansion.md | 2 +- ....components.feature_maps.PauliExpansion.md | 4 +- ...components.feature_maps.PauliZExpansion.md | 2 +- ...omponents.feature_maps.RawFeatureVector.md | 4 +- ...nents.feature_maps.SecondOrderExpansion.md | 2 +- ...ua.components.feature_maps.self_product.md | 2 +- ...t.aqua.components.initial_states.Custom.md | 4 +- ....components.initial_states.InitialState.md | 4 +- ....components.initial_states.VarFormBased.md | 4 +- ...kit.aqua.components.initial_states.Zero.md | 4 +- ...iskit.aqua.components.iqfts.Approximate.md | 2 +- .../0.19/qiskit.aqua.components.iqfts.IQFT.md | 4 +- .../qiskit.aqua.components.iqfts.Standard.md | 2 +- ...mponents.multiclass_extensions.AllPairs.md | 8 +- ...lticlass_extensions.ErrorCorrectingCode.md | 8 +- ...lticlass_extensions.MulticlassExtension.md | 10 +- ...ts.multiclass_extensions.OneAgainstRest.md | 8 +- ...s.neural_networks.DiscriminativeNetwork.md | 10 +- ...nents.neural_networks.GenerativeNetwork.md | 10 +- ...ents.neural_networks.NumPyDiscriminator.md | 14 +- ...ts.neural_networks.PyTorchDiscriminator.md | 16 +- ...onents.neural_networks.QuantumGenerator.md | 14 +- .../qiskit.aqua.components.optimizers.ADAM.md | 12 +- .../qiskit.aqua.components.optimizers.AQGD.md | 12 +- .../qiskit.aqua.components.optimizers.CG.md | 6 +- ...iskit.aqua.components.optimizers.COBYLA.md | 6 +- .../qiskit.aqua.components.optimizers.CRS.md | 4 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 4 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 4 +- .../qiskit.aqua.components.optimizers.ESCH.md | 4 +- .../qiskit.aqua.components.optimizers.GSLS.md | 14 +- ...qiskit.aqua.components.optimizers.ISRES.md | 4 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 6 +- ....aqua.components.optimizers.NELDER_MEAD.md | 6 +- .../qiskit.aqua.components.optimizers.NFT.md | 6 +- ...it.aqua.components.optimizers.Optimizer.md | 16 +- ...iskit.aqua.components.optimizers.POWELL.md | 6 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 6 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 6 +- .../qiskit.aqua.components.optimizers.SPSA.md | 6 +- .../qiskit.aqua.components.optimizers.TNC.md | 6 +- ....components.oracles.CustomCircuitOracle.md | 4 +- ...ponents.oracles.LogicalExpressionOracle.md | 6 +- .../qiskit.aqua.components.oracles.Oracle.md | 4 +- ...qua.components.oracles.TruthTableOracle.md | 6 +- ...qiskit.aqua.components.qfts.Approximate.md | 2 +- .../0.19/qiskit.aqua.components.qfts.QFT.md | 4 +- .../qiskit.aqua.components.qfts.Standard.md | 2 +- ...qua.components.reciprocals.LongDivision.md | 6 +- ...a.components.reciprocals.LookupRotation.md | 6 +- ....aqua.components.reciprocals.Reciprocal.md | 6 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 4 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 6 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 4 +- ...els.MultivariateVariationalDistribution.md | 6 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 4 +- ....uncertainty_models.UniformDistribution.md | 8 +- ...certainty_models.UnivariateDistribution.md | 6 +- ...odels.UnivariateVariationalDistribution.md | 6 +- ...ncertainty_problems.MultivariateProblem.md | 8 +- ...uncertainty_problems.UncertaintyProblem.md | 4 +- ...lems.UnivariatePiecewiseLinearObjective.md | 8 +- ....uncertainty_problems.UnivariateProblem.md | 8 +- ...it.aqua.components.variational_forms.RY.md | 4 +- ....aqua.components.variational_forms.RYRZ.md | 4 +- ...qua.components.variational_forms.SwapRZ.md | 4 +- ...nents.variational_forms.VariationalForm.md | 8 +- .../qiskit.aqua.operators.OperatorBase.md | 36 ++-- ...qua.operators.converters.AbelianGrouper.md | 6 +- ...qua.operators.converters.CircuitSampler.md | 8 +- ...aqua.operators.converters.ConverterBase.md | 4 +- ...a.operators.converters.DictToCircuitSum.md | 4 +- ...a.operators.converters.PauliBasisChange.md | 22 +-- ...aqua.operators.evolutions.EvolutionBase.md | 4 +- ...a.operators.evolutions.EvolutionFactory.md | 4 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 28 +-- ...ua.operators.evolutions.MatrixEvolution.md | 4 +- ...rators.evolutions.PauliTrotterEvolution.md | 8 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 4 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 4 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 4 +- ...rators.evolutions.TrotterizationFactory.md | 4 +- ...rators.expectations.AerPauliExpectation.md | 6 +- ....operators.expectations.ExpectationBase.md | 6 +- ...erators.expectations.ExpectationFactory.md | 4 +- ...perators.expectations.MatrixExpectation.md | 6 +- ...operators.expectations.PauliExpectation.md | 6 +- ...qua.operators.legacy.LegacyBaseOperator.md | 18 +- ...it.aqua.operators.legacy.MatrixOperator.md | 26 +-- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 10 +- ....operators.legacy.WeightedPauliOperator.md | 52 +++--- ...skit.aqua.operators.legacy.Z2Symmetries.md | 14 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 12 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 48 ++--- ...qiskit.aqua.operators.list_ops.SummedOp.md | 8 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 8 +- ....aqua.operators.primitive_ops.CircuitOp.md | 30 ++-- ...t.aqua.operators.primitive_ops.MatrixOp.md | 26 +-- ...it.aqua.operators.primitive_ops.PauliOp.md | 32 ++-- ...qua.operators.primitive_ops.PrimitiveOp.md | 44 ++--- ...aqua.operators.state_fns.CircuitStateFn.md | 36 ++-- ...it.aqua.operators.state_fns.DictStateFn.md | 22 +-- ...qua.operators.state_fns.OperatorStateFn.md | 22 +-- ...qiskit.aqua.operators.state_fns.StateFn.md | 38 ++-- ....aqua.operators.state_fns.VectorStateFn.md | 22 +-- .../0.19/qiskit.aqua.utils.CircuitFactory.md | 26 +-- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.19/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.19/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.19/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.19/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.19/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.19/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.19/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.19/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.19/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.19/qiskit.assembler.disassemble.md | 2 +- .../qiskit.chemistry.FermionicOperator.md | 18 +- .../qiskit/0.19/qiskit.chemistry.MP2Info.md | 6 +- .../qiskit/0.19/qiskit.chemistry.QMolecule.md | 24 +-- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 8 +- ...y.components.initial_states.HartreeFock.md | 4 +- ...stry.components.variational_forms.UCCSD.md | 22 +-- ...qiskit.chemistry.core.ChemistryOperator.md | 6 +- .../0.19/qiskit.chemistry.core.Hamiltonian.md | 4 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 6 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../0.19/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.19/qiskit.circuit.Clbit.md | 2 +- .../0.19/qiskit.circuit.ControlledGate.md | 4 +- .../0.19/qiskit.circuit.EquivalenceLibrary.md | 10 +- docs/api/qiskit/0.19/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.19/qiskit.circuit.Instruction.md | 22 +-- .../0.19/qiskit.circuit.InstructionSet.md | 12 +- .../api/qiskit/0.19/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.19/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 8 +- .../0.19/qiskit.circuit.ParameterVector.md | 8 +- .../0.19/qiskit.circuit.QuantumCircuit.md | 166 +++++++++--------- .../0.19/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.19/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.19/qiskit.circuit.Reset.md | 4 +- .../qiskit/0.19/qiskit.circuit.library.AND.md | 2 +- .../0.19/qiskit.circuit.library.Barrier.md | 8 +- .../0.19/qiskit.circuit.library.C3XGate.md | 6 +- .../0.19/qiskit.circuit.library.C4XGate.md | 6 +- .../0.19/qiskit.circuit.library.CCXGate.md | 8 +- .../0.19/qiskit.circuit.library.CHGate.md | 6 +- .../0.19/qiskit.circuit.library.CRXGate.md | 4 +- .../0.19/qiskit.circuit.library.CRYGate.md | 4 +- .../0.19/qiskit.circuit.library.CRZGate.md | 4 +- .../0.19/qiskit.circuit.library.CSwapGate.md | 6 +- .../0.19/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.19/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.19/qiskit.circuit.library.CXGate.md | 8 +- .../0.19/qiskit.circuit.library.CYGate.md | 6 +- .../0.19/qiskit.circuit.library.CZGate.md | 4 +- .../0.19/qiskit.circuit.library.DCXGate.md | 4 +- .../0.19/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.19/qiskit.circuit.library.GMS.md | 2 +- .../0.19/qiskit.circuit.library.GraphState.md | 2 +- .../0.19/qiskit.circuit.library.HGate.md | 8 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.19/qiskit.circuit.library.IGate.md | 6 +- .../qiskit/0.19/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.19/qiskit.circuit.library.MCMT.md | 6 +- .../0.19/qiskit.circuit.library.MCMTVChain.md | 4 +- .../0.19/qiskit.circuit.library.MSGate.md | 2 +- .../0.19/qiskit.circuit.library.Measure.md | 4 +- .../0.19/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.19/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../qiskit.circuit.library.Permutation.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../qiskit/0.19/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.19/qiskit.circuit.library.RC3XGate.md | 4 +- .../0.19/qiskit.circuit.library.RCCXGate.md | 4 +- .../0.19/qiskit.circuit.library.RXGate.md | 8 +- .../0.19/qiskit.circuit.library.RXXGate.md | 4 +- .../0.19/qiskit.circuit.library.RYGate.md | 8 +- .../0.19/qiskit.circuit.library.RYYGate.md | 4 +- .../0.19/qiskit.circuit.library.RZGate.md | 6 +- .../0.19/qiskit.circuit.library.RZXGate.md | 4 +- .../0.19/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.19/qiskit.circuit.library.Reset.md | 4 +- .../0.19/qiskit.circuit.library.SGate.md | 6 +- .../0.19/qiskit.circuit.library.SdgGate.md | 6 +- .../0.19/qiskit.circuit.library.SwapGate.md | 8 +- .../0.19/qiskit.circuit.library.TGate.md | 6 +- .../0.19/qiskit.circuit.library.TdgGate.md | 6 +- .../0.19/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.19/qiskit.circuit.library.U1Gate.md | 8 +- .../0.19/qiskit.circuit.library.U2Gate.md | 6 +- .../0.19/qiskit.circuit.library.U3Gate.md | 8 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.19/qiskit.circuit.library.XGate.md | 8 +- .../qiskit/0.19/qiskit.circuit.library.XOR.md | 2 +- .../0.19/qiskit.circuit.library.YGate.md | 8 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.19/qiskit.circuit.library.ZGate.md | 8 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../0.19/qiskit.circuit.library.iSwapGate.md | 4 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.19/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.19/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.19/qiskit.compiler.transpile.md | 2 +- .../0.19/qiskit.converters.ast_to_dag.md | 2 +- .../0.19/qiskit.converters.circuit_to_dag.md | 2 +- .../0.19/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.19/qiskit.converters.dag_to_circuit.md | 2 +- .../0.19/qiskit.dagcircuit.DAGCircuit.md | 106 +++++------ .../0.19/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../qiskit/0.19/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.19/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.19/qiskit.extensions.Initialize.md | 6 +- .../qiskit/0.19/qiskit.extensions.Snapshot.md | 8 +- .../0.19/qiskit.extensions.UnitaryGate.md | 16 +- .../0.19/qiskit.finance.QiskitFinanceError.md | 2 +- ...it.finance.applications.ising.portfolio.md | 10 +- ...cations.ising.portfolio_diversification.md | 6 +- ....uncertainty_problems.EuropeanCallDelta.md | 8 +- ...inty_problems.EuropeanCallExpectedValue.md | 8 +- ...ainty_problems.FixedIncomeExpectedValue.md | 10 +- ...finance.data_providers.BaseDataProvider.md | 16 +- ...nce.data_providers.DataOnDemandProvider.md | 4 +- .../qiskit.finance.data_providers.DataType.md | 2 +- ...nce.data_providers.ExchangeDataProvider.md | 4 +- ...nance.data_providers.RandomDataProvider.md | 4 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 4 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.19/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.19/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 4 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 6 +- .../qiskit.ignis.verification.BasicUtils.md | 22 +-- .../qiskit.ignis.verification.CNOTDihedral.md | 10 +- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- .../qiskit.ignis.verification.Clifford.md | 40 ++--- ...qiskit.ignis.verification.CliffordUtils.md | 44 ++--- ...qiskit.ignis.verification.DihedralUtils.md | 32 ++-- .../qiskit.ignis.verification.GraphDecoder.md | 10 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.19/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 16 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- .../0.19/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.19/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.19/qiskit.ml.datasets.digits.md | 2 +- .../0.19/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.19/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.19/qiskit.ml.datasets.wine.md | 2 +- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 56 +++--- ...t.optimization.algorithms.ADMMOptimizer.md | 6 +- ...optimization.algorithms.CobylaOptimizer.md | 6 +- ....optimization.algorithms.CplexOptimizer.md | 8 +- ...optimization.algorithms.GroverOptimizer.md | 6 +- ...zation.algorithms.MinimumEigenOptimizer.md | 6 +- ...zation.algorithms.OptimizationAlgorithm.md | 8 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 6 +- ....optimization.applications.ising.clique.md | 6 +- ...optimization.applications.ising.docplex.md | 2 +- ...mization.applications.ising.exact_cover.md | 6 +- ...tion.applications.ising.graph_partition.md | 6 +- ...ptimization.applications.ising.knapsack.md | 6 +- ...optimization.applications.ising.max_cut.md | 6 +- ...timization.applications.ising.partition.md | 4 +- ...mization.applications.ising.set_packing.md | 6 +- ...imization.applications.ising.stable_set.md | 6 +- ...kit.optimization.applications.ising.tsp.md | 14 +- ...tion.applications.ising.vehicle_routing.md | 8 +- ...ization.applications.ising.vertex_cover.md | 6 +- ...ization.converters.InequalityToEquality.md | 6 +- ...optimization.converters.IntegerToBinary.md | 6 +- ...tion.converters.IsingToQuadraticProgram.md | 4 +- ...tion.converters.LinearEqualityToPenalty.md | 4 +- ...tion.converters.QuadraticProgramToIsing.md | 4 +- ...s.QuadraticProgramToNegativeValueOracle.md | 4 +- ...ation.converters.QuadraticProgramToQubo.md | 10 +- ...qiskit.optimization.problems.Constraint.md | 4 +- ....optimization.problems.LinearConstraint.md | 4 +- ....optimization.problems.LinearExpression.md | 10 +- ...timization.problems.QuadraticConstraint.md | 4 +- ...timization.problems.QuadraticExpression.md | 10 +- ...ptimization.problems.QuadraticObjective.md | 4 +- ....optimization.problems.QuadraticProgram.md | 56 +++--- .../qiskit.optimization.problems.Variable.md | 4 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../0.19/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.19/qiskit.providers.BaseJob.md | 24 +-- .../0.19/qiskit.providers.BaseProvider.md | 6 +- .../qiskit/0.19/qiskit.providers.JobError.md | 2 +- .../qiskit/0.19/qiskit.providers.JobStatus.md | 2 +- .../0.19/qiskit.providers.JobTimeoutError.md | 2 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.19/qiskit.providers.aer.AerError.md | 2 +- .../0.19/qiskit.providers.aer.AerJob.md | 14 +- .../0.19/qiskit.providers.aer.AerProvider.md | 6 +- .../qiskit.providers.aer.PulseSimulator.md | 6 +- .../qiskit.providers.aer.QasmSimulator.md | 2 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +-- ...qiskit.providers.aer.noise.QuantumError.md | 30 ++-- ...qiskit.providers.aer.noise.ReadoutError.md | 26 +-- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 8 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 ++-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 14 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 4 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 4 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.19/qiskit.providers.ibmq.IBMQBackend.md | 20 +-- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 8 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.19/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.19/qiskit.providers.ibmq.IBMQFactory.md | 22 +-- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- .../0.19/qiskit.providers.ibmq.job.IBMQJob.md | 44 ++--- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.19/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 ++-- ...t.providers.ibmq.managed.ManagedResults.md | 12 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 22 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.19/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.19/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +-- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- docs/api/qiskit/0.19/qiskit.pulse.Acquire.md | 4 +- .../0.19/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.19/qiskit.pulse.Constant.md | 6 +- .../0.19/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.19/qiskit.pulse.Delay.md | 4 +- docs/api/qiskit/0.19/qiskit.pulse.Drag.md | 6 +- .../qiskit/0.19/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md | 6 +- .../0.19/qiskit.pulse.GaussianSquare.md | 6 +- .../qiskit/0.19/qiskit.pulse.Instruction.md | 20 +-- .../qiskit.pulse.InstructionScheduleMap.md | 20 +-- .../0.19/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.19/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.19/qiskit.pulse.Play.md | 2 +- .../qiskit/0.19/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.19/qiskit.pulse.RegisterSlot.md | 2 +- .../qiskit/0.19/qiskit.pulse.SamplePulse.md | 6 +- docs/api/qiskit/0.19/qiskit.pulse.Schedule.md | 24 +-- .../qiskit/0.19/qiskit.pulse.SetFrequency.md | 2 +- .../qiskit/0.19/qiskit.pulse.ShiftPhase.md | 4 +- docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md | 4 +- docs/api/qiskit/0.19/qiskit.pulse.channels.md | 18 +- .../0.19/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.19/qiskit.pulse.instructions.Delay.md | 4 +- .../qiskit.pulse.instructions.Instruction.md | 20 +-- .../0.19/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.19/qiskit.pulse.pulse_lib.Constant.md | 6 +- .../0.19/qiskit.pulse.pulse_lib.Drag.md | 6 +- .../0.19/qiskit.pulse.pulse_lib.Gaussian.md | 6 +- .../qiskit.pulse.pulse_lib.GaussianSquare.md | 6 +- .../qiskit.pulse.pulse_lib.SamplePulse.md | 6 +- .../0.19/qiskit.pulse.pulse_lib.discrete.md | 26 +-- ....pulse.reschedule.add_implicit_acquires.md | 2 +- .../qiskit.pulse.reschedule.align_measures.md | 2 +- .../0.19/qiskit.pulse.reschedule.pad.md | 2 +- .../qiskit/0.19/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.19/qiskit.qasm.Qasm.md | 10 +- docs/api/qiskit/0.19/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.19/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.19/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.19/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.md | 6 +- .../0.19/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.19/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.19/qiskit.qobj.PulseQobjInstruction.md | 6 +- docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.19/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.19/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.19/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.19/qiskit.qobj.Qobj.md | 2 +- .../0.19/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.19/qiskit.qobj.QobjHeader.md | 2 +- .../0.19/qiskit.qobj.QobjMeasurementOption.md | 6 +- ...iskit.qobj.validate_qobj_against_schema.md | 2 +- .../qiskit/0.19/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.19/qiskit.quantum_info.Choi.md | 14 +- .../0.19/qiskit.quantum_info.Clifford.md | 36 ++-- .../0.19/qiskit.quantum_info.DensityMatrix.md | 32 ++-- .../qiskit/0.19/qiskit.quantum_info.Kraus.md | 18 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 8 +- .../0.19/qiskit.quantum_info.Operator.md | 26 +-- .../qiskit/0.19/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.19/qiskit.quantum_info.Pauli.md | 36 ++-- .../0.19/qiskit.quantum_info.PauliTable.md | 44 ++--- .../0.19/qiskit.quantum_info.Quaternion.md | 18 +- .../0.19/qiskit.quantum_info.ScalarOp.md | 20 +-- .../0.19/qiskit.quantum_info.SparsePauliOp.md | 38 ++-- .../qiskit.quantum_info.StabilizerTable.md | 34 ++-- .../0.19/qiskit.quantum_info.Statevector.md | 34 ++-- .../0.19/qiskit.quantum_info.Stinespring.md | 18 +- .../0.19/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 16 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.19/qiskit.quantum_info.concurrence.md | 2 +- .../0.19/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.19/qiskit.quantum_info.entropy.md | 2 +- .../qiskit.quantum_info.euler_angles_1q.md | 2 +- .../0.19/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.19/qiskit.quantum_info.partial_trace.md | 2 +- .../0.19/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.19/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.19/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../0.19/qiskit.quantum_info.random_state.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.19/qiskit.result.Result.md | 12 +- .../qiskit/0.19/qiskit.result.ResultError.md | 2 +- .../0.19/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.19/qiskit.scheduler.methods.basic.md | 6 +- .../0.19/qiskit.scheduler.schedule_circuit.md | 2 +- .../api/qiskit/0.19/qiskit.scheduler.utils.md | 6 +- .../0.19/qiskit.tools.backend_monitor.md | 2 +- .../0.19/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.19/qiskit.tools.choi_to_pauli.md | 2 +- docs/api/qiskit/0.19/qiskit.tools.chop.md | 2 +- .../qiskit/0.19/qiskit.tools.concurrence.md | 2 +- .../qiskit/0.19/qiskit.tools.devectorize.md | 2 +- .../qiskit.tools.entanglement_of_formation.md | 2 +- docs/api/qiskit/0.19/qiskit.tools.entropy.md | 2 +- .../qiskit/0.19/qiskit.tools.is_pos_def.md | 2 +- .../qiskit/0.19/qiskit.tools.job_monitor.md | 2 +- .../0.19/qiskit.tools.mutual_information.md | 2 +- docs/api/qiskit/0.19/qiskit.tools.outer.md | 2 +- .../qiskit/0.19/qiskit.tools.parallel_map.md | 2 +- .../qiskit/0.19/qiskit.tools.partial_trace.md | 2 +- docs/api/qiskit/0.19/qiskit.tools.qft.md | 2 +- .../0.19/qiskit.tools.shannon_entropy.md | 2 +- .../api/qiskit/0.19/qiskit.tools.vectorize.md | 2 +- .../0.19/qiskit.transpiler.CouplingMap.md | 30 ++-- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.19/qiskit.transpiler.FlowController.md | 10 +- .../qiskit/0.19/qiskit.transpiler.Layout.md | 34 ++-- .../0.19/qiskit.transpiler.PassManager.md | 16 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.19/qiskit.transpiler.PropertySet.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.19/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 4 +- ...skit.transpiler.passes.CheckCXDirection.md | 4 +- .../0.19/qiskit.transpiler.passes.CheckMap.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- .../0.19/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 +++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.19/qiskit.transpiler.passes.Depth.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.19/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- .../0.19/qiskit.transpiler.passes.Unroller.md | 4 +- .../0.19/qiskit.transpiler.passes.Width.md | 4 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.19/qiskit.validation.BaseModel.md | 6 +- .../0.19/qiskit.validation.BaseSchema.md | 6 +- .../qiskit.validation.ModelTypeValidator.md | 6 +- .../qiskit.validation.ModelValidationError.md | 2 +- .../0.19/qiskit.validation.bind_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.19/qiskit.visualization.dag_drawer.md | 2 +- ...t.visualization.iplot_bloch_multivector.md | 2 +- .../qiskit.visualization.iplot_histogram.md | 2 +- .../qiskit.visualization.iplot_state_city.md | 2 +- ...qiskit.visualization.iplot_state_hinton.md | 2 +- ...skit.visualization.iplot_state_paulivec.md | 2 +- ...iskit.visualization.iplot_state_qsphere.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...iskit.visualization.pulse.interpolation.md | 4 +- .../qiskit.visualization.pulse.qcstyle.md | 4 +- .../0.19/qiskit.visualization.pulse_drawer.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 754 files changed, 2591 insertions(+), 2591 deletions(-) diff --git a/docs/api/qiskit/0.19/execute.md b/docs/api/qiskit/0.19/execute.md index 8638c29251f..bd5e5aa44f6 100644 --- a/docs/api/qiskit/0.19/execute.md +++ b/docs/api/qiskit/0.19/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=1024, memory=False, max_credits=10, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, memory_slots=None, memory_slot_size=100, rep_time=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/execute.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=1024, memory=False, max_credits=10, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, memory_slots=None, memory_slot_size=100, rep_time=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/execute.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.19/logging.md b/docs/api/qiskit/0.19/logging.md index 39a4ce895dd..b49f2489468 100644 --- a/docs/api/qiskit/0.19/logging.md +++ b/docs/api/qiskit/0.19/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")() | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.19/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.19/qiskit.aqua.AquaError.md index 28e4b9c972c..f8cc279652e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md index addc4257edd..fbc08d387e4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") Quantum Backend including execution setting. @@ -122,7 +122,7 @@ checks if skip qobj validation -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") assemble circuits @@ -130,7 +130,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -154,7 +154,7 @@ tuple(np.ndarray, int) -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -179,7 +179,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -195,7 +195,7 @@ bool -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -203,7 +203,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :param circuits: circuits to transpile :type circuits: QuantumCircuit or list\[QuantumCircuit] diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.md index e5dddc47321..b34ed8e706a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, a_factory=None, q_factory=None, i_objective=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, a_factory=None, q_factory=None, i_objective=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. @@ -117,7 +117,7 @@ Return a numpy random. -`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -143,7 +143,7 @@ The (1 - alpha) confidence interval of the specified kind. -`AmplitudeEstimation.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.md index b4f9bd4c96e..5e097c20f78 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") The Bernstein-Vazirani algorithm. @@ -57,7 +57,7 @@ Return a numpy random. -`BernsteinVazirani.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 6dd29ee5f0e..f4600e6328f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Base class for Classical Algorithms. @@ -26,7 +26,7 @@ Return a numpy random. -`ClassicalAlgorithm.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Execute the classical algorithm. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.md index 11a69917e77..cd151c8311b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.md index c2879b47801..7d1158f1efc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") The Deutsch-Jozsa algorithm. @@ -59,7 +59,7 @@ Return a numpy random. -`DeutschJozsa.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.md index 0bc0950b2d9..b1e34ebc6f2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/eoh.py "view source code") The Quantum EOH (Evolution of Hamiltonian) algorithm. @@ -63,7 +63,7 @@ Return a numpy random. -`EOH.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/eoh.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.md index 139220b1aa4..79200fc5d01 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, init_state=None, incremental=False, num_iterations=1, mct_mode='basic', quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, init_state=None, incremental=False, num_iterations=1, mct_mode='basic', quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") The Grover’s Search algorithm. @@ -79,7 +79,7 @@ Return a numpy random. -`Grover.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.md index a3eb644138b..de7e57e06ab 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") The HHL algorithm. @@ -89,7 +89,7 @@ Return a numpy random. -`HHL.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -109,7 +109,7 @@ the QuantumCircuit object for the constructed circuit -`static HHL.expand_to_hermitian(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_hermitian(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. @@ -130,7 +130,7 @@ tuple(np.array, np.array) -`static HHL.expand_to_powerdim(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_powerdim(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. @@ -151,7 +151,7 @@ tuple(np.array, np.array) -`static HHL.matrix_resize(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.matrix_resize(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Resizes matrix if necessary diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.md index b934511ca3a..75f54132472 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") The Iterative Quantum Phase Estimation algorithm. @@ -93,7 +93,7 @@ Return a numpy random. -`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -114,7 +114,7 @@ MinimumEigensolverResult -`IQPE.construct_circuit(k=None, omega=0, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.construct_circuit(k=None, omega=0, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index bef5d3245e5..e811602311b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, a_factory=None, q_factory=None, i_objective=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, a_factory=None, q_factory=None, i_objective=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") The Iterative Amplitude Estimation algorithm. @@ -139,7 +139,7 @@ Return a numpy random. -`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Construct the circuit Q^k A |0>. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index a8a7f4b5106..c1c84d90267 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. @@ -113,7 +113,7 @@ Return a numpy random. -`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -141,7 +141,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.md index 0384ccdab5a..f63d7329bc3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. @@ -48,7 +48,7 @@ Return the operator. -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -69,7 +69,7 @@ MinimumEigensolverResult -`MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.md index 03dbeb3fb3b..732a6bba69d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. @@ -58,7 +58,7 @@ returns eigen value -`MinimumEigensolverResult.__getitem__(key)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult.__getitem__(key)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") **Return type** @@ -106,7 +106,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MinimumEigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`static MinimumEigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.md index 3085b5651e3..426028a124b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. @@ -90,7 +90,7 @@ dict -`NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") If will process auxiliary operators or not diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.md index 4286022ab8e..9e43ebd84da 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index fe4ea9aff25..7ce45095286 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. @@ -55,7 +55,7 @@ Return a numpy random. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -92,7 +92,7 @@ dict -`NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.md index 173b8a89c76..15488b08baf 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.md index 16a2fc77736..0870bf9b368 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") The Quantum Generative Adversarial Network algorithm. @@ -108,7 +108,7 @@ Returns tolerance for relative entropy -`QGAN.get_rel_entr()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.get_rel_entr()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Get relative entropy between target and trained distribution @@ -153,7 +153,7 @@ Sets backend with configuration. -`QGAN.set_discriminator(discriminator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_discriminator(discriminator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize discriminator. @@ -165,7 +165,7 @@ Initialize discriminator. -`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize generator. @@ -179,7 +179,7 @@ Initialize generator. -`QGAN.train()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.train()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Train the qGAN diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.md index 7aa6ee79bb2..513cf65e69e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") The Quantum Phase Estimation algorithm. @@ -88,7 +88,7 @@ Return a numpy random. -`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -109,7 +109,7 @@ MinimumEigensolverResult -`QPE.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.md index 6ed46951e2b..7e2e99e4161 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Quantum SVM algorithm. @@ -81,7 +81,7 @@ returns result -`QSVM.construct_circuit(x1, x2, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_circuit(x1, x2, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Generate inner product of x1 and x2 with the given feature map. @@ -105,7 +105,7 @@ constructed circuit -`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -135,7 +135,7 @@ numpy.ndarray -`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -162,7 +162,7 @@ numpy.ndarray -`QSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Load a model from a file path. @@ -174,7 +174,7 @@ Load a model from a file path. -`QSVM.predict(data, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.predict(data, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Predict using the svm. @@ -224,7 +224,7 @@ dict -`QSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Save the model to a file path. @@ -248,7 +248,7 @@ Sets backend with configuration. -`QSVM.setup_datapoint(datapoints)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_datapoint(datapoints)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup data points, if the data were there, they would be overwritten. @@ -260,7 +260,7 @@ Setup data points, if the data were there, they would be overwritten. -`QSVM.setup_test_data(test_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_test_data(test_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup test data, if the data were there, they would be overwritten. @@ -272,7 +272,7 @@ Setup test data, if the data were there, they would be overwritten. -`QSVM.setup_training_data(training_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_training_data(training_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup training data, if the data were there, they would be overwritten. @@ -284,7 +284,7 @@ Setup training data, if the data were there, they would be overwritten. -`QSVM.test(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.test(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Test the svm. @@ -310,7 +310,7 @@ float -`QSVM.train(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.train(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Train the svm. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.md index 65cc68b272d..8c0b14d87aa 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Base class for Quantum Algorithms. @@ -52,7 +52,7 @@ Return a numpy random. -`QuantumAlgorithm.run(quantum_instance=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.run(quantum_instance=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Execute the algorithm with selected backend. @@ -77,7 +77,7 @@ dict -`QuantumAlgorithm.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.md index 3c854f7b8b1..46092164573 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. @@ -72,7 +72,7 @@ Return a numpy random. -`Shor.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.md index 8afcebdebbf..050b9b31486 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/simon.py "view source code") The Simon algorithm. @@ -59,7 +59,7 @@ Return a numpy random. -`Simon.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/education/simon.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.md index 07933474736..e40eaff61e3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") The Sklearn SVM algorithm (classical). @@ -54,7 +54,7 @@ returns result -`SklearnSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Load a model from a file path. @@ -66,7 +66,7 @@ Load a model from a file path. -`SklearnSVM.predict(data)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.predict(data)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Predict using the SVM @@ -102,7 +102,7 @@ dict -`SklearnSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Save the model to a file path. @@ -114,7 +114,7 @@ Save the model to a file path. -`SklearnSVM.test(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.test(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Test the SVM @@ -135,7 +135,7 @@ float -`SklearnSVM.train(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.train(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Train the SVM diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.md index 4b91b2f4249..80ae33abfa2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") The Variational Quantum Classifier algorithm. @@ -153,7 +153,7 @@ Returns variational form -`VQC.batch_data(data, labels=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.batch_data(data, labels=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") batch data @@ -169,7 +169,7 @@ set parameterized circuits to None -`VQC.construct_circuit(x, theta, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.construct_circuit(x, theta, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Construct circuit based on data and parameters in variational form. @@ -223,7 +223,7 @@ dict -`VQC.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal circuit @@ -231,7 +231,7 @@ get optimal circuit -`VQC.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal cost @@ -239,7 +239,7 @@ get optimal cost -`VQC.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal vector @@ -263,7 +263,7 @@ get probabilities for counts -`VQC.is_gradient_really_supported()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.is_gradient_really_supported()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") returns is gradient really supported @@ -271,7 +271,7 @@ returns is gradient really supported -`VQC.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") load model @@ -279,7 +279,7 @@ load model -`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data. @@ -327,7 +327,7 @@ dict -`VQC.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") save model @@ -347,7 +347,7 @@ Sets backend with configuration. -`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data, and test against with ground truth labels. @@ -371,7 +371,7 @@ float -`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Train the models, and save results. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.md index 1162e70fbad..f264b23a0d2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. @@ -171,7 +171,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -192,7 +192,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -244,7 +244,7 @@ dict -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -256,7 +256,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -268,7 +268,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -296,7 +296,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -349,7 +349,7 @@ Sets backend with configuration. -`VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.md index b416512ae5d..d6fa4527cb1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Conjunctive Normal Forms @@ -57,7 +57,7 @@ returns variable register -`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.md index 5e4593679e6..24575b1f74e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Disjunctive Normal Forms @@ -57,7 +57,7 @@ returns variable register -`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.md index e9054104f02..a67e9771b88 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Exclusive Sum of Products @@ -57,7 +57,7 @@ returns variable register -`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.md index beb42c0d7e8..a386d98802f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FixedValueComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.FixedValueComparator -`FixedValueComparator(num_state_qubits, value, geq=True, i_state=None, i_target=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") +`FixedValueComparator(num_state_qubits, value, geq=True, i_state=None, i_target=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") *DEPRECATED.* Fixed Value Comparator @@ -52,7 +52,7 @@ returns value -`FixedValueComparator.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") +`FixedValueComparator.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") Adds corresponding sub-circuit to given circuit @@ -161,7 +161,7 @@ returns number of qubits controlled -`FixedValueComparator.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") +`FixedValueComparator.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") returns required ancillas @@ -169,7 +169,7 @@ returns required ancillas -`FixedValueComparator.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") +`FixedValueComparator.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fixed_value_comparator.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.md index bdd91568173..35eeb830c48 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.FourierTransformCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.FourierTransformCircuits -`FourierTransformCircuits`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fourier_transform_circuits.py "view source code") +`FourierTransformCircuits` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fourier_transform_circuits.py "view source code") DEPRECATED. Quantum Fourier Transform Circuit. @@ -20,7 +20,7 @@ DEPRECATED. Quantum Fourier Transform Circuit. -`static FourierTransformCircuits.construct_circuit(circuit=None, qubits=None, inverse=False, approximation_degree=0, do_swaps=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fourier_transform_circuits.py "view source code") +`static FourierTransformCircuits.construct_circuit(circuit=None, qubits=None, inverse=False, approximation_degree=0, do_swaps=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/fourier_transform_circuits.py "view source code") Construct the circuit representing the desired state vector. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.md index 8dba1086a14..3251f1153fb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.LinearRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.LinearRotation -`LinearRotation(slope, offset, num_state_qubits, basis='Y', i_state=None, i_target=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/linear_rotation.py "view source code") +`LinearRotation(slope, offset, num_state_qubits, basis='Y', i_state=None, i_target=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/linear_rotation.py "view source code") *DEPRECATED.* Linearly-controlled X, Y or Z rotation. @@ -47,7 +47,7 @@ Returns the number of target qubits -`LinearRotation.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/linear_rotation.py "view source code") +`LinearRotation.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/linear_rotation.py "view source code") Adds corresponding sub-circuit to given circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.md index d2b9f73aa1d..be4b15e6ef1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Quantum Phase Estimation Circuit. @@ -57,7 +57,7 @@ returns state register -`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Construct the Phase Estimation circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.md index 1944dec4b30..fd287e27905 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PiecewiseLinearRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PiecewiseLinearRotation -`PiecewiseLinearRotation(breakpoints, slopes, offsets, num_state_qubits, basis='Y', i_state=None, i_target=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") +`PiecewiseLinearRotation(breakpoints, slopes, offsets, num_state_qubits, basis='Y', i_state=None, i_target=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") *DEPRECATED.* Piecewise-linearly-controlled rotation. @@ -46,7 +46,7 @@ Returns the number of target qubits -`PiecewiseLinearRotation.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") +`PiecewiseLinearRotation.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") Build the circuit. @@ -132,7 +132,7 @@ Adds power of corresponding circuit. May be overridden if a more efficient imple -`PiecewiseLinearRotation.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") +`PiecewiseLinearRotation.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") Classically evaluate the piecewise linear rotation @@ -168,7 +168,7 @@ returns number of qubits controlled -`PiecewiseLinearRotation.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") +`PiecewiseLinearRotation.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/piecewise_linear_rotation.py "view source code") Return the number of required ancillas. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.md index d6ce1ab26e9..ede668beffb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.PolynomialRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PolynomialRotation -`PolynomialRotation(px, num_state_qubits, basis='Y')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") +`PolynomialRotation(px, num_state_qubits, basis='Y')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") *DEPRECATED.* Polynomial rotation. @@ -58,7 +58,7 @@ Returns the number of target qubits -`PolynomialRotation.build(qc, q, q_target, q_ancillas=None, reverse=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") +`PolynomialRotation.build(qc, q, q_target, q_ancillas=None, reverse=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") Build the circuit. @@ -168,7 +168,7 @@ returns number of qubits controlled -`PolynomialRotation.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") +`PolynomialRotation.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") returns required ancillas @@ -176,7 +176,7 @@ returns required ancillas -`PolynomialRotation.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") +`PolynomialRotation.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/polynomial_rotation.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.md index 2457c08d09e..3b1f8298892 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/statevector_circuit.py "view source code") Arbitrary State-Vector Circuit. @@ -30,7 +30,7 @@ Constructor. -`StateVectorCircuit.construct_circuit(circuit=None, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit.construct_circuit(circuit=None, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/statevector_circuit.py "view source code") Construct the circuit representing the desired state vector. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.md index d85b29bd1cf..fe2156033bc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds q^T \* w to separate register for non-negative integer weights w. @@ -55,7 +55,7 @@ returns weights -`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds corresponding sub-circuit to given circuit @@ -164,7 +164,7 @@ returns number of qubits controlled -`static WeightedSumOperator.get_required_sum_qubits(weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`static WeightedSumOperator.get_required_sum_qubits(weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") get required sum qubits @@ -172,7 +172,7 @@ get required sum qubits -`WeightedSumOperator.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") required ancillas @@ -180,7 +180,7 @@ required ancillas -`WeightedSumOperator.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.md index bbf5206d5ba..6bd3c9831b6 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") Base class for eigenvalue estimation. @@ -22,7 +22,7 @@ This method should initialize the module and use an exception if a component of -`abstract Eigenvalues.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the eigenvalue estimation quantum circuit. @@ -47,7 +47,7 @@ object for the eigenvalue estimation circuit. -`Eigenvalues.construct_inverse(mode, circuit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues.construct_inverse(mode, circuit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the inverse eigenvalue estimation quantum circuit. @@ -75,7 +75,7 @@ circuit. -`abstract Eigenvalues.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") get register sizes @@ -83,7 +83,7 @@ get register sizes -`abstract Eigenvalues.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs.py "view source code") get scaling diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.md index cd22ffa90aa..5a7ca0e1720 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Eigenvalues using Quantum Phase Estimation. @@ -34,7 +34,7 @@ Specifically, this class is based on PhaseEstimationCircuit with no measurements -`EigsQPE.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Construct the eigenvalues estimation using the PhaseEstimationCircuit @@ -87,7 +87,7 @@ circuit. -`EigsQPE.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get register sizes @@ -95,7 +95,7 @@ get register sizes -`EigsQPE.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get scaling diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.md index 4287ff17667..210ea00fddd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Base class for FeatureMap. @@ -36,7 +36,7 @@ returns whether or not the sub-class support parameterized circuit -`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Construct the variational form, given its parameters. @@ -58,7 +58,7 @@ a quantum circuit. -`static FeatureMap.get_entangler_map(map_type, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.get_entangler_map(map_type, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") get entangle map @@ -66,7 +66,7 @@ get entangle map -`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/feature_map.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.md index 0c970092ceb..43ba87712ec 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.FirstOrderExpansion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FirstOrderExpansion -`FirstOrderExpansion(feature_dimension, depth=2, data_map_func=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/first_order_expansion.py "view source code") +`FirstOrderExpansion(feature_dimension, depth=2, data_map_func=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/first_order_expansion.py "view source code") DEPRECATED. First Order Expansion feature map. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.md index a3e0ef1a7e7..95032a35e85 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliExpansion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.PauliExpansion -`PauliExpansion(feature_dimension, depth=2, entangler_map=None, entanglement='full', paulis=None, data_map_func=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/pauli_expansion.py "view source code") +`PauliExpansion(feature_dimension, depth=2, entangler_map=None, entanglement='full', paulis=None, data_map_func=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/pauli_expansion.py "view source code") DEPRECATED. The Pauli Expansion feature map. @@ -53,7 +53,7 @@ returns whether or not the sub-class support parameterized circuit -`PauliExpansion.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/pauli_expansion.py "view source code") +`PauliExpansion.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/pauli_expansion.py "view source code") Construct the second order expansion based on given data. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.md index 0465ff9107b..2dacf4e29a2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.PauliZExpansion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.PauliZExpansion -`PauliZExpansion(feature_dimension, depth=2, entangler_map=None, entanglement='full', z_order=2, data_map_func=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/pauli_z_expansion.py "view source code") +`PauliZExpansion(feature_dimension, depth=2, entangler_map=None, entanglement='full', z_order=2, data_map_func=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/pauli_z_expansion.py "view source code") DEPRECATED. The Pauli Z Expansion feature map. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 233b7d9f982..795bb8e328a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Raw Feature Vector feature map. @@ -40,7 +40,7 @@ returns whether or not the sub-class support parameterized circuit -`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Construct the second order expansion based on given data. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.md index c58545078d3..d2fa87426e4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.SecondOrderExpansion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.SecondOrderExpansion -`SecondOrderExpansion(feature_dimension, depth=2, entangler_map=None, entanglement='full', data_map_func=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/second_order_expansion.py "view source code") +`SecondOrderExpansion(feature_dimension, depth=2, entangler_map=None, entanglement='full', data_map_func=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/second_order_expansion.py "view source code") DEPRECATED. Second Order Expansion feature map. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.self_product.md b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.self_product.md index 5f25f2d082f..f9b53511224 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.self_product.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.feature_maps.self_product.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.self_product -`self_product(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/data_mapping.py "view source code") +`self_product(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/feature_maps/data_mapping.py "view source code") Define a function map from R^n to R. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.md index 37b966648c4..34ac1074db3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/custom.py "view source code") The custom initial state. @@ -45,7 +45,7 @@ The custom initial state will be set from the *circuit*, the *state\_vector*, or -`Custom.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/custom.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.md index cfa2e937b96..87e297ee83c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/initial_state.py "view source code") Base class for InitialState. @@ -26,7 +26,7 @@ This method should initialize the module and use an exception if a component of -`abstract InitialState.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`abstract InitialState.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/initial_state.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.md index b0c1bb95d14..b5d123a75ef 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/var_form_based.py "view source code") The variational form based initial state. @@ -33,7 +33,7 @@ As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutoria -`VarFormBased.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.md index 2eef3276b76..e87ae2d205d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/zero.py "view source code") The zero (null/vacuum) state. @@ -30,7 +30,7 @@ This is suitable for those situations in which the all-zeros state is the desire -`Zero.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/initial_states/zero.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.md b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.md index bb7481df8a0..e76732317ad 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Approximate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.iqfts.Approximate -`Approximate(num_qubits, degree=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/approximate.py "view source code") +`Approximate(num_qubits, degree=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/approximate.py "view source code") The Approximate IQFT. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.md b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.md index 5104574cf3c..b18d1b7c1e3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.IQFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.iqfts.IQFT -`IQFT`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/iqft.py "view source code") +`IQFT` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/iqft.py "view source code") DEPRECATED. Base class for IQFT. @@ -20,7 +20,7 @@ DEPRECATED. Base class for IQFT. -`IQFT.construct_circuit(mode='circuit', qubits=None, circuit=None, do_swaps=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/iqft.py "view source code") +`IQFT.construct_circuit(mode='circuit', qubits=None, circuit=None, do_swaps=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/iqft.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.md b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.md index a9aefbf6295..afeb885934f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.iqfts.Standard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.iqfts.Standard -`Standard(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/standard.py "view source code") +`Standard(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/iqfts/standard.py "view source code") The Standard IQFT. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.md index 2cc8f6d786d..2f1c71d7141 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") The All-Pairs multiclass extension. @@ -22,7 +22,7 @@ In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a -`AllPairs.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Applying multiple estimators for prediction. @@ -54,7 +54,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`AllPairs.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -75,7 +75,7 @@ float -`AllPairs.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 7b67f6e6372..c169d0965e7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") The Error Correcting Code multiclass extension. @@ -36,7 +36,7 @@ The table above shows a 6-bit ECC for a 3-class problem. Each class is assigned -`ErrorCorrectingCode.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Applying multiple estimators for prediction. @@ -68,7 +68,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`ErrorCorrectingCode.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -89,7 +89,7 @@ float -`ErrorCorrectingCode.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 9bb1df3e03e..614c1b2c0b2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Base class for multiclass extension. @@ -22,7 +22,7 @@ This method should initialize the module and use an exception if a component of -`abstract MulticlassExtension.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Applying multiple estimators for prediction. @@ -34,7 +34,7 @@ Applying multiple estimators for prediction. -`MulticlassExtension.set_estimator(estimator_cls, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension.set_estimator(estimator_cls, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Called internally to set `Estimator` and parameters :type estimator\_cls: `Callable`\[\[`List`], `Estimator`] :param estimator\_cls: An `Estimator` class :type params: `Optional`\[`List`] :param params: Parameters for the estimator @@ -46,7 +46,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`abstract MulticlassExtension.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -59,7 +59,7 @@ Testing multiple estimators each for distinguishing a pair of classes. -`abstract MulticlassExtension.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 9ff5fb1fed5..990f088e23c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") The One Against Rest multiclass extension. @@ -22,7 +22,7 @@ For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM cla -`OneAgainstRest.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Applying multiple estimators for prediction. @@ -54,7 +54,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`OneAgainstRest.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -75,7 +75,7 @@ float -`OneAgainstRest.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index f46f3458ef5..02e32e8b6e9 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Base class for discriminative Quantum or Classical Neural Networks. @@ -22,7 +22,7 @@ This method should initialize the module but raise an exception if a required co -`abstract DiscriminativeNetwork.get_label(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.get_label(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Apply quantum/classical neural network to the given input sample and compute the respective data label @@ -38,7 +38,7 @@ Apply quantum/classical neural network to the given input sample and compute the -`abstract DiscriminativeNetwork.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Loss function used for optimization @@ -60,7 +60,7 @@ Loss w\.r.t to the generated data points. -`abstract DiscriminativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Set seed. @@ -76,7 +76,7 @@ Set seed. -`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 52c84832068..c2a72cdd134 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Base class for generative Quantum and Classical Neural Networks. @@ -22,7 +22,7 @@ This method should initialize the module, but raise an exception if a required c -`abstract GenerativeNetwork.get_output(quantum_instance, qc_state_in, params, shots)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.get_output(quantum_instance, qc_state_in, params, shots)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Apply quantum/classical neural network to given input and get the respective output @@ -45,7 +45,7 @@ Neural network output -`abstract GenerativeNetwork.loss()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.loss()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Loss function used for optimization @@ -53,7 +53,7 @@ Loss function used for optimization -`abstract GenerativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set seed. @@ -69,7 +69,7 @@ Set seed. -`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index cc649b3fbfa..ed93bc905eb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Discriminator based on NumPy @@ -39,7 +39,7 @@ DiscriminatorNet -`NumPyDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -60,7 +60,7 @@ numpy.ndarray -`NumPyDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Load discriminator model @@ -72,7 +72,7 @@ Load discriminator model -`NumPyDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Loss function :param x: sample label (equivalent to discriminator output) :type x: numpy.ndarray :param y: target label :type y: numpy.ndarray :param weights: customized scaling for each sample (optional) :type weights: numpy.ndarray @@ -88,7 +88,7 @@ float -`NumPyDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Save discriminator model @@ -100,7 +100,7 @@ Save discriminator model -`NumPyDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Set seed. :param seed: seed :type seed: int @@ -108,7 +108,7 @@ Set seed. :param seed: seed :type seed: int -`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index 66f22e81559..9a528ff66c7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Discriminator based on PyTorch @@ -43,7 +43,7 @@ object -`PyTorchDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -64,7 +64,7 @@ torch.Tensor -`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Compute gradient penalty for discriminator optimization @@ -87,7 +87,7 @@ torch.Tensor -`PyTorchDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Load discriminator model @@ -99,7 +99,7 @@ Load discriminator model -`PyTorchDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Loss function @@ -121,7 +121,7 @@ torch.Tensor -`PyTorchDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Save discriminator model @@ -133,7 +133,7 @@ Save discriminator model -`PyTorchDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Set seed. @@ -145,7 +145,7 @@ Set seed. -`PyTorchDiscriminator.train(data, weights, penalty=True, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.train(data, weights, penalty=True, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Perform one training step w\.r.t. to the discriminator’s parameters diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 3f3acea76c8..395e6e6ea8c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Quantum Generator. @@ -34,7 +34,7 @@ The quantum generator is a parametrized quantum circuit which can be trained wit -`QuantumGenerator.construct_circuit(params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.construct_circuit(params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Construct generator circuit. @@ -54,7 +54,7 @@ construct the quantum circuit and return as gate -`QuantumGenerator.get_output(quantum_instance, qc_state_in=None, params=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.get_output(quantum_instance, qc_state_in=None, params=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Get classical data samples from the generator. Running the quantum generator circuit results in a quantum state. To train this generator with a classical discriminator, we need to sample classical outputs by measuring the quantum state and mapping them to feature space defined by the training data. @@ -77,7 +77,7 @@ list -`QuantumGenerator.loss(x, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.loss(x, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Loss function for training the generator’s parameters. @@ -98,7 +98,7 @@ float -`QuantumGenerator.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set discriminator network. @@ -110,7 +110,7 @@ Set discriminator network. -`QuantumGenerator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set seed. @@ -122,7 +122,7 @@ Set seed. -`QuantumGenerator.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.md index dd454c1d8c9..8c06e8277b7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizer. @@ -102,7 +102,7 @@ Return setting -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -133,7 +133,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") load params @@ -141,13 +141,13 @@ load params -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") ### optimize -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -185,7 +185,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") save params diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.md index 08dc15699bd..ddd5f309823 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=3.0, tol=1e-06, disp=False, momentum=0.25)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=3.0, tol=1e-06, disp=False, momentum=0.25)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) optimizer. @@ -91,7 +91,7 @@ Return setting -`AQGD.converged(objval, n=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.converged(objval, n=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") Determines if the objective function has converged by finding the difference between the current value and the previous n values. @@ -112,7 +112,7 @@ bool -`AQGD.deriv(j, params, obj)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.deriv(j, params, obj)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") Obtains the analytical quantum derivative of the objective function with respect to the jth parameter. @@ -134,7 +134,7 @@ float -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") Return support level dictionary @@ -165,7 +165,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") Perform optimization. @@ -221,7 +221,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`AQGD.update(j, params, deriv, mprev)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.update(j, params, deriv, mprev)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/aqgd.py "view source code") Updates the jth parameter based on the derivative and previous momentum diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.md index 51e09d018a9..9a442ccd47f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cg.py "view source code") Conjugate Gradient optimizer. @@ -86,7 +86,7 @@ Return setting -`CG.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cg.py "view source code") Return support level dictionary @@ -117,7 +117,7 @@ grad -`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cg.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.md index a9827c9fcd5..b5aab214c3c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. @@ -85,7 +85,7 @@ Return setting -`COBYLA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cobyla.py "view source code") Return support level dictionary @@ -116,7 +116,7 @@ grad -`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/cobyla.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.md index 04b7f1c3c29..990bf30b89b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. @@ -86,7 +86,7 @@ Return setting -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.md index 5add3aaede6..edbc3858168 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. @@ -86,7 +86,7 @@ Return setting -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index 8a6d13911bc..b1a14b91bf1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. @@ -86,7 +86,7 @@ Return setting -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.md index d64a12bed41..8da01d83af2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. @@ -88,7 +88,7 @@ Return setting -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.md index 970af6aa4ca..d5a121d4e40 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(max_iter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(max_iter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. @@ -90,7 +90,7 @@ Return setting -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Return support level dictionary. @@ -106,7 +106,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -154,7 +154,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Run the line search optimization. @@ -182,7 +182,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Perform optimization. @@ -220,7 +220,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -244,7 +244,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.md index bbeece4e3f6..3c8d6469e2a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. @@ -86,7 +86,7 @@ Return setting -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.md index 01ff6ff75cb..dd9cb41636e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. @@ -90,7 +90,7 @@ Return setting -`L_BFGS_B.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Return support level dictionary @@ -121,7 +121,7 @@ grad -`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.md index e0ee64350b6..d82dbdeaf90 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. @@ -89,7 +89,7 @@ Return setting -`NELDER_MEAD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Return support level dictionary @@ -120,7 +120,7 @@ grad -`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.md index 14394cd989a..a2f90ce02fd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. @@ -95,7 +95,7 @@ Return setting -`NFT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nft.py "view source code") return support level dictionary @@ -126,7 +126,7 @@ grad -`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/nft.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.md index bf90b3361b7..79fb98bdc54 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Base class for optimization algorithm. @@ -76,7 +76,7 @@ Return setting -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Return support level dictionary @@ -84,7 +84,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -107,7 +107,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Perform optimization. @@ -133,7 +133,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -141,7 +141,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Set max evals grouped @@ -149,7 +149,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -163,7 +163,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.md index 9c030ab621b..ce2caf0f3eb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/powell.py "view source code") Powell optimizer. @@ -86,7 +86,7 @@ Return setting -`POWELL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/powell.py "view source code") Return support level dictionary @@ -117,7 +117,7 @@ grad -`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/powell.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.md index 18d58d27e99..24df8d9493f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. @@ -85,7 +85,7 @@ Return setting -`P_BFGS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") return support level dictionary @@ -116,7 +116,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.md index 38ad8b679cd..87d3fb45fb3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. @@ -88,7 +88,7 @@ Return setting -`SLSQP.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/slsqp.py "view source code") Return support level dictionary @@ -119,7 +119,7 @@ grad -`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/slsqp.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.md index 1e894d53e84..0030f8be003 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(max_trials=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(max_trials=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. @@ -102,7 +102,7 @@ Return setting -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/spsa.py "view source code") return support level dictionary @@ -133,7 +133,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.md index 44d615af2c8..0ef8c74405c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. @@ -89,7 +89,7 @@ Return setting -`TNC.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/tnc.py "view source code") return support level dictionary @@ -120,7 +120,7 @@ grad -`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/optimizers/tnc.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.md index c9723971861..6fc5a14e85b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register=None, output_register=None, ancillary_register=None, circuit=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register=None, output_register=None, ancillary_register=None, circuit=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") The Custom Circuit-based Quantum Oracle. @@ -52,7 +52,7 @@ returns variable register -`CustomCircuitOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index c0594a212b5..550ad29200f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") The Logical Expression Quantum Oracle. @@ -72,7 +72,7 @@ returns variable register -`LogicalExpressionOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") construct circuit @@ -80,7 +80,7 @@ construct circuit -`LogicalExpressionOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") evaluate classically diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.md index 9ec6b13cc63..8bec7068f49 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/oracle.py "view source code") Base class for oracles. @@ -55,7 +55,7 @@ returns variable register -`abstract Oracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/oracle.py "view source code") +`abstract Oracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.md index a38eba0c3c3..cd49c67421b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") The Truth Table-based Quantum Oracle. @@ -60,7 +60,7 @@ returns variable register -`TruthTableOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") construct circuit @@ -68,7 +68,7 @@ construct circuit -`TruthTableOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") evaluate classical diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.md b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.md index 497d6f51c31..319ff4135c1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Approximate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.qfts.Approximate -`Approximate(num_qubits, degree=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/approximate.py "view source code") +`Approximate(num_qubits, degree=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/approximate.py "view source code") The Approximate QFT. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.md b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.md index 86e95cceda8..087a08c9314 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.qfts.QFT -`QFT`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/qft.py "view source code") +`QFT` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/qft.py "view source code") DEPRECATED. Base class for QFT. @@ -20,7 +20,7 @@ DEPRECATED. Base class for QFT. -`QFT.construct_circuit(mode='circuit', qubits=None, circuit=None, do_swaps=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/qft.py "view source code") +`QFT.construct_circuit(mode='circuit', qubits=None, circuit=None, do_swaps=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/qft.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.md b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.md index 810c2975085..1c368303774 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.qfts.Standard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.qfts.Standard -`Standard(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/standard.py "view source code") +`Standard(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/qfts/standard.py "view source code") The Standard QFT. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.md index 5a308cc62cc..5145eebfb8f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/long_division.py "view source code") The Long Division Rotation for Reciprocals. @@ -34,7 +34,7 @@ It finds the reciprocal with long division method and rotates the ancillary qubi -`LongDivision.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/long_division.py "view source code") Construct the Long Division Rotation circuit. @@ -60,7 +60,7 @@ containing the Long Division Rotation circuit. -`LongDivision.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/long_division.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.md index 015af1f96da..6c08f0c9d3a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") The Lookup Rotation for Reciprocals. @@ -33,7 +33,7 @@ A calculation of reciprocals of eigenvalues is performed and controlled rotation -`LookupRotation.construct_circuit(mode, inreg)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.construct_circuit(mode, inreg)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Construct the Lookup Rotation circuit. @@ -58,7 +58,7 @@ NotImplementedError: mode not supported -`LookupRotation.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.md index 80812950aab..172f20e2a99 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Base class for reciprocal calculation. @@ -22,7 +22,7 @@ This method should initialize the module and use an exception if a component of -`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Construct the initial state circuit. @@ -40,7 +40,7 @@ The reciprocal circuit. -`abstract Reciprocal.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index e033ff76595..665a9a3969f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") The Univariate Bernoulli Distribution. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index e1c2873a197..8200ec9dc84 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") The Gaussian Conditional Independence Model for Credit Risk. @@ -71,7 +71,7 @@ returns values -`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index 45259cd3c00..52b09806ff0 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") The Univariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 1e1b82c6c5e..274a8d0d306 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -65,7 +65,7 @@ returns values -`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") ### build\_controlled @@ -165,7 +165,7 @@ returns number of qubits controlled -`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") pdf to probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index 57233eab6f6..e479d9a5af1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") The Multivariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index c292eaa1f61..81117cd1704 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") The Multivariate Normal Distribution. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index fc0180d11dd..c0a63af0643 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") The Multivariate Uniform Distribution. @@ -66,7 +66,7 @@ returns values -`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index 00c79093e42..be2019b2417 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") The Multivariate Variational Distribution. @@ -66,7 +66,7 @@ returns values -`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") ### build\_controlled @@ -190,7 +190,7 @@ returns required ancillas controlled -`MultivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index b5e95a50b53..1648ff97425 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") The Univariate Normal Distribution. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index b7d9a5da496..b3ff697fb9e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") The abstract Uncertainty Model @@ -26,7 +26,7 @@ Returns the number of target qubits -`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Adds corresponding sub-circuit to given circuit diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 622e65344d5..357d3bc4477 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") The Univariate Uniform Distribution. @@ -54,7 +54,7 @@ returns values -`UniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") ### build\_controlled @@ -177,7 +177,7 @@ list -`UniformDistribution.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas @@ -185,7 +185,7 @@ returns required ancillas -`UniformDistribution.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index 32d02dabf25..43e9c3ddee3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) @@ -57,7 +57,7 @@ returns values -`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") ### build\_controlled @@ -157,7 +157,7 @@ returns number of qubits controlled -`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index a2bfdd2d058..d6848e8c595 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") The Univariate Variational Distribution. @@ -54,7 +54,7 @@ returns values -`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") ### build\_controlled @@ -193,7 +193,7 @@ returns required ancillas controlled -`UnivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index a478ef4eec2..c9f6e403446 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Multivariate Uncertainty Problem. @@ -35,7 +35,7 @@ Returns the number of target qubits -`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`MultivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") returns required ancillas @@ -160,7 +160,7 @@ returns required ancillas controlled -`MultivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 832718401e3..f3cfc36ae82 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") The abstract Uncertainty Problem component. @@ -151,7 +151,7 @@ returns required ancillas controlled -`UncertaintyProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 51392ac3964..4a600cd35a4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Univariate Piecewise Linear Objective Function. @@ -46,7 +46,7 @@ Returns the number of target qubits -`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") ### build\_controlled @@ -146,7 +146,7 @@ returns number of qubits controlled -`UnivariatePiecewiseLinearObjective.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") requires ancillas @@ -162,7 +162,7 @@ returns required ancillas controlled -`UnivariatePiecewiseLinearObjective.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") value to estimation diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index 7029a2cb8cd..134c51091a1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Univariate uncertainty problem. @@ -35,7 +35,7 @@ Returns the number of target qubits -`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`UnivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") returns required ancillas @@ -160,7 +160,7 @@ returns required ancillas controlled -`UnivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.md b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.md index 8838d0ff975..9f30c8f7e26 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.RY -`RY(num_qubits, depth=3, entangler_map=None, entanglement='full', initial_state=None, entanglement_gate='cz', skip_unentangled_qubits=False, skip_final_ry=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ry.py "view source code") +`RY(num_qubits, depth=3, entangler_map=None, entanglement='full', initial_state=None, entanglement_gate='cz', skip_unentangled_qubits=False, skip_final_ry=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ry.py "view source code") DEPRECATED. The RY Variational Form. @@ -103,7 +103,7 @@ boolean -`RY.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ry.py "view source code") +`RY.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ry.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.md b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.md index 799dae17998..474f1138573 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.RYRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.RYRZ -`RYRZ(num_qubits, depth=3, entangler_map=None, entanglement='full', initial_state=None, entanglement_gate='cz', skip_unentangled_qubits=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ryrz.py "view source code") +`RYRZ(num_qubits, depth=3, entangler_map=None, entanglement='full', initial_state=None, entanglement_gate='cz', skip_unentangled_qubits=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ryrz.py "view source code") DEPRECATED. The RYRZ Variational Form. @@ -92,7 +92,7 @@ boolean -`RYRZ.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ryrz.py "view source code") +`RYRZ.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/ryrz.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.md b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.md index 09b23af77a5..731e156d7c5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.SwapRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.SwapRZ -`SwapRZ(num_qubits, depth=3, entangler_map=None, entanglement='full', initial_state=None, skip_unentangled_qubits=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/swaprz.py "view source code") +`SwapRZ(num_qubits, depth=3, entangler_map=None, entanglement='full', initial_state=None, skip_unentangled_qubits=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/swaprz.py "view source code") DEPRECATED. The SwapRZ Variational Form. @@ -97,7 +97,7 @@ boolean -`SwapRZ.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/swaprz.py "view source code") +`SwapRZ.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/swaprz.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.md index 4116a3c0454..27139dfd110 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Base class for VariationalForms. @@ -80,7 +80,7 @@ boolean -`abstract VariationalForm.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`abstract VariationalForm.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Construct the variational form, given its parameters. @@ -101,7 +101,7 @@ A quantum circuit. -`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") returns entangler map @@ -109,7 +109,7 @@ returns entangler map -`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/components/variational_forms/variational_form.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.md index 19a368465da..b9035e24e9c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. @@ -40,7 +40,7 @@ The number of qubits accepted by the Operator’s underlying function. -`OperatorBase.__mul__(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.__mul__(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Overload `*` for Operator scalar multiplication. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -80,7 +80,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -116,7 +116,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -128,7 +128,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -154,7 +154,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -174,7 +174,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -194,7 +194,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -250,7 +250,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -266,7 +266,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -278,7 +278,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -302,7 +302,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -322,7 +322,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -344,7 +344,7 @@ The `LegacyBaseOperator` representing this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.md index a4a90739f56..23f1fcf0ef5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together. @@ -24,7 +24,7 @@ The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it wi -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -44,7 +44,7 @@ The converted Operator. -`AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.md index cda0ae96800..852aa270505 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend=None, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend=None, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. @@ -67,7 +67,7 @@ The QuantumInstance used by the CircuitSampler -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -88,7 +88,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. @@ -109,7 +109,7 @@ The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. -`CircuitSampler.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.md index 49c61e9f36e..e8c2c5916dd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -20,7 +20,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.md index 61197b645a5..2cf283d703a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. @@ -26,7 +26,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.md index 7c768096633..63ebff0e1d8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. @@ -51,7 +51,7 @@ The destination `PauliOp`, or `None` if using the default destination, the diago -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -72,7 +72,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -92,7 +92,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -124,7 +124,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -144,7 +144,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -166,7 +166,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TBP stands for Tensor Product Basis. @@ -186,7 +186,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -207,7 +207,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -228,7 +228,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -249,7 +249,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.md index ad055057ee4..e79fce55f63 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -20,7 +20,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.md index 58f12ee01d6..00d8e9d4fe7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. @@ -20,7 +20,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.md index 9a54abd4041..42ef3d82022 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -115,7 +115,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -131,7 +131,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -163,7 +163,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`EvolvedOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -189,7 +189,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -209,7 +209,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -241,7 +241,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -309,7 +309,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -325,7 +325,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -341,7 +341,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -409,7 +409,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -443,7 +443,7 @@ The `LegacyBaseOperator` representing this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -459,7 +459,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.md index b59e55a0af6..072d886f4a6 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. @@ -20,7 +20,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index 97b169de9a4..f3a67a5d842 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. @@ -46,7 +46,7 @@ TrotterizationBase used to evolve SummedOps. -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing trotterized evolutions equalling the exponentiation of -i \* operator. @@ -66,7 +66,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -78,7 +78,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.md index ea96445e793..6273c2b96cb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). @@ -38,7 +38,7 @@ The number of repetitions to use in the Trotterization, improving the approximat -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.md index f4e06ce8e2f..07f064cb6fb 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. @@ -53,7 +53,7 @@ The number of repetitions to use in the Trotterization, improving the approximat -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.md index 5f53e22ef88..5d4c719d3c8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.md index 8d2cdb7e4df..c67966386c6 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. @@ -34,7 +34,7 @@ The number of repetitions to use in the Trotterization, improving the approximat -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index 956082a8b5f..59645f02600 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. @@ -20,7 +20,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.md index 69cae723060..e0908085ada 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. @@ -20,7 +20,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -40,7 +40,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.md index 4ae47d79906..563bff5eabe 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -20,7 +20,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -40,7 +40,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.md index be3becc5cdc..5a0d31fdba1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. @@ -20,7 +20,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.md index a3aec20e503..88179dcfcee 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. @@ -20,7 +20,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -40,7 +40,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.md index 7f7fa62f107..af9b8a2e242 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. @@ -24,7 +24,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -44,7 +44,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 6c978f0c8b5..7890eccf0bf 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Operators relevant for quantum applications. @@ -44,7 +44,7 @@ returns z2 symmetries -`abstract LegacyBaseOperator.__mul__(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.__mul__(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Overload \* @@ -52,13 +52,13 @@ Overload \* -`abstract LegacyBaseOperator.chop(threshold, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.chop(threshold, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") ### construct\_evaluation\_circuit -`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Build circuits to compute the expectation w\.r.t the wavefunction. @@ -66,7 +66,7 @@ Build circuits to compute the expectation w\.r.t the wavefunction. -`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. @@ -74,7 +74,7 @@ Consume the result from the quantum computer to build the expectation, will be o -`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Time evolution, exp^(-jt H). @@ -82,7 +82,7 @@ Time evolution, exp^(-jt H). -`abstract LegacyBaseOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Check Operator is empty or not @@ -90,7 +90,7 @@ Check Operator is empty or not -`abstract LegacyBaseOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") print details @@ -98,7 +98,7 @@ print details -`abstract LegacyBaseOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/base_operator.py "view source code") Convert to new Operator format. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.md index 7cbdcff291e..d2fc6949acf 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Operators relevant for quantum applications @@ -74,7 +74,7 @@ returns z2 symmetries -`MatrixOperator.__mul__(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.__mul__(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Overload \* operation. Only support two Operators have the same representation mode. @@ -94,13 +94,13 @@ the multiplied Operator. -`MatrixOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### chop -`MatrixOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Eliminate the real and imagine part of coeff in each pauli by threshold. If pauli’s coeff is less then threshold in both real and imagine parts, the pauli is removed. To align the internal representations, all available representations are chopped. The chopped result is stored back to original property. Note: if coeff is real-only, the imag part is skipped. @@ -121,7 +121,7 @@ self or copy -`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Construct the circuits for evaluation. @@ -146,7 +146,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`MatrixOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Get a copy of self. @@ -154,7 +154,7 @@ Get a copy of self. -`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Use the executed result with operator to get the evaluated value. @@ -181,7 +181,7 @@ float -`MatrixOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Parameters** @@ -203,7 +203,7 @@ float -`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -232,7 +232,7 @@ numpy.array -`MatrixOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Check Operator is empty or not. @@ -248,7 +248,7 @@ bool -`MatrixOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Returns** @@ -262,13 +262,13 @@ str -`MatrixOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### to\_opflow -`MatrixOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.md index 59348220694..fcfee6d56ac 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Pauli Graph. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index e8a8a2dc3c7..6200abcc57e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") TPB Grouped Weighted Pauli Operator @@ -424,7 +424,7 @@ bool -`TPBGroupedWeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Perform self \* other. @@ -446,7 +446,7 @@ the multiplied operator -`TPBGroupedWeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -523,7 +523,7 @@ the simplified operator -`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Largest-Degree First Coloring for grouping paulis. @@ -601,7 +601,7 @@ to op flow -`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Greedy and unsorted grouping paulis. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 3e1f5c63ff5..2372b5a0809 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Weighted Pauli Operator @@ -62,7 +62,7 @@ returns z2 symmetries -`WeightedPauliOperator.__mul__(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.__mul__(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Overload self \* other @@ -70,7 +70,7 @@ Overload self \* other -`WeightedPauliOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self + other. @@ -91,7 +91,7 @@ operator -`WeightedPauliOperator.anticommute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.anticommute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Anti commutes with @@ -99,7 +99,7 @@ Anti commutes with -`WeightedPauliOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminate the real and imagine part of weight in each pauli by threshold. If pauli’s weight is less then threshold in both real and imaginary parts, the pauli is removed. @@ -126,7 +126,7 @@ the operator is mutated. -`WeightedPauliOperator.commute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.commute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Commutes with @@ -134,7 +134,7 @@ Commutes with -`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Construct the circuits for evaluation, which calculating the expectation \. @@ -169,7 +169,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`WeightedPauliOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self @@ -177,7 +177,7 @@ Get a copy of self -`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.WeightedPauliOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. @@ -206,7 +206,7 @@ float -`WeightedPauliOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -228,7 +228,7 @@ float -`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -251,7 +251,7 @@ dict -`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -281,7 +281,7 @@ The constructed circuit. -`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -310,7 +310,7 @@ The constructed QuantumCircuit. -`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: @@ -347,7 +347,7 @@ the operator created from the input dictionary. -`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis in a file to construct an Operator. @@ -368,7 +368,7 @@ the loaded operator. -`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Create a WeightedPauliOperator via a pair of list. @@ -394,7 +394,7 @@ operator -`WeightedPauliOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check Operator is empty or not. @@ -410,7 +410,7 @@ bool -`WeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self \* other, and the phases are tracked. @@ -430,7 +430,7 @@ the multiplied operator -`WeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -446,7 +446,7 @@ str -`WeightedPauliOperator.reorder_paulis()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.reorder_paulis()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Reorder the paulis based on the basis and return the reordered paulis. @@ -462,7 +462,7 @@ list\[list\[complex, paulis]] -`WeightedPauliOperator.rounding(decimals, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.rounding(decimals, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Rounding the weight. @@ -483,7 +483,7 @@ operator -`WeightedPauliOperator.simplify(copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.simplify(copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. @@ -507,7 +507,7 @@ the simplified operator -`WeightedPauliOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self - other. @@ -528,7 +528,7 @@ operator -`WeightedPauliOperator.to_dict()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_dict()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a dict in pauli representation. @@ -544,7 +544,7 @@ dict -`WeightedPauliOperator.to_file(file_name)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_file(file_name)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a file in pauli representation. @@ -556,7 +556,7 @@ Save operator to a file in pauli representation. -`WeightedPauliOperator.to_opflow(reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_opflow(reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.md index e6d6e22f5d0..d87e2c8e529 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Z2 Symmetries @@ -61,7 +61,7 @@ returns tapering values -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -85,7 +85,7 @@ TaperedWeightedPauliOperator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self. @@ -101,7 +101,7 @@ copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -119,7 +119,7 @@ single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check the z2\_symmetries is empty or not. @@ -135,7 +135,7 @@ bool -`Z2Symmetries.taper(operator, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.taper(operator, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -162,7 +162,7 @@ list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`static Z2Symmetries.two_qubit_reduction(operator, num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`static Z2Symmetries.two_qubit_reduction(operator, num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.check_commutativity.md index 69c121b9e0d..dcf58b19dec 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.commutator.md index 40969bc7929..2bc00a41920 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.covariance.md index 7fba016012b..b09d53e0dcd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.evolution_instruction.md index 2e39fbc2238..a43a8405a4b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.kernel_F2.md index 05f31346f68..fa5f30929a1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.measure_pauli_z.md index 142db44769d..c5091167a33 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.pauli_measurement.md index 8ded188542b..5a8b281b108 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.row_echelon_F2.md index c6050751223..fa3319daed9 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index c7cf88b0340..9d82f8cb469 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.md index 92b5dba7000..e7076e8c27c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -248,7 +248,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ComposedOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -294,7 +294,7 @@ A bool equal to the equality of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -382,7 +382,7 @@ An `OperatorBase` equivalent to the negation of self. -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -434,7 +434,7 @@ A set of strings describing the primitives contained within the Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.md index b78da937929..1fa2d555861 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. @@ -132,7 +132,7 @@ The Operators defining the ListOp -`ListOp.__getitem__(offset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.__getitem__(offset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Allows array-indexing style access to the Operators in `oplist`. @@ -152,7 +152,7 @@ The `OperatorBase` at index `offset` of `oplist`. -`ListOp.__len__()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.__len__()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Length of `oplist`. @@ -188,7 +188,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -256,7 +256,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ListOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -282,7 +282,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ListOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -302,7 +302,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -330,7 +330,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -342,7 +342,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -354,7 +354,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -390,7 +390,7 @@ An `OperatorBase` equivalent to the negation of self. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -410,7 +410,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -426,7 +426,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -442,7 +442,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -466,7 +466,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -486,7 +486,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -498,7 +498,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -520,7 +520,7 @@ The `LegacyBaseOperator` representing this Operator. -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -536,7 +536,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -548,7 +548,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -560,7 +560,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -576,7 +576,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.md index 6dc8271fb53..c4bd5e7111e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. @@ -180,7 +180,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`SummedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -418,7 +418,7 @@ A set of strings describing the primitives contained within the Operator. -`SummedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -490,7 +490,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`SummedOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.md index 6c6b6c0e432..161bf5e5e69 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. @@ -294,7 +294,7 @@ A bool equal to the equality of self and other. -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -418,7 +418,7 @@ A set of strings describing the primitives contained within the Operator. -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -434,7 +434,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.md index e5a55971323..1c4e1c4fde9 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. @@ -100,7 +100,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -136,7 +136,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -168,7 +168,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -194,7 +194,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -214,7 +214,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -294,7 +294,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -334,7 +334,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -350,7 +350,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -366,7 +366,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -410,7 +410,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -422,7 +422,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -434,7 +434,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -468,7 +468,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.md index 44c6d4c9cba..538263d7ade 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. @@ -100,7 +100,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -168,7 +168,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`MatrixOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -194,7 +194,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -214,7 +214,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -234,7 +234,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -314,7 +314,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -346,7 +346,7 @@ The reduced `OperatorBase`. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -414,7 +414,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -426,7 +426,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -448,7 +448,7 @@ The `LegacyBaseOperator` representing this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -464,7 +464,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.md index 325b8592ec9..395e5f501dc 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. @@ -99,7 +99,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -119,7 +119,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -167,7 +167,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PauliOp.commutes(other_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.commutes(other_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns whether self commutes with other\_op. @@ -187,7 +187,7 @@ A bool equaling whether self commutes with other\_op -`PauliOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -233,7 +233,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -253,7 +253,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -333,7 +333,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -365,7 +365,7 @@ The reduced `OperatorBase`. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -409,7 +409,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -433,7 +433,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -445,7 +445,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -467,7 +467,7 @@ The `LegacyBaseOperator` representing this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -495,7 +495,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -507,7 +507,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 16b93e6aa12..8de9424152f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. @@ -104,7 +104,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -124,7 +124,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -140,7 +140,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -172,7 +172,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PrimitiveOp.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -198,7 +198,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -218,7 +218,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -238,7 +238,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -250,7 +250,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -262,7 +262,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -298,7 +298,7 @@ An `OperatorBase` equivalent to the negation of self. -`PrimitiveOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -318,7 +318,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -334,7 +334,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -350,7 +350,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -374,7 +374,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -394,7 +394,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -406,7 +406,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -418,7 +418,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -430,7 +430,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -452,7 +452,7 @@ The `LegacyBaseOperator` representing this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -468,7 +468,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -480,7 +480,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.md index d6caaa9738d..d23faac26d2 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -132,7 +132,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -164,7 +164,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitStateFn.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -208,7 +208,7 @@ A bool equal to the equality of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -228,7 +228,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -248,7 +248,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -309,7 +309,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -349,7 +349,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -365,7 +365,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -381,7 +381,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -393,7 +393,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -437,7 +437,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -449,7 +449,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -461,7 +461,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -473,7 +473,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -503,7 +503,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.md index 6661422adbd..5ca7540bfa7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -208,7 +208,7 @@ A bool equal to the equality of self and other. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -284,7 +284,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -316,7 +316,7 @@ The reduced `OperatorBase`. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -338,7 +338,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -382,7 +382,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -394,7 +394,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -440,7 +440,7 @@ The `LegacyBaseOperator` representing this Operator. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -476,7 +476,7 @@ A VectorStateFn equivalent to self. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.md index 5f90a0c807b..86951dadc7e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. @@ -92,7 +92,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -112,7 +112,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -204,7 +204,7 @@ A bool equal to the equality of self and other. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -280,7 +280,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -312,7 +312,7 @@ The reduced `OperatorBase`. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -334,7 +334,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -378,7 +378,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -390,7 +390,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -424,7 +424,7 @@ The `LegacyBaseOperator` representing this Operator. -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -450,7 +450,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.md index f68e9c29675..3dd98f4416d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. @@ -98,7 +98,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -118,7 +118,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -134,7 +134,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -166,7 +166,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`StateFn.compose(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.compose(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -190,7 +190,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -210,7 +210,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -230,7 +230,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -266,7 +266,7 @@ An `OperatorBase` equivalent to the negation of self. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -286,7 +286,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -302,7 +302,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -318,7 +318,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -340,7 +340,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -364,7 +364,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -384,7 +384,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -408,7 +408,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -430,7 +430,7 @@ The `LegacyBaseOperator` representing this Operator. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -446,7 +446,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -466,7 +466,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.md index ed8261d1e7d..5723a4398b8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. @@ -92,7 +92,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -112,7 +112,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -204,7 +204,7 @@ A bool equal to the equality of self and other. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -280,7 +280,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -312,7 +312,7 @@ The reduced `OperatorBase`. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -334,7 +334,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -378,7 +378,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -390,7 +390,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -436,7 +436,7 @@ The `LegacyBaseOperator` representing this Operator. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -452,7 +452,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.md index 65acc69b659..9cf5b2c7917 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Base class for CircuitFactories @@ -26,7 +26,7 @@ Returns the number of target qubits -`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding sub-circuit to given circuit @@ -41,7 +41,7 @@ Adds corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding controlled sub-circuit to given circuit @@ -57,7 +57,7 @@ Adds corresponding controlled sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled inverse of corresponding sub-circuit to given circuit @@ -73,7 +73,7 @@ Adds controlled inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -81,7 +81,7 @@ Adds controlled, inverse, power of corresponding circuit. May be overridden if a -`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -89,7 +89,7 @@ Adds controlled power of corresponding circuit. May be overridden if a more effi -`CircuitFactory.build_inverse(qc, q, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse(qc, q, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse of corresponding sub-circuit to given circuit @@ -103,7 +103,7 @@ Adds inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -111,7 +111,7 @@ Adds inverse power of corresponding circuit. May be overridden if a more efficie -`CircuitFactory.build_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -119,7 +119,7 @@ Adds power of corresponding circuit. May be overridden if a more efficient imple -`CircuitFactory.get_num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits @@ -127,7 +127,7 @@ returns number of qubits -`CircuitFactory.get_num_qubits_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits controlled @@ -135,7 +135,7 @@ returns number of qubits controlled -`CircuitFactory.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas @@ -143,7 +143,7 @@ returns required ancillas -`CircuitFactory.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.decimal_to_binary.md index 0b9750af8e0..fa7ba07983a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_entangler_map.md index 8ccf7d8c6b2..4c1a1e761dd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_feature_dimension.md index 2cdae92b861..04c2472d88d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_num_classes.md index 48e8f3f102b..49a8f8bf7a4 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystem_density_matrix.md index 50fc15d9854..8bd064cdd8f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystems_counts.md index b3ccd9af735..0119e292c02 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.has_aer.md index 59e671930d7..5e1724e9af3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.has_ibmq.md index ef837a21d5e..8462b3531ec 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.map_label_to_class_name.md index c3100eb3d12..b88c75631d8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.optimize_svm.md index 546b49d3da2..480768e64da 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, max_iters=500, show_progress=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, max_iters=500, show_progress=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h1_body.md index 481957d452f..a189d9b3483 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h2_body.md index b59c99bd8ed..e1b5c79965f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_hermitian.md index 53fa0f5688a..ea24dfe9e9f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_non_hermitian.md index fc8773f84d1..27cbb3351c3 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_unitary.md index 73ad49b68e1..b8e31d6a6da 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 042842c40f8..e60ba7bf729 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8ea3499d409..7f4df59f15f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.summarize_circuits.md index 00e71b0c553..babdc97adf1 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.tensorproduct.md index 0ca4eab32ee..6ba35e96015 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.19/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.19/qiskit.aqua.utils.validate_entangler_map.md index ffc0293ea05..9173cad5f21 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.19/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.md index 160852c0ccf..0ae311dcf90 100644 --- a/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.19/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/run_config.py "view source code") Class for Run Configuration. @@ -81,7 +81,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -101,7 +101,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.19/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.19/qiskit.assembler.assemble_circuits.md index bf538c53a57..ec060a1e2fe 100644 --- a/docs/api/qiskit/0.19/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.19/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.19/qiskit.assembler.assemble_schedules.md index 9c59dda7e6b..acaed1de496 100644 --- a/docs/api/qiskit/0.19/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.19/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.19/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.19/qiskit.assembler.disassemble.md index 2f7c1ca863a..93b6b6a6072 100644 --- a/docs/api/qiskit/0.19/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.19/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits, run\_config, and user header. diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.md index 28732586192..99c802346ee 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. @@ -62,7 +62,7 @@ Getter of modes. -`FermionicOperator.fermion_mode_elimination(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_elimination(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") Eliminate modes. @@ -84,7 +84,7 @@ Fermionic Hamiltonian -`FermionicOperator.fermion_mode_freezing(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_freezing(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") Freezing modes and extracting its energy. @@ -106,7 +106,7 @@ tuple([FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.F -`FermionicOperator.mapping(map_type, threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.mapping(map_type, threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") Map fermionic operator to qubit operator. @@ -133,7 +133,7 @@ create an Operator object in Paulis form. -`FermionicOperator.particle_hole_transformation(num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.particle_hole_transformation(num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") The ‘standard’ second quantized Hamiltonian can be transformed in the particle-hole (p/h) picture, which makes the expansion of the trail wavefunction from the HF reference state more natural. In fact, for both trail wavefunctions implemented in q-lib (‘heuristic’ hardware efficient and UCCSD) the p/h Hamiltonian improves the speed of convergence of the VQE algorithm for the calculation of the electronic ground state properties. For more information on the p/h formalism see: P. Barkoutsos, arXiv:1805.04340([https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340)). @@ -153,7 +153,7 @@ tuple -`FermionicOperator.total_angular_momentum()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_angular_momentum()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") Total angular momentum. @@ -171,7 +171,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_magnetization()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_magnetization()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the magnetization of the given eigenstate. @@ -187,7 +187,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_particle_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_particle_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the number of particle of the given eigenstate. @@ -203,7 +203,7 @@ Fermionic Hamiltonian -`FermionicOperator.transform(unitary_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.transform(unitary_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/fermionic_operator.py "view source code") Transform the one and two body term based on unitary\_matrix. diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.md index 2400db2ab49..04c4967cfc1 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/mp2info.py "view source code") A utility class for Moller-Plesset 2nd order (MP2) information @@ -65,7 +65,7 @@ float -`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/mp2info.py "view source code") With a reduced active space the set of used excitations can be less than allowing all available excitations. Given a (sub)set of excitations in the space this will return a list of correlation coefficients and a list of correlation energies ordered as per the excitation list provided. @@ -91,7 +91,7 @@ Tuple(list, list) -`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/mp2info.py "view source code") Gets the set of MP2 terms for the molecule taking into account index adjustments due to frozen core and/or other orbital reduction diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.md index a561d1d6408..3290baeb5c2 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Molecule data class containing driver result. @@ -88,13 +88,13 @@ returns z\_dipole\_integrals -`QMolecule.Z(natom)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.Z(natom)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") ### has\_dipole\_integrals -`QMolecule.has_dipole_integrals()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.has_dipole_integrals()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Check if dipole integrals are present. @@ -102,7 +102,7 @@ Check if dipole integrals are present. -`QMolecule.load()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.load()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") loads info saved. @@ -110,7 +110,7 @@ loads info saved. -`QMolecule.log()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.log()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") log properties @@ -118,7 +118,7 @@ log properties -`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Convert one-body MO integrals to spin orbital basis @@ -142,7 +142,7 @@ numpy.ndarray -`static QMolecule.oneeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.oneeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Converts one-body integrals from AO to MO basis @@ -165,7 +165,7 @@ numpy.ndarray -`QMolecule.remove_file(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.remove_file(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") remove file @@ -173,7 +173,7 @@ remove file -`QMolecule.save(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.save(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Saves the info from the driver. @@ -181,7 +181,7 @@ Saves the info from the driver. -`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Convert two-body MO integrals to spin orbital basis @@ -206,7 +206,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") Converts two-body integrals from AO to MO basis @@ -229,5 +229,5 @@ numpy.ndarray -`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qmolecule.py "view source code") diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.md index 975ef57a348..f872e1a5aa5 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Base class for errors raised by the QiskitChemistry SDK. diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.md index c1c0b61e04f..f596f3bbeb8 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") QEomEE algorithm (classical) diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.md index 60cc50f4846..6bfa6e5873c 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") QEomVQE algorithm diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.md index 343ba7f329b..1ccdbe1d08d 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") The Adaptive VQE algorithm. @@ -146,7 +146,7 @@ dict -`VQEAdapt.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal circuit @@ -154,7 +154,7 @@ get optimal circuit -`VQEAdapt.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal cost @@ -162,7 +162,7 @@ get optimal cost -`VQEAdapt.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal vector diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.md index f3d070c5841..e6032a20975 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") A Hartree-Fock initial state. @@ -39,7 +39,7 @@ Getter of the bit string represented the statevector. -`HartreeFock.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.md index 0ae6db0ddb0..e2a5481a1e9 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) @@ -132,7 +132,7 @@ boolean -`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Computes single and double excitation lists. @@ -164,7 +164,7 @@ list -`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. @@ -185,7 +185,7 @@ list -`UCCSD.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Construct the variational form, given its parameters. @@ -218,7 +218,7 @@ returns entangler map -`static UCCSD.group_excitations(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. @@ -239,7 +239,7 @@ tuple -`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. @@ -260,7 +260,7 @@ list -`UCCSD.manage_hopping_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.manage_hopping_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Triggers the adaptive behavior of this UCCSD instance. This function is used by the Adaptive VQE algorithm. It stores the full list of available hopping operators in a so called “excitation pool” and clears the previous list to be empty. Furthermore, the depth is asserted to be 1 which is required by the Adaptive VQE algorithm. @@ -268,7 +268,7 @@ Triggers the adaptive behavior of this UCCSD instance. This function is used by -`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. @@ -289,7 +289,7 @@ list -`UCCSD.pop_hopping_operator()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.pop_hopping_operator()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pops the hopping operator that was added last. @@ -297,7 +297,7 @@ Pops the hopping operator that was added last. -`UCCSD.push_hopping_operator(excitation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.push_hopping_operator(excitation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pushes a new hopping operator. @@ -309,7 +309,7 @@ Pushes a new hopping operator. -`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Regroups the excitations that involve same spatial orbitals for example, with labeling. diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.md index af35c4b3602..d8ee3a1d864 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Base class for ChemistryOperator. @@ -50,7 +50,7 @@ returns molecule info -`ChemistryOperator.process_algorithm_result(algo_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator.process_algorithm_result(algo_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Takes the algorithm result and processes it as required, e.g. by combination of any parts that were classically computed, for the final result. @@ -70,7 +70,7 @@ Final chemistry result computed from the algorithm result -`abstract ChemistryOperator.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`abstract ChemistryOperator.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.md index 2b52caf2eac..a8b6350fa24 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=TransformationType.FULL, qubit_mapping=QubitMappingType.PARITY, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=TransformationType.FULL, qubit_mapping=QubitMappingType.PARITY, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. @@ -83,7 +83,7 @@ Final chemistry result computed from the algorithm result -`Hamiltonian.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.md index b78f7a76ac7..6b5256f7a67 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular chemistry Result diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.md index 1e54aca2133..57fb78d27c7 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Excited States Result diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.md index 3da1c0b90ce..ef38feacc67 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Ground State Energy Result. @@ -356,7 +356,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`MolecularGroundStateResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether dipole moment is present in result or not @@ -368,7 +368,7 @@ Returns whether dipole moment is present in result or not -`MolecularGroundStateResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.md index 9ec30659daf..1ee63d3982c 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") QubitMappingType enum diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.md index 1003244f7de..909228362b6 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/chemistry/core/hamiltonian.py "view source code") Transformation Type enum diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.md index 1bbd93588ab..9ff6d9eb692 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/classicalregister.py "view source code") Implement a classical register. @@ -75,7 +75,7 @@ Return register size. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.19/qiskit.circuit.Clbit.md index e5a5fc5043a..c7cacb6e668 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register, index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register, index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/classicalregister.py "view source code") Implement a classical bit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.md index f343fa9160c..159864dfea7 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/controlledgate.py "view source code") Controlled unitary gate. @@ -267,7 +267,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.md index f6a0552a866..e06b934528c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. @@ -26,7 +26,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -41,7 +41,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -67,7 +67,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -89,7 +89,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Gate.md b/docs/api/qiskit/0.19/qiskit.circuit.Gate.md index 82dba9de165..2936dcdddd5 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") Unitary gate. @@ -63,7 +63,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Gate.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") +`Gate.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") Assemble a QasmQobjInstruction @@ -75,7 +75,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -138,7 +138,7 @@ Add classical condition on register classical and value val. -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -236,7 +236,7 @@ a fresh gate with sub-gates reversed -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -294,7 +294,7 @@ Containing the definition. -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.19/qiskit.circuit.Instruction.md index 6cf8bed6e22..00c4922a57c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Generic quantum instruction. @@ -47,7 +47,7 @@ return instruction params. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -55,7 +55,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -63,7 +63,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -84,7 +84,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Add classical condition on register classical and value val. @@ -92,7 +92,7 @@ Add classical condition on register classical and value val. -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -114,7 +114,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -138,7 +138,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -146,7 +146,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-gates. @@ -164,7 +164,7 @@ a fresh gate with sub-gates reversed -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -174,7 +174,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.md index b0411844ba8..301f1ed6dfc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") Instruction collection, and their contexts. @@ -24,7 +24,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.__getitem__(i)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.__getitem__(i)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") Return instruction at index @@ -32,7 +32,7 @@ Return instruction at index -`InstructionSet.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") Return number of instructions in set @@ -40,7 +40,7 @@ Return number of instructions in set -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -48,7 +48,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") Add condition on classical register to all instructions. @@ -56,7 +56,7 @@ Add condition on classical register to all instructions. -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Measure.md b/docs/api/qiskit/0.19/qiskit.circuit.Measure.md index efdb7559e88..b5f01a8065f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. @@ -52,7 +52,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.19/qiskit.circuit.Parameter.md index 4d32c2d618a..74f1c2ba9c6 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(_, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameter.py "view source code") +`Parameter(_, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameter.py "view source code") Parameter Class for variable parameters. @@ -77,7 +77,7 @@ which were not bound by parameter\_values. -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in parameter\_map. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.md index fb85bd5229d..a5398cd111d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") ParameterExpression class to enable creating expressions of Parameters. @@ -35,13 +35,13 @@ Returns a set of the unbound Parameters in the expression. -`ParameterExpression.__mul__(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.__mul__(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") ### bind -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -73,7 +73,7 @@ which were not bound by parameter\_values. -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.md index 92d844e6def..26257afb1aa 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") ParameterVector class to quickly generate lists of parameters. @@ -30,19 +30,19 @@ Returns the list of parameters in the ParameterVector. -`ParameterVector.__getitem__(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.__getitem__(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") ### \_\_len\_\_ -`ParameterVector.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") ### resize -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.md index 0edbeaa9cd9..2f9a9f2c18b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Create a new circuit. @@ -226,7 +226,7 @@ Build a collective disjunction (OR) circuit in place using mct. -`QuantumCircuit.__getitem__(item)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.__getitem__(item)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return indexed operation. @@ -234,7 +234,7 @@ Return indexed operation. -`QuantumCircuit.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return number of operations in circuit. @@ -242,7 +242,7 @@ Return number of operations in circuit. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -250,7 +250,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -272,7 +272,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(param_dict, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(param_dict, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -335,7 +335,7 @@ set() -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is None, applies to all. @@ -343,7 +343,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`QuantumCircuit.bind_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -370,7 +370,7 @@ copy of self with assignment substitution. -`static QuantumCircuit.cast(value, _type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, _type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -378,7 +378,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -398,7 +398,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, *, ctl1=None, ctl2=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, *, ctl1=None, ctl2=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -406,7 +406,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.ch(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -414,7 +414,7 @@ Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -422,7 +422,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -430,7 +430,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -438,7 +438,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Append rhs to self if self contains compatible registers. @@ -466,7 +466,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -520,7 +520,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -540,7 +540,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -556,7 +556,7 @@ OrderedDict -`QuantumCircuit.crx(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -564,7 +564,7 @@ Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate -`QuantumCircuit.cry(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -572,7 +572,7 @@ Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate -`QuantumCircuit.crz(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -580,7 +580,7 @@ Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, *, label=None, ctrl_state=None, ctl=None, tgt1=None, tgt2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, *, label=None, ctrl_state=None, ctl=None, tgt1=None, tgt2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -588,7 +588,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -596,7 +596,7 @@ Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -604,7 +604,7 @@ Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate -`QuantumCircuit.cx(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -612,7 +612,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.cy(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -620,7 +620,7 @@ Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). -`QuantumCircuit.cz(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, *, label=None, ctrl_state=None, ctl=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -628,7 +628,7 @@ Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -636,7 +636,7 @@ Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate -`QuantumCircuit.decompose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -652,7 +652,7 @@ a circuit one level decomposed -`QuantumCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’. @@ -707,7 +707,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=0.7, filename=None, style=None, interactive=False, line_length=None, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=0.7, filename=None, style=None, interactive=False, line_length=None, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. @@ -873,7 +873,7 @@ The style dict kwarg contains numerous options that define the style of the outp -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Append QuantumCircuit to the right hand side if it contains compatible registers. @@ -901,7 +901,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2, *, ctl=None, tgt1=None, tgt2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2, *, ctl=None, tgt1=None, tgt2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -909,7 +909,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -929,7 +929,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -949,7 +949,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.h(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -965,7 +965,7 @@ Apply hamiltonian evolution to to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -985,7 +985,7 @@ bool -`QuantumCircuit.i(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -993,7 +993,7 @@ Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). -`QuantumCircuit.id(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1001,7 +1001,7 @@ Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). -`QuantumCircuit.iden(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iden(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Deprecated identity gate. @@ -1017,7 +1017,7 @@ Apply initialize to circuit. -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Invert this circuit. @@ -1095,7 +1095,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1175,7 +1175,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCXGate`. @@ -1183,7 +1183,7 @@ Apply `MCXGate`. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1191,7 +1191,7 @@ Apply `MCU1Gate`. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCXGate`. @@ -1226,7 +1226,7 @@ qiskit.Instruction -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -1248,7 +1248,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured. @@ -1270,7 +1270,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Mirror the circuit by reversing the instructions. @@ -1288,7 +1288,7 @@ the mirrored circuit -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). @@ -1296,7 +1296,7 @@ Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -1316,7 +1316,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -1326,7 +1326,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1338,7 +1338,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1346,7 +1346,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.qasm(formatted=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -1371,7 +1371,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -1391,7 +1391,7 @@ List(tuple) -`QuantumCircuit.r(theta, phi, qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply `RGate`. @@ -1399,7 +1399,7 @@ Apply `RGate`. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -1407,7 +1407,7 @@ Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XG -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -1415,7 +1415,7 @@ Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXG -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurement on all qubits if they are present. Deletes the ClassicalRegister that was used to store the values from these measurements if it is idle. @@ -1445,7 +1445,7 @@ Reset q. -`QuantumCircuit.rx(theta, qubit, *, label=None, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, *, label=None, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -1453,7 +1453,7 @@ Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -1461,7 +1461,7 @@ Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate -`QuantumCircuit.ry(theta, qubit, *, label=None, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, *, label=None, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -1469,7 +1469,7 @@ Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -1477,7 +1477,7 @@ Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate -`QuantumCircuit.rz(phi, qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -1485,7 +1485,7 @@ Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -1493,7 +1493,7 @@ Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -1501,7 +1501,7 @@ Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate -`QuantumCircuit.s(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -1509,7 +1509,7 @@ Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). -`QuantumCircuit.sdg(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -1517,7 +1517,7 @@ Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate -`QuantumCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of gate operations in circuit. @@ -1718,7 +1718,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -1726,7 +1726,7 @@ Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapG -`QuantumCircuit.t(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -1734,7 +1734,7 @@ Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). -`QuantumCircuit.tdg(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -1742,7 +1742,7 @@ Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate -`QuantumCircuit.to_gate(parameter_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -1762,7 +1762,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -1782,7 +1782,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit, *, ctl1=None, ctl2=None, tgt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit, *, ctl1=None, ctl2=None, tgt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -1790,7 +1790,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.u1(theta, qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -1798,7 +1798,7 @@ Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). -`QuantumCircuit.u2(phi, lam, qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -1806,7 +1806,7 @@ Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). -`QuantumCircuit.u3(theta, phi, lam, qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -1967,7 +1967,7 @@ Apply unitary gate to q. -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -1983,7 +1983,7 @@ int -`QuantumCircuit.x(qubit, *, label=None, ctrl_state=None, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, *, label=None, ctrl_state=None, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -1991,7 +1991,7 @@ Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). -`QuantumCircuit.y(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -1999,7 +1999,7 @@ Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). -`QuantumCircuit.z(qubit, *, q=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit, *, q=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.md index 9668a5e15ba..c83baca2d1e 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumregister.py "view source code") Implement a quantum register. @@ -75,7 +75,7 @@ Return register size. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.19/qiskit.circuit.Qubit.md index 65d16e98c46..41946d6750b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register, index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register, index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/quantumregister.py "view source code") Implement a quantum bit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Reset.md b/docs/api/qiskit/0.19/qiskit.circuit.Reset.md index 9a009b73f97..3eb23150424 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") Qubit reset. @@ -52,7 +52,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.19/qiskit.circuit.library.AND.md index 67385e1cece..6350788fe4a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.md index 6364e63346e..d94c6665c62 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") Barrier instruction. @@ -52,7 +52,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -73,7 +73,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") Add classical condition on register classical and value val. @@ -103,7 +103,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.md index 8517731006a..81861ac0286 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=0.7853981633974483, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=0.7853981633974483, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") The 3-qubit controlled X gate. @@ -163,7 +163,7 @@ Add classical condition on register classical and value val. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -207,7 +207,7 @@ updated if it was provided -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C3X is its own inverse. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.md index ab44076b386..c70aeecad5b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. @@ -157,7 +157,7 @@ Add classical condition on register classical and value val. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -201,7 +201,7 @@ updated if it was provided -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.md index ee3136da153..ebbaf6f8792 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") CCX gate, also known as Toffoli gate. @@ -207,7 +207,7 @@ Add classical condition on register classical and value val. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -251,7 +251,7 @@ updated if it was provided -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). @@ -343,7 +343,7 @@ Containing the definition. -`CCXGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a numpy.array for the CCX gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.md index 7331b7dc444..e2812898375 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Controlled-Hadamard gate. @@ -248,7 +248,7 @@ updated if it was provided -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). @@ -340,7 +340,7 @@ Containing the definition. -`CHGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Return a numpy.array for the CH gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.md index fdf6f2b924d..0d5ff39595a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") Controlled-RX gate. @@ -243,7 +243,7 @@ updated if it was provided -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse RX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.md index 5f5f16bbc5f..70f7e27a3af 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") Controlled-RY gate. @@ -244,7 +244,7 @@ updated if it was provided -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse RY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.md index 1e6fdba80b3..f9aa9c0c4b6 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") Controlled-RZ gate. @@ -249,7 +249,7 @@ updated if it was provided -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse RZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.md index 9a354c138d5..3be35412c64 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") Controlled-X gate. @@ -262,7 +262,7 @@ updated if it was provided -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). @@ -354,7 +354,7 @@ Containing the definition. -`CSwapGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a numpy.array for the Fredkin (CSWAP) gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.md index 2488cbd6269..b8d161d4962 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled-U1 gate. @@ -178,7 +178,7 @@ Add classical condition on register classical and value val. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -222,7 +222,7 @@ updated if it was provided -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.md index 6ab2cbb25a2..03a594f0ff6 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") Controlled-U3 gate (3-parameter two-qubit gate). @@ -247,7 +247,7 @@ updated if it was provided -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.md index 50dea20a63d..5321c3e5781 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(ctrl_state=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(ctrl_state=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled-X gate. @@ -201,7 +201,7 @@ Add classical condition on register classical and value val. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -245,7 +245,7 @@ updated if it was provided -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). @@ -337,7 +337,7 @@ Containing the definition. -`CXGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a numpy.array for the CX gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.md index 168428af649..77c06ecf03b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") Controlled-Y gate. @@ -243,7 +243,7 @@ updated if it was provided -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). @@ -335,7 +335,7 @@ Containing the definition. -`CYGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") Return a numpy.array for the CY gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.md index da199b0a93f..543599c6f68 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") Controlled-Z gate. @@ -224,7 +224,7 @@ updated if it was provided -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.md index 0b5ae5ff8d4..da03f7eeedd 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/dcx.py "view source code") Double-CNOT gate. @@ -309,7 +309,7 @@ Containing the definition. -`DCXGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/dcx.py "view source code") Return a numpy.array for the DCX gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.md index 41cb0cca694..79edfe89d58 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Diagonal circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.md index 727ff004785..c55a4b96aab 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/efficient_su2.py "view source code") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.md index 4a87e26ecb6..653290a4bf9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") The heurisitic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.md index e132d416206..38eeed69e23 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/fourier_checking.py "view source code") Fourier checking circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.md index f21d379d391..9798e1d43a6 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.md index 07debbce2be..00c55166fb5 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/gms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.md index cc6730a6beb..728d2bc6d6c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/graph_state.py "view source code") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.md index fc905134172..9f3bee737be 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Single-qubit Hadamard gate. @@ -151,7 +151,7 @@ Add classical condition on register classical and value val. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -197,7 +197,7 @@ updated if it was provided -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). @@ -289,7 +289,7 @@ Containing the definition. -`HGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/h.py "view source code") Return a Numpy.array for the H gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.md index c83013fb9dc..277f7a47daf 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/hidden_linear_function.py "view source code") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.md index 0171d3680ee..47b7985ae94 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/i.py "view source code") Identity gate. @@ -198,7 +198,7 @@ updated if it was provided -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. @@ -290,7 +290,7 @@ Containing the definition. -`IGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/i.py "view source code") Return a numpy.array for the identity gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.md index 06d2bc90691..0a153a9809d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/iqp.py "view source code") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.md index a3285868b17..8d7e34e2d1c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") An n\_qubit circuit that computes the inner product of two registers. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.md index b6fd19390e8..ad3f4f813e2 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Integer Comparator. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.md index c78c1f7cbf5..d60f5ccd667 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.md index 790d1ce7f21..6c18d5eb845 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. @@ -435,7 +435,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`MCMT.control(num_ctrl_qubits=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -940,7 +940,7 @@ Apply initialize to circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.md index f5ee4d1c521..73534c60883 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The MCMT implementation using the CCX V-chain. @@ -938,7 +938,7 @@ Apply initialize to circuit. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.md index b1358f3dff6..6e2b213aefc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, *, n_qubits=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, *, n_qubits=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.md index eff90c19670..285958dd6a3 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. @@ -52,7 +52,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.md index 0e0074f9ebb..2a55aef2ad9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") The n-local circuit class. @@ -416,7 +416,7 @@ Return number of operations in circuit. -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -472,7 +472,7 @@ a handle to the instruction that was just added -`NLocal.assign_parameters(param_dict, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(param_dict, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -1108,7 +1108,7 @@ The QuantumCircuit object for the input QASM -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -1140,7 +1140,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -1553,7 +1553,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.19/qiskit.circuit.library.OR.md index 4f79327a36c..e02c9b5b491 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.md index 4ab5bcd9eb2..4e8f7169c21 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") The Pauli Expansion circuit. @@ -1596,7 +1596,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -1604,7 +1604,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.md index 61cbf7bd96c..673d1e72e56 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/generalized_gates/permutation.py "view source code") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 3a0474d42a5..bc0008a3e4a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Piecewise-linearly-controlled Pauli rotations. @@ -935,7 +935,7 @@ The style dict kwarg contains numerous options that define the style of the outp -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.md index d4169625f6b..f96b2e3d085 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.md index 064ba40502b..1c09aeeb707 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/basis_change/qft.py "view source code") Quantum Fourier Transform Circuit. @@ -1008,7 +1008,7 @@ Apply initialize to circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -1024,7 +1024,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.md index a99b89e4586..a17bb7ab2a4 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/quantum_volume.py "view source code") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.md index fae0d709acf..0c0f4888b94 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified 3-controlled Toffoli gate. @@ -291,7 +291,7 @@ Containing the definition. -`RC3XGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a numpy.array for the RC3X gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.md index 86d99b5ba1e..28dd20ae05b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified Toffoli gate, also referred to as Margolus gate. @@ -291,7 +291,7 @@ Containing the definition. -`RCCXGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a numpy.array for the simplified CCX gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.md index e828208ad48..344c735f532 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") Single-qubit rotation about the X axis. @@ -149,7 +149,7 @@ Add classical condition on register classical and value val. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (mutli-)controlled-RX gate. @@ -193,7 +193,7 @@ updated if it was provided -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. @@ -287,7 +287,7 @@ Containing the definition. -`RXGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a numpy.array for the RX gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.md index cafcbca1ed8..6b946851dc2 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rxx.py "view source code") A parameteric 2-qubit $X \otimes X$ interaction (rotation about XX). @@ -223,7 +223,7 @@ updated if it was provided -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.md index 7da477f468a..1971b9799d8 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") Single-qubit rotation about the Y axis. @@ -149,7 +149,7 @@ Add classical condition on register classical and value val. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (mutli-)controlled-RY gate. @@ -193,7 +193,7 @@ updated if it was provided -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. @@ -287,7 +287,7 @@ Containing the definition. -`RYGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a numpy.array for the RY gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.md index f3b7368f7dd..7ff62fe0e97 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ryy.py "view source code") A parameteric 2-qubit $Y \otimes Y$ interaction (rotation about YY). @@ -223,7 +223,7 @@ updated if it was provided -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.md index b3525aa33c8..7ab27663d7e 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") Single-qubit rotation about the Z axis. @@ -161,7 +161,7 @@ Add classical condition on register classical and value val. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (mutli-)controlled-RZ gate. @@ -205,7 +205,7 @@ updated if it was provided -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.md index 03f559ecb16..2456fcd4d7c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzx.py "view source code") A parameteric 2-qubit $Z \otimes X$ interaction (rotation about ZX). @@ -261,7 +261,7 @@ updated if it was provided -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.md index 02ca7bd6189..e1c037c0554 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzz.py "view source code") A parameteric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). @@ -235,7 +235,7 @@ updated if it was provided -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.md index d5e29e1b161..08057286c54 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") The RealAmplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.md index 9315a0fab81..4fd1b107da9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") Qubit reset. @@ -52,7 +52,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.md index 758debe5ea4..382583b5821 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S gate (Z\*\*0.5). @@ -202,7 +202,7 @@ updated if it was provided -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). @@ -294,7 +294,7 @@ Containing the definition. -`SGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") Return a numpy.array for the S gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.md index 14243713b29..1f057f4eb41 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S-adjoint gate (\~Z\*\*0.5). @@ -202,7 +202,7 @@ updated if it was provided -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). @@ -294,7 +294,7 @@ Containing the definition. -`SdgGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/s.py "view source code") Return a numpy.array for the Sdg gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.md index 256b91a1464..0a47b6575d9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") The SWAP gate. @@ -159,7 +159,7 @@ Add classical condition on register classical and value val. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -205,7 +205,7 @@ updated if it was provided -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). @@ -297,7 +297,7 @@ Containing the definition. -`SwapGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a numpy.array for the SWAP gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.md index 9fbb7a4c5dc..5c0c7b7e3ad 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T gate (Z\*\*0.25). @@ -202,7 +202,7 @@ updated if it was provided -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). @@ -294,7 +294,7 @@ Containing the definition. -`TGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") Return a numpy.array for the T gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.md index d5a488066ee..f9353b54d1f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T-adjoint gate (\~Z\*\*0.25). @@ -202,7 +202,7 @@ updated if it was provided -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). @@ -294,7 +294,7 @@ Containing the definition. -`TdgGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/t.py "view source code") Return a numpy.array for the inverse T gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.md index 20d3466920f..1ac0fbada48 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/two_local.py "view source code") The two-local circuit. @@ -1166,7 +1166,7 @@ The QuantumCircuit object for the input QASM -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.md index 6c81aa82248..e8d0ff9e489 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Single-qubit rotation about the Z axis. @@ -177,7 +177,7 @@ Add classical condition on register classical and value val. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (mutli-)controlled-U1 gate. @@ -221,7 +221,7 @@ updated if it was provided -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) @@ -313,7 +313,7 @@ Containing the definition. -`U1Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a numpy.array for the U1 gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.md index 43ace9cfc5e..8b6f43004cc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u2.py "view source code") Single-qubit rotation about the X+Z axis. @@ -213,7 +213,7 @@ updated if it was provided -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. @@ -307,7 +307,7 @@ Containing the definition. -`U2Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u2.py "view source code") Return a Numpy.array for the U2 gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.md index 1889f8753bd..a5bea4b33b5 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. @@ -166,7 +166,7 @@ Add classical condition on register classical and value val. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (mutli-)controlled-U3 gate. @@ -210,7 +210,7 @@ updated if it was provided -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. @@ -304,7 +304,7 @@ Containing the definition. -`U3Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a Numpy.array for the U3 gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.md index 165795ae5e3..f5dd395d5fa 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.md index 821d0d53dfd..fef22a3a785 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") The single-qubit Pauli-X gate ($\sigma_x$). @@ -169,7 +169,7 @@ Add classical condition on register classical and value val. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (mutli-)controlled-X gate. @@ -215,7 +215,7 @@ updated if it was provided -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). @@ -307,7 +307,7 @@ Containing the definition. -`XGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/x.py "view source code") Return a numpy.array for the X gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.md index b3526bafaa0..256de885395 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.md index 751ff4b827f..6b6fed59c03 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") The single-qubit Pauli-Y gate ($\sigma_y$). @@ -169,7 +169,7 @@ Add classical condition on register classical and value val. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (mutli-)controlled-Y gate. @@ -215,7 +215,7 @@ updated if it was provided -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) @@ -307,7 +307,7 @@ Containing the definition. -`YGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/y.py "view source code") Return a numpy.array for the Y gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.md index af4e2e637c6..60988dbc8ca 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.md index c13eb85db23..5643b81585e 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") The single-qubit Pauli-Z gate ($\sigma_z$). @@ -169,7 +169,7 @@ Add classical condition on register classical and value val. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (mutli-)controlled-Z gate. @@ -215,7 +215,7 @@ updated if it was provided -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). @@ -307,7 +307,7 @@ Containing the definition. -`ZGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/z.py "view source code") Return a numpy.array for the Z gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.md index 16dab3fbadc..1c0d732d8ac 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.md index 8fc1e9b59c0..aec7d0ced5c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/iswap.py "view source code") iSWAP gate. @@ -338,7 +338,7 @@ Containing the definition. -`iSwapGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/library/standard_gates/iswap.py "view source code") Return a numpy.array for the iSWAP gate. diff --git a/docs/api/qiskit/0.19/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.19/qiskit.circuit.random.random_circuit.md index 442e41426c4..83d88d218b7 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.19/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None, *, n_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None, *, n_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.19/qiskit.compiler.assemble.md b/docs/api/qiskit/0.19/qiskit.compiler.assemble.md index 081fcb5a243..850fcfabfed 100644 --- a/docs/api/qiskit/0.19/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.19/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, parameter_binds=None, parametric_pulses=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/compiler/assemble.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, parameter_binds=None, parametric_pulses=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/compiler/assemble.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.19/qiskit.compiler.schedule.md b/docs/api/qiskit/0.19/qiskit.compiler.schedule.md index 85cd2f75e43..300effe8388 100644 --- a/docs/api/qiskit/0.19/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.19/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/compiler/schedule.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/compiler/schedule.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.19/qiskit.compiler.transpile.md b/docs/api/qiskit/0.19/qiskit.compiler.transpile.md index 98df0e53f25..46dedbe79eb 100644 --- a/docs/api/qiskit/0.19/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.19/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/compiler/transpile.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/compiler/transpile.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.19/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.19/qiskit.converters.ast_to_dag.md index 3815c409204..53bb6815c5f 100644 --- a/docs/api/qiskit/0.19/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.19/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.19/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.19/qiskit.converters.circuit_to_dag.md index f147d74aea2..c36a96221da 100644 --- a/docs/api/qiskit/0.19/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.19/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.19/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.19/qiskit.converters.circuit_to_gate.md index 816b6b55a94..ac57f8f3176 100644 --- a/docs/api/qiskit/0.19/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.19/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.19/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.19/qiskit.converters.circuit_to_instruction.md index d7d489bdc06..c380638821d 100644 --- a/docs/api/qiskit/0.19/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.19/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.19/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.19/qiskit.converters.dag_to_circuit.md index b6d5c3267f5..10265e6d9e1 100644 --- a/docs/api/qiskit/0.19/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.19/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.md index ea96004e512..1a22e20b1d2 100644 --- a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Quantum circuit as a directed acyclic graph. @@ -42,7 +42,7 @@ Return a list of the wires in order. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -50,7 +50,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -58,7 +58,7 @@ Add all wires in a quantum register. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGNodes. @@ -66,7 +66,7 @@ Returns set of the ancestors of a node as DAGNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -93,7 +93,7 @@ the current max node -`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -120,7 +120,7 @@ the current max node -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -128,7 +128,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -140,7 +140,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -173,7 +173,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.compose_back(input_circuit, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose_back(input_circuit, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: use DAGCircuit.compose() instead. @@ -181,7 +181,7 @@ DEPRECATED: use DAGCircuit.compose() instead. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -191,7 +191,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -201,7 +201,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -213,7 +213,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGNodes. @@ -221,7 +221,7 @@ Returns set of the descendants of a node as DAGNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -245,7 +245,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -257,7 +257,7 @@ Iterator for node values. -`DAGCircuit.extend_back(dag, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.extend_back(dag, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: Add dag at the end of self, using edge\_map. @@ -265,7 +265,7 @@ DEPRECATED: Add dag at the end of self, using edge\_map. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -281,7 +281,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -297,7 +297,7 @@ Return idle wires. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -311,7 +311,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGNodes. @@ -319,7 +319,7 @@ Returns the longest path in the dag as a list of DAGNodes. -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -327,7 +327,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -335,7 +335,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -343,7 +343,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -363,7 +363,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -375,7 +375,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -396,7 +396,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -404,7 +404,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -412,7 +412,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -420,7 +420,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -441,7 +441,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGNodes. @@ -449,7 +449,7 @@ Returns iterator of the predecessors of a node as DAGNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -457,7 +457,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGNodes. @@ -465,7 +465,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as DAGNodes. @@ -473,7 +473,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -481,7 +481,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -489,7 +489,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -497,7 +497,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -505,7 +505,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -513,7 +513,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -523,7 +523,7 @@ Add edges from predecessors to successors. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -533,7 +533,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -541,7 +541,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a DAGNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -568,7 +568,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -586,7 +586,7 @@ Replace one node with dag. -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGNodes. @@ -594,7 +594,7 @@ Returns iterator of the successors of a node as DAGNodes. -`DAGCircuit.threeQ_or_more_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.threeQ_or_more_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3-or-more-qubit gates: (id, data). @@ -602,7 +602,7 @@ Get list of 3-or-more-qubit gates: (id, data). -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -610,7 +610,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -626,7 +626,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.topological_op_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -642,7 +642,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.twoQ_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.twoQ_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. @@ -650,7 +650,7 @@ Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -658,7 +658,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.md index 41fd9f4cd6a..7ddbc7e9a2a 100644 --- a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.md index 616b35b6c42..70c760eb7bd 100644 --- a/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.19/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagnode.py "view source code") Object to represent the information at a node in the DAGCircuit. @@ -48,7 +48,7 @@ Returns the Bit object, else None. -`static DAGNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.md index 7fd47e1f10d..e3086f6c4c2 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. @@ -66,7 +66,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -149,7 +149,7 @@ Add classical condition on register classical and value val. -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -205,7 +205,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -263,7 +263,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -295,7 +295,7 @@ Containing the definition. -`HamiltonianGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Return matrix for the unitary. @@ -303,7 +303,7 @@ Return matrix for the unitary. -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. diff --git a/docs/api/qiskit/0.19/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.19/qiskit.extensions.Initialize.md index 8ba77dccbc0..7e78fce7504 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.19/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/quantum_initializer/initializer.py "view source code") Complex amplitude initialization. @@ -56,7 +56,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -107,7 +107,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.md index ebbcab34e9c..9bd6f1b8cb7 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.19/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") Simulator snapshot instruction. @@ -64,7 +64,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -93,7 +93,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") Add classical condition on register classical and value val. @@ -123,7 +123,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.md index 8270a6d76e0..1e1a589c8c9 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Class for representing unitary gates @@ -65,7 +65,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -148,7 +148,7 @@ Add classical condition on register classical and value val. -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -156,7 +156,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -204,7 +204,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -262,7 +262,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -294,7 +294,7 @@ Containing the definition. -`UnitaryGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Return matrix for the unitary. @@ -302,7 +302,7 @@ Return matrix for the unitary. -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. diff --git a/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.md index 89653c0993e..a1d2fbcc4a1 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.19/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md index 90895399d75..9610a5b980c 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md @@ -26,7 +26,7 @@ Convert portfolio optimization instances into Pauli list -`get_operator(mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") +`get_operator(mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") get qubit op @@ -34,7 +34,7 @@ get qubit op -`portfolio_expected_value(x, mu)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_expected_value(x, mu)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio expected value @@ -42,7 +42,7 @@ returns portfolio expected value -`portfolio_value(x, mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_value(x, mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio value @@ -50,7 +50,7 @@ returns portfolio value -`portfolio_variance(x, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_variance(x, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio variance @@ -58,7 +58,7 @@ returns portfolio variance -`random_model(n, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") +`random_model(n, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio.py "view source code") Generate random model (mu, sigma) for portfolio optimization problem. diff --git a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md index f0af6db4a1f..c7dedf6deb1 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md @@ -24,7 +24,7 @@ portfolio diversification -`get_operator(rho, n, q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_operator(rho, n, q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Converts an instance of portfolio optimization into a list of Paulis. @@ -46,7 +46,7 @@ operator for the Hamiltonian -`get_portfoliodiversification_solution(rho, n, q, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_solution(rho, n, q, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. @@ -69,7 +69,7 @@ numpy.ndarray -`get_portfoliodiversification_value(rho, n, q, x_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_value(rho, n, q, x_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). diff --git a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 129c66459ce..88bba89eac5 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") The European Call Option Delta. @@ -37,7 +37,7 @@ Returns the number of target qubits -`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Adds corresponding sub-circuit to given circuit @@ -146,7 +146,7 @@ returns number of qubits controlled -`EuropeanCallDelta.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas @@ -154,7 +154,7 @@ returns required ancillas -`EuropeanCallDelta.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index ef1fefbe0c7..4661106eb47 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") The European Call Option Expected Value. @@ -39,7 +39,7 @@ Returns the number of target qubits -`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -148,7 +148,7 @@ returns number of qubits controlled -`EuropeanCallExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") returns required ancillas @@ -164,7 +164,7 @@ returns required ancillas controlled -`EuropeanCallExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 381728ac8c9..e880dd0f655 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.19/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") The Fixed Income Expected Value. @@ -40,7 +40,7 @@ Returns the number of target qubits -`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -149,7 +149,7 @@ returns number of qubits controlled -`FixedIncomeExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas @@ -157,7 +157,7 @@ returns required ancillas -`FixedIncomeExpectedValue.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas controlled @@ -165,7 +165,7 @@ returns required ancillas controlled -`FixedIncomeExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.md index d84dc7d0d64..37bbddaf2fa 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") The abstract base class for data\_provider modules within Qiskit’s finance module. @@ -24,7 +24,7 @@ To use the subclasses, please see [https://github.com/Qiskit/qiskit-tutorials/qi -`BaseDataProvider.get_coordinates()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_coordinates()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns random coordinates for visualisation purposes. @@ -32,7 +32,7 @@ Returns random coordinates for visualisation purposes. -`BaseDataProvider.get_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns the covariance matrix. @@ -52,7 +52,7 @@ numpy.ndarray -`BaseDataProvider.get_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -72,7 +72,7 @@ numpy.ndarray -`BaseDataProvider.get_period_return_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -92,7 +92,7 @@ numpy.ndarray -`BaseDataProvider.get_period_return_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -112,7 +112,7 @@ numpy.ndarray -`BaseDataProvider.get_similarity_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_similarity_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns time-series similarity matrix computed using dynamic time warping. @@ -132,7 +132,7 @@ numpy.ndarray -`abstract BaseDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`abstract BaseDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Loads data. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.md index 5236c269f76..9635a41c658 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, stockmarket=StockMarket.NASDAQ, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, stockmarket=StockMarket.NASDAQ, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") NASDAQ Data on Demand data provider. @@ -143,7 +143,7 @@ numpy.ndarray -`DataOnDemandProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.md index 13ba53dbb7e..a8b89a4b684 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.DataType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataType -`DataType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`DataType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Data Type Enum diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.md index 45e5c28f2da..08a5148cb4b 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=StockMarket.LONDON, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=StockMarket.LONDON, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Exchange data provider. @@ -136,7 +136,7 @@ numpy.ndarray -`ExchangeDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.md index 146bff50a71..a451126c56e 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, stockmarket=StockMarket.RANDOM, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, stockmarket=StockMarket.RANDOM, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/random_data_provider.py "view source code") Pseudo-randomly generated mock stock-market data provider. @@ -134,7 +134,7 @@ numpy.ndarray -`RandomDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/random_data_provider.py "view source code") Generates data pseudo-randomly, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.md index 6a71bf6f9a3..7d0a68cdeaf 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/_base_data_provider.py "view source code") Stock Market enum diff --git a/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.md index 02fa9fba5b9..de8313b200a 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.19/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, stockmarket=StockMarket.NASDAQ, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, stockmarket=StockMarket.NASDAQ, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Wikipedia data provider. @@ -136,7 +136,7 @@ numpy.ndarray -`WikipediaDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.md index 0c44b100428..661592f66d5 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter @@ -156,7 +156,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -193,7 +193,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.md index 50842fba3f5..faa9028d2de 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter @@ -156,7 +156,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -193,7 +193,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -213,7 +213,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.md index 32d5f57ea7c..13eea1654eb 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter @@ -156,7 +156,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -193,7 +193,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.md index 859ec13fd95..da4a75a316a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter @@ -156,7 +156,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -193,7 +193,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.md index 5674cb85975..07c4a72d815 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of characteristic times @@ -186,7 +186,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -213,7 +213,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -234,7 +234,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.md index 3063492b767..e784cf31eb6 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of gate errors @@ -173,7 +173,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.md index 4ed3f49c100..da6b51ece50 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Drag Experiment fitter @@ -158,7 +158,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -195,7 +195,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -217,7 +217,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.md index 5d84d694d7f..955d99134a5 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Rabi Experiment fitter @@ -175,7 +175,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -197,7 +197,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -217,7 +217,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -237,7 +237,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.md index 7735c9dd9ea..31eb51212c8 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T1, based on experiments outcomes, @@ -190,7 +190,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.md index 243c4730cf9..1bc7c30bb99 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2, based on experiments outcomes. @@ -191,7 +191,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.md index ae6e58e7e0a..5162f2512fb 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2\*, based on experiments outcomes. @@ -190,7 +190,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -210,7 +210,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.md index 51797d93613..7e90e8ae93d 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") ZZ fitter @@ -140,7 +140,7 @@ The data points are returning in the form of a list of dictionaries: -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -218,7 +218,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_1Q_circuits.md index ef25726ce5d..e4ba1485c98 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_cx_circuits.md index b77f1486fc0..60dee684d18 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_1Q_circuits.md index e65e3c3a63e..3303d3f7184 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_cx_circuits.md index 573865adaec..380b2349174 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.drag_schedules.md index 6fa4415c89f..bf80f786666 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.get_single_q_pulse.md index 454eb843680..c6e59d24325 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.rabi_schedules.md index fdabafc433f..3f9117ace58 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.t1_circuits.md index 622a8f88ee4..ae316ca0622 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2_circuits.md index db593412640..ce414a7aa4a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2star_circuits.md index cd67676a06b..c9d742e10a5 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.update_u_gates.md index 4d5681c7874..fd967348f6e 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.19/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.characterization.zz_circuits.md index 38c8da2f3d1..bc9de05760f 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.md index 03e7f748e93..fc82ead05a4 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Class to read from Ignis log files @@ -22,7 +22,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -38,7 +38,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.md index b049aad51eb..10650c17223 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis @@ -71,7 +71,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -108,7 +108,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -116,7 +116,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -256,7 +256,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.md index 8b934ed8824..1794b0c1d2b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Singleton class to configure file logging via IgnisLogger @@ -34,7 +34,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -50,7 +50,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -66,7 +66,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -82,7 +82,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.md index 155318c64e3..1c3205d181d 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") Implements a filter based on a discriminator that takes level 1 data to level 2 data. @@ -29,7 +29,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -49,7 +49,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -69,7 +69,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.md index 43ed9608c01..075bec14082 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Abstract discriminator that implements the data formatting for IQ level 1 data. @@ -55,7 +55,7 @@ Returns the schedules with which the discriminator was fitted. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -75,7 +75,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -83,7 +83,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -107,7 +107,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -133,7 +133,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -179,7 +179,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -210,7 +210,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.md index 601b77baf52..f78dfe51e79 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Linear discriminant analysis discriminator for IQ data. @@ -56,7 +56,7 @@ Returns the schedules with which the discriminator was fitted. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -76,7 +76,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index fdf5f1d7341..c8b1bbbbf0e 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Quadratic discriminant analysis discriminator for IQ data. @@ -56,7 +56,7 @@ Returns the schedules with which the discriminator was fitted. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -76,7 +76,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.md index 259002929ad..179a5129690 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. @@ -56,7 +56,7 @@ Returns the schedules with which the discriminator was fitted. -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -76,7 +76,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.md index 630a70c9ed6..554e76bb6fb 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a full calibration @@ -49,7 +49,7 @@ Return state\_labels. -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -62,7 +62,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -75,7 +75,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -99,7 +99,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.md index 7f5addc807f..8f9e21a064b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") Measurement error mitigation filter. @@ -39,7 +39,7 @@ return the state label ordering of the cal matrix -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.md index ac5f9f4bacf..0153710c7bf 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") Tensored measurement error mitigation filter. @@ -47,7 +47,7 @@ Return \_substate\_labels\_list -`TensoredFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.md index a05abc88adf..d82238a9470 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a tensored calibration. @@ -51,7 +51,7 @@ Return \_substate\_labels\_list. -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -64,7 +64,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -83,7 +83,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.complete_meas_cal.md index 6d35a538530..70aa5867973 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.tensored_meas_cal.md index 2f69287d5db..f9df3f3d5fb 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.md index 6292a88cf4c..74f919f010a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/circuits.py "view source code") This class generates accreditation circuits from a target. @@ -31,7 +31,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -53,7 +53,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.md index 3609a7aafea..2281ba433e8 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/fitters.py "view source code") Class for fitters for accreditation @@ -72,7 +72,7 @@ Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence @@ -84,7 +84,7 @@ This function computes the bound on variation distance based and the confidence -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single protocol run of accreditation protocol on simul backend diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.md index ed120a0880a..6169450115a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.BasicUtils.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BasicUtils -`BasicUtils`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`BasicUtils` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Abstract base class (ABS) for utils for various groups and sets of gates for randomized benchmarking. @@ -20,7 +20,7 @@ Abstract base class (ABS) for utils for various groups and sets of gates for ran -`abstract BasicUtils.compose_gates()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.compose_gates()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Compose group elements. @@ -28,7 +28,7 @@ Compose group elements. -`abstract BasicUtils.elmnt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.elmnt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Return a group element. @@ -36,7 +36,7 @@ Return a group element. -`abstract BasicUtils.elmnt_key()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.elmnt_key()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Return a key of a group element in the table. @@ -44,7 +44,7 @@ Return a key of a group element in the table. -`abstract BasicUtils.find_inverse_gates()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.find_inverse_gates()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Compute an inverse of a group element. @@ -52,7 +52,7 @@ Compute an inverse of a group element. -`abstract BasicUtils.find_key()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.find_key()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Return a key to the group element. @@ -60,7 +60,7 @@ Return a key to the group element. -`abstract BasicUtils.gatelist()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.gatelist()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Return a list of gates corresponding to a group element. @@ -68,7 +68,7 @@ Return a list of gates corresponding to a group element. -`abstract BasicUtils.group_tables()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.group_tables()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Return the group tables. @@ -76,7 +76,7 @@ Return the group tables. -`abstract BasicUtils.load_tables()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.load_tables()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Load pickled group tables, or generate them if they do not exist. @@ -84,7 +84,7 @@ Load pickled group tables, or generate them if they do not exist. -`abstract BasicUtils.num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Return the number of qubits. @@ -92,7 +92,7 @@ Return the number of qubits. -`abstract BasicUtils.random_gates()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") +`abstract BasicUtils.random_gates()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/basic_utils.py "view source code") Pick a random group element. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.md index 85f7320fba4..36d4ef3d189 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(n_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(n_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") CNOT-dihedral Object Class. The CNOT-dihedral group on n qubits is generated by the gates CNOT, T and X. @@ -26,7 +26,7 @@ Return a string representation of a CNOT-dihedral object. -`CNOTDihedral.__mul__(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.__mul__(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Left multiplication self \* other. @@ -34,7 +34,7 @@ Left multiplication self \* other. -`CNOTDihedral.cnot(i, j)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.cnot(i, j)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. @@ -42,7 +42,7 @@ Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. -`CNOTDihedral.flip(i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.flip(i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply X to this element. Left multiply the element by X\_i. @@ -50,7 +50,7 @@ Apply X to this element. Left multiply the element by X\_i. -`CNOTDihedral.phase(k, i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.phase(k, i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply an k-th power of T to this element. Left multiply the element by T\_i^k. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.md index db5f8cd4908..1189edc830c 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for non-Clifford CNOT-Dihedral RB. @@ -71,7 +71,7 @@ Return ydata (means and std devs) as a 2 element list. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -89,7 +89,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -97,7 +97,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -105,7 +105,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -130,7 +130,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -144,7 +144,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.md index 7d05503be7c..9361361c636 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Clifford -`Clifford(num_qubits=None, table=None, phases=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford(num_qubits=None, table=None, phases=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Clifford Operator Class. @@ -34,7 +34,7 @@ Return the Clifford table. -`Clifford.__getitem__(index)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.__getitem__(index)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Get element from internal symplectic table. @@ -42,7 +42,7 @@ Get element from internal symplectic table. -`Clifford.as_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.as_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Return dictionary (JSON) represenation of Clifford object @@ -50,7 +50,7 @@ Return dictionary (JSON) represenation of Clifford object -`Clifford.cx(qubit_ctrl, qubit_trgt)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.cx(qubit_ctrl, qubit_trgt)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply a Controlled-NOT “cx” gate. @@ -58,7 +58,7 @@ Apply a Controlled-NOT “cx” gate. -`Clifford.cz(qubit_ctrl, qubit_trgt)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.cz(qubit_ctrl, qubit_trgt)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply a Controlled-z “cz” gate. @@ -66,7 +66,7 @@ Apply a Controlled-z “cz” gate. -`Clifford.destabilizer(row)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.destabilizer(row)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Return the destabilizer as a Pauli object. @@ -74,7 +74,7 @@ Return the destabilizer as a Pauli object. -`classmethod Clifford.from_dict(clifford_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`classmethod Clifford.from_dict(clifford_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Load a Clifford from a dictionary. @@ -82,7 +82,7 @@ Load a Clifford from a dictionary. -`Clifford.h(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.h(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply an Hadamard “h” gate to qubit. @@ -90,7 +90,7 @@ Apply an Hadamard “h” gate to qubit. -`Clifford.index()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.index()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Returns a unique index for the Clifford. @@ -106,7 +106,7 @@ int -`Clifford.s(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.s(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply a phase “s” gate to qubit. @@ -114,7 +114,7 @@ Apply a phase “s” gate to qubit. -`Clifford.sdg(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.sdg(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply an adjoint phase “sdg” gate to qubit. @@ -122,7 +122,7 @@ Apply an adjoint phase “sdg” gate to qubit. -`Clifford.stabilizer(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.stabilizer(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Return the qubit stabilizer as a Pauli object. @@ -130,7 +130,7 @@ Return the qubit stabilizer as a Pauli object. -`Clifford.swap(qubit0, qubit1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.swap(qubit0, qubit1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply SWAP gate between two qubits. @@ -138,7 +138,7 @@ Apply SWAP gate between two qubits. -`Clifford.update_destabilizer(qubit, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.update_destabilizer(qubit, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Update the qubit destabilizer row from a Pauli object. @@ -146,7 +146,7 @@ Update the qubit destabilizer row from a Pauli object. -`Clifford.update_stabilizer(qubit, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.update_stabilizer(qubit, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Update the qubit stabilizer row from a Pauli object. @@ -154,7 +154,7 @@ Update the qubit stabilizer row from a Pauli object. -`Clifford.v(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.v(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply v gate v = sdg.h . @@ -162,7 +162,7 @@ Apply v gate v = sdg.h . -`Clifford.w(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.w(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply w gate w = v.v . @@ -170,7 +170,7 @@ Apply w gate w = v.v . -`Clifford.x(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.x(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply a Pauli “x” gate to a qubit. @@ -178,7 +178,7 @@ Apply a Pauli “x” gate to a qubit. -`Clifford.y(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.y(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply an Pauli “y” gate to a qubit. @@ -186,7 +186,7 @@ Apply an Pauli “y” gate to a qubit. -`Clifford.z(qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") +`Clifford.z(qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/Clifford.py "view source code") Apply an Pauli “z” gate to qubit. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.md index ac2a1c9e24c..7ba15a56639 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.CliffordUtils.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CliffordUtils -`CliffordUtils(num_qubits=2, group_tables=None, elmnt=None, gatelist=None, elmnt_key=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils(num_qubits=2, group_tables=None, elmnt=None, gatelist=None, elmnt_key=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Class for util functions for the Clifford group. @@ -28,7 +28,7 @@ Class for util functions for the Clifford group. -`CliffordUtils.clifford1_gates(idx)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.clifford1_gates(idx)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Make a single qubit Clifford gate. @@ -48,7 +48,7 @@ list -`CliffordUtils.clifford1_gates_table()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.clifford1_gates_table()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Generate a table of all 1-qubit Clifford gates. @@ -64,7 +64,7 @@ dict -`CliffordUtils.clifford2_gates(idx)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.clifford2_gates(idx)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Make a 2-qubit Clifford gate. @@ -84,7 +84,7 @@ list -`CliffordUtils.clifford2_gates_table()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.clifford2_gates_table()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Generate a table of all 2-qubit Clifford gates. @@ -100,7 +100,7 @@ dict -`CliffordUtils.clifford_from_gates(num_qubits, gatelist)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.clifford_from_gates(num_qubits, gatelist)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Generate a Clifford object from a list of gates. @@ -121,7 +121,7 @@ A Clifford class object corresponding to composing the given list of gates. -`CliffordUtils.compose_gates(cliff, gatelist)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.compose_gates(cliff, gatelist)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Add gates to a Clifford object from a list of gates. @@ -146,7 +146,7 @@ A Clifford class object, after composing cliff and the gates from gatelist. -`CliffordUtils.cx_gates(gatelist, ctrl, tgt)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.cx_gates(gatelist, ctrl, tgt)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Adds a controlled-x gate on qubits ctrl and tgt to a given list of gates. @@ -168,7 +168,7 @@ list -`CliffordUtils.elmnt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.elmnt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Return a Clifford object. @@ -176,7 +176,7 @@ Return a Clifford object. -`CliffordUtils.elmnt_key()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.elmnt_key()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Return a unique index of a Clifford object. @@ -184,7 +184,7 @@ Return a unique index of a Clifford object. -`CliffordUtils.find_inverse_gates(num_qubits, gatelist)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.find_inverse_gates(num_qubits, gatelist)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Find the inverse of a Clifford gate. @@ -209,7 +209,7 @@ list -`CliffordUtils.find_key(cliff, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.find_key(cliff, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Find the Clifford index. @@ -230,7 +230,7 @@ int -`CliffordUtils.gatelist()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.gatelist()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Return a list of gates corresponding to a Clifford object. @@ -238,7 +238,7 @@ Return a list of gates corresponding to a Clifford object. -`CliffordUtils.group_tables()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.group_tables()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Return the Clifford group tables. @@ -246,7 +246,7 @@ Return the Clifford group tables. -`CliffordUtils.h_gates(gatelist, q, h)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.h_gates(gatelist, q, h)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Append a hadamard gate on qubit q to a given list of gates. @@ -275,7 +275,7 @@ list -`CliffordUtils.load_clifford_table(picklefile='cliffords2.pickle')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.load_clifford_table(picklefile='cliffords2.pickle')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Load pickled files of the tables of 1 and 2 qubit Clifford group tables. @@ -295,7 +295,7 @@ dict -`CliffordUtils.load_tables(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.load_tables(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Return the Clifford group tables. @@ -319,7 +319,7 @@ dict -`CliffordUtils.num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Return the number of qubits of the Clifford object. @@ -327,7 +327,7 @@ Return the number of qubits of the Clifford object. -`CliffordUtils.pauli_gates(gatelist, q, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.pauli_gates(gatelist, q, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Append a pauli gate on qubit q to a given list of gates. @@ -357,7 +357,7 @@ list -`CliffordUtils.pickle_clifford_table(picklefile='cliffords2.pickle', num_qubits=2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.pickle_clifford_table(picklefile='cliffords2.pickle', num_qubits=2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Create pickled versions of the 1 or 2 qubit Clifford group tables. @@ -374,7 +374,7 @@ Create pickled versions of the 1 or 2 qubit Clifford group tables. -`CliffordUtils.random_gates(num_qubits, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.random_gates(num_qubits, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Pick a random Clifford gate on num\_qubits. @@ -400,7 +400,7 @@ list -`CliffordUtils.v_gates(gatelist, q, v)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") +`CliffordUtils.v_gates(gatelist, q, v)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/clifford_utils.py "view source code") Adds an axis-swap gate V or W on qubit q to a given list of gates. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.md index 870ed65cea7..f8979fb4a88 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.DihedralUtils.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.DihedralUtils -`DihedralUtils(num_qubits=2, group_tables=None, elmnt=None, gatelist=None, elmnt_key=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils(num_qubits=2, group_tables=None, elmnt=None, gatelist=None, elmnt_key=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Class for util functions for the CNOT-dihedral group. @@ -28,7 +28,7 @@ Class for util functions for the CNOT-dihedral group. -`DihedralUtils.cnot_dihedral_gates(idx, G_table, G_keys)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.cnot_dihedral_gates(idx, G_table, G_keys)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Make a single CNOT-dihedral element on num\_qubits. @@ -50,7 +50,7 @@ A single CNOT-dihedral element on num\_qubits. -`DihedralUtils.cnot_dihedral_tables(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.cnot_dihedral_tables(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Generate a table of all CNOT-dihedral group elements on num\_qubits. @@ -72,7 +72,7 @@ dict -`DihedralUtils.compose_gates(elem, next_elem)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.compose_gates(elem, next_elem)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Compose two CNOTDihedral objects. @@ -93,7 +93,7 @@ A CNOTDihedral object, that is a composition of the two CNOTDihedral objects. -`DihedralUtils.elem_to_gates(circ)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.elem_to_gates(circ)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Convert a CNOT-dihedral list of gates for the QuantumCircuit. @@ -117,7 +117,7 @@ list -`DihedralUtils.elmnt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.elmnt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Return a CNOTDihedral object. @@ -125,7 +125,7 @@ Return a CNOTDihedral object. -`DihedralUtils.elmnt_key()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.elmnt_key()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Return a unique key of a CNOTDihedral object. @@ -133,7 +133,7 @@ Return a unique key of a CNOTDihedral object. -`DihedralUtils.find_inverse_gates(num_qubits, elem)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.find_inverse_gates(num_qubits, elem)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Find the inverse of a CNOT-dihedral element. @@ -158,7 +158,7 @@ list -`DihedralUtils.find_key(elem, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.find_key(elem, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Find the key of a CNOTDihedral object in the group table. @@ -179,7 +179,7 @@ str -`DihedralUtils.gatelist()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.gatelist()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Return a list of gates corresponding to a CNOTDihedral object. @@ -187,7 +187,7 @@ Return a list of gates corresponding to a CNOTDihedral object. -`DihedralUtils.group_tables()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.group_tables()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Return the CNOT-dihedral group tables. @@ -195,7 +195,7 @@ Return the CNOT-dihedral group tables. -`DihedralUtils.load_dihedral_table(picklefile='cnot_dihedral_2.pickle')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.load_dihedral_table(picklefile='cnot_dihedral_2.pickle')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Load pickled files of the CNOT-dihedral group tables. @@ -215,7 +215,7 @@ dict -`DihedralUtils.load_tables(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.load_tables(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Return the CNOT dihedral group tables. @@ -239,7 +239,7 @@ dict -`DihedralUtils.num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Return the number of qubits of the CNOTDihedral object. @@ -247,7 +247,7 @@ Return the number of qubits of the CNOTDihedral object. -`DihedralUtils.pickle_dihedral_table(num_qubits=2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.pickle_dihedral_table(num_qubits=2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Create pickled versions of the CNOT-dihedral group tables. @@ -263,7 +263,7 @@ Create pickled versions of the CNOT-dihedral group tables. -`DihedralUtils.random_gates(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") +`DihedralUtils.random_gates(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/dihedral_utils.py "view source code") Pick a random CNOT-dihedral element on num\_qubits. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.md index a174462af44..c908faf4181 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. @@ -29,7 +29,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -49,7 +49,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -69,7 +69,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -93,7 +93,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.md index 2a31affc044..55cf6c74a85 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for interleaved RB, derived from RBFitterBase class. @@ -71,7 +71,7 @@ Return ydata (means and std devs) as a 2 element list. -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -89,7 +89,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -99,7 +99,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -109,7 +109,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -127,7 +127,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -141,7 +141,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.md index 896ff612877..734366b5b59 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Maximum-Likelihood estimation process tomography fitter. @@ -56,7 +56,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.md index 44a79002cfc..f2c88c98e4a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitter for purity RB. @@ -63,7 +63,7 @@ Return ydata (means and std devs). -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -71,7 +71,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -88,7 +88,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -96,7 +96,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -110,7 +110,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -125,7 +125,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -142,7 +142,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -160,7 +160,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTP.md index 1a27ed24aa8..cc19c9d9b4e 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTPCorrectCounts.md index e684949ccb0..73852841326 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.md index 4d2a3a35d80..edfb88f97e1 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Class for fitters for quantum volume. @@ -56,7 +56,7 @@ Return the average and std of the output probability. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -77,7 +77,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -95,7 +95,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -109,7 +109,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -119,7 +119,7 @@ Here we assume the error is due to a binomial distribution -`QVFitter.plot_qv_data(ax=None, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -136,7 +136,7 @@ Plot the qv data as a function of depth -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -152,7 +152,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (>2/3 with confidence greater than 97.5) and the confidence diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.md index 7b6ff7693e3..aab7286a1e0 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for randomized benchmarking. @@ -56,7 +56,7 @@ Return ydata (means and std devs). -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -73,7 +73,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -87,7 +87,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -100,7 +100,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -116,7 +116,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -135,7 +135,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.md index 8e5bf71e10e..3ff3fe97d46 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. @@ -31,7 +31,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -45,7 +45,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -69,7 +69,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -77,7 +77,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(reset=True, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(reset=True, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -90,7 +90,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.md index 8e7e74c264f..d4aa89d56f8 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Maximum-Likelihood estimation state tomography fitter. @@ -55,7 +55,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.md index e53bccef30d..c26194aa5af 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Base maximum-likelihood estimate tomography fitter class @@ -43,7 +43,7 @@ Return the tomography preparation basis. -`TomographyFitter.add_data(result, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(result, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -56,7 +56,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -123,7 +123,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -139,7 +139,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epc.md index cd1614c283f..cd766e9b900 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epg.md index d2208ea654a..49d0eb2cdb8 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epc.md index 18609a89be3..a74b8d05dea 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epg.md index 28960f9cf57..8f2a5a2686b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.coherence_limit.md index 0aa830225a6..6cdfd5a598b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.combine_counts.md index cc1229d376a..cce13d49819 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.count_gates.md index c4acaedb23e..2b4a3ed0d7e 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.count_keys.md index f157ec54b6c..023c4d80d4b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.expectation_counts.md index 5377410311b..1f1047c05f7 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.gates_per_clifford.md index 3b94b3474f3..902e92babd4 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.lookuptable_decoding.md index 01ce72ff554..15bc117f13c 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.marginal_counts.md index 474fb6b7441..f1798402b4c 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.postselection_decoding.md index 4130d75670c..881aca93f98 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.process_tomography_circuits.md index 2ccd53c9429..8d76fa0b5b1 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.qv_circuits.md index 1971f77643f..ba32f23f930 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists=None, ntrials=1, qr=None, cr=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists=None, ntrials=1, qr=None, cr=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.randomized_benchmarking_seq.md index 2255c392215..dadac24e1a3 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, is_purity=False, group_gates=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, is_purity=False, group_gates=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.state_tomography_circuits.md index d4953acecbc..bda7489608a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.twoQ_clifford_error.md index f530053b9c4..81fe32a22c0 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.3/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.ad_hoc_data.md index 2d7e8fde372..a35013be3ba 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.breast_cancer.md index 55bbbe52e3f..dbfa2062619 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.digits.md index b9e2e8b5199..d2359998489 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.gaussian.md index 75ed68618b1..b20428f1670 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.iris.md index ce220c7b33c..b9469bd4db6 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.sample_ad_hoc_data.md index 47aa399f506..117df4f9bdf 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.19/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.19/qiskit.ml.datasets.wine.md index a93e6ed9b0d..59864fa6d84 100644 --- a/docs/api/qiskit/0.19/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.19/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.md index ebb5d961ae1..71e23cfc55a 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.md index c3f44048d0b..beef0073fce 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. @@ -172,7 +172,7 @@ The variable index dictionary. -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -196,7 +196,7 @@ The added variable. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -208,7 +208,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -234,7 +234,7 @@ The added variable. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -250,7 +250,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -272,7 +272,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -297,7 +297,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -313,7 +313,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -329,7 +329,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -345,7 +345,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -361,7 +361,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -377,7 +377,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -397,7 +397,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -422,7 +422,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -442,7 +442,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -468,7 +468,7 @@ The added variable. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -497,7 +497,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -519,7 +519,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -541,7 +541,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string in Docplex’s pretty print format. @@ -557,7 +557,7 @@ A string representing the quadratic program. -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Pretty prints the quadratic program to a given output stream (None = default). @@ -573,7 +573,7 @@ Pretty prints the quadratic program to a given output stream (None = default). -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -603,7 +603,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -628,7 +628,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -649,7 +649,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -670,7 +670,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -695,7 +695,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -715,7 +715,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.md index 22a8a7f8483..2d4fe269e4b 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/admm_optimizer.py "view source code") An implementation of the ADMM-based heuristic. @@ -38,7 +38,7 @@ Optimization on Classical and Quantum Computers. arXiv preprint arXiv:2001.02069 -`ADMMOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -82,7 +82,7 @@ Returns True if the problem is compatible, False otherwise. -`ADMMOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Tries to solves the given problem using ADMM algorithm. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.md index eabd2ec9720..adbd074e3f6 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). @@ -45,7 +45,7 @@ This initializer takes the algorithmic parameters of COBYLA and stores them for -`CobylaOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -87,7 +87,7 @@ Returns True if the problem is compatible, False otherwise. -`CobylaOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.md index 9a707ea1d90..34cd287bef0 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). @@ -61,7 +61,7 @@ Whether to print CPLEX information or not. -`CplexOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -103,7 +103,7 @@ Returns True if the problem is compatible, False otherwise. -`static CplexOptimizer.is_cplex_installed()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`static CplexOptimizer.is_cplex_installed()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Returns True if cplex is installed @@ -111,7 +111,7 @@ Returns True if cplex is installed -`CplexOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.md index 307bf3e1885..9f6eb5fb075 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. @@ -44,7 +44,7 @@ The quantum instance used in the algorithm. -`GroverOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -86,7 +86,7 @@ Returns True if the problem is compatible, False otherwise. -`GroverOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Tries to solves the given problem using the grover optimizer. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index a65aa043142..172f7fd0499 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") A wrapper for minimum eigen solvers from Qiskit Aqua. @@ -45,7 +45,7 @@ This initializer takes the minimum eigen solver to be used to approximate the gr -`MinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -87,7 +87,7 @@ Returns True if the problem is compatible, False otherwise. -`MinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 37b16d284c7..680679787db 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") An abstract class for optimization algorithms in Qiskit’s optimization module. @@ -20,7 +20,7 @@ An abstract class for optimization algorithms in Qiskit’s optimization module. -`abstract OptimizationAlgorithm.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -40,7 +40,7 @@ Returns the incompatibility message. If the message is empty no issues were foun -`OptimizationAlgorithm.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -60,7 +60,7 @@ Returns True if the problem is compatible, False otherwise. -`abstract OptimizationAlgorithm.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index f7fb4c665ce..7fbe1f91263 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") A meta-algorithm that applies a recursive optimization. @@ -61,7 +61,7 @@ TODO: add flag to store full history. -`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -103,7 +103,7 @@ Returns True if the problem is compatible, False otherwise. -`RecursiveMinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Tries to solve the given problem using the recursive optimizer. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md index 2c9227815b9..3a60b12c745 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md @@ -26,7 +26,7 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/clique.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/clique.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/clique.py "view source code") +`get_operator(weight_matrix, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/clique.py "view source code") Generate Hamiltonian for the clique. @@ -89,7 +89,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`satisfy_or_not(x, w, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/clique.py "view source code") +`satisfy_or_not(x, w, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/clique.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md index 0acb1ab34d6..5490f011123 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md @@ -62,7 +62,7 @@ print('tsp objective:', result['energy'] + offset) -`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/docplex.py "view source code") +`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/docplex.py "view source code") Generate Ising Hamiltonian from a model of DOcplex. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md index dc131e826b9..7ac1a79b7b1 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md @@ -24,7 +24,7 @@ exact cover -`check_solution_satisfiability(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`check_solution_satisfiability(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/exact_cover.py "view source code") check solution satisfiability @@ -32,7 +32,7 @@ check solution satisfiability -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/exact_cover.py "view source code") Construct the Hamiltonian for the exact solver problem. @@ -62,7 +62,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/exact_cover.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md index 980db3fef27..aec83bc0f2e 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md @@ -24,7 +24,7 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/graph_partition.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/graph_partition.py "view source code") Generate Hamiltonian for the graph partitioning @@ -74,7 +74,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`objective_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`objective_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/graph_partition.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md index 6d5bb8e85cd..8731bbeb3ef 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md @@ -28,7 +28,7 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We -`get_operator(values, weights, max_weight)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_operator(values, weights, max_weight)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/knapsack.py "view source code") Generate Hamiltonian for the knapsack problem. @@ -67,7 +67,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`get_solution(x, values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_solution(x, values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian @@ -90,7 +90,7 @@ numpy.ndarray -`knapsack_value_weight(solution, values, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/knapsack.py "view source code") +`knapsack_value_weight(solution, values, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the total wight and value of the items taken in the knapsack. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md index adc7dbd2c9a..f077dfff58f 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md @@ -24,7 +24,7 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/max_cut.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/max_cut.py "view source code") Generate Hamiltonian for the max-cut problem of a graph. @@ -64,7 +64,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`max_cut_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/max_cut.py "view source code") +`max_cut_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/max_cut.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md index 19c079eda25..51731100e86 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md @@ -23,7 +23,7 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami -`get_operator(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/partition.py "view source code") +`get_operator(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/partition.py "view source code") Construct the Hamiltonian for a given Partition instance. @@ -45,7 +45,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`partition_value(x, number_list)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/partition.py "view source code") +`partition_value(x, number_list)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/partition.py "view source code") Compute the value of a partition. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md index e9b2773d715..ed386869cdd 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md @@ -24,7 +24,7 @@ set packing module -`check_disjoint(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/set_packing.py "view source code") +`check_disjoint(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/set_packing.py "view source code") check disjoint @@ -32,7 +32,7 @@ check disjoint -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/set_packing.py "view source code") Construct the Hamiltonian for the set packing. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/set_packing.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md index edaa6bec1df..8edef5a1987 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md @@ -24,7 +24,7 @@ Convert stable set instances into Pauli list. We read instances in the Gset form -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/stable_set.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_operator(w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/stable_set.py "view source code") Generate Hamiltonian for the maximum stable set in a graph. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`stable_set_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/stable_set.py "view source code") +`stable_set_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/stable_set.py "view source code") Compute the value of a stable set, and its feasibility. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md index e020c7cb35b..21ecb4a31b1 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md @@ -66,7 +66,7 @@ Alias for field number 3 -`calc_distance(coord, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`calc_distance(coord, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") calculate distance @@ -74,7 +74,7 @@ calculate distance -`get_operator(ins, penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_operator(ins, penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") Generate Hamiltonian for TSP of a graph. @@ -95,7 +95,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_tsp_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_tsp_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") Get graph solution from binary string. @@ -119,7 +119,7 @@ Instance data of TSP -`parse_tsplib_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`parse_tsplib_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") Read graph in TSPLIB format from file. @@ -139,7 +139,7 @@ instance data. -`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") Generate a random instance for TSP. @@ -164,7 +164,7 @@ instance data. -`tsp_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") Check whether a solution is feasible or not. @@ -184,7 +184,7 @@ bool -`tsp_value(z, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_value(z, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/tsp.py "view source code") Compute the TSP value of a solution. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md index 026be751fcd..a794e803258 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md @@ -25,7 +25,7 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela -`get_operator(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_operator(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Converts an instance of a vehicle routing problem into a list of Paulis. @@ -47,7 +47,7 @@ operator for the Hamiltonian. -`get_vehiclerouting_cost(instance, n, K, x_sol)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_cost(instance, n, K, x_sol)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Computes the cost of a solution to an instance of a vehicle routing problem. @@ -70,7 +70,7 @@ float -`get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_matrices(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Constructs auxiliary matrices from a vehicle routing instance,** @@ -94,7 +94,7 @@ tuple(numpy.ndarray, numpy.ndarray, float) -`get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_solution(instance, n, K, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Tries to obtain a feasible solution (in vector form) of an instance** diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md index c9f9c52fafa..26432a71fd6 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md @@ -24,7 +24,7 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https -`check_full_edge_coverage(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`check_full_edge_coverage(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vertex_cover.py "view source code") **Parameters** @@ -43,7 +43,7 @@ float -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Get graph solution from binary string. @@ -63,7 +63,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. :type weight\_matrix: numpy.ndarray diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.md index 3b3e29fd4f0..1553b79915e 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert inequality constraints into equality constraints by introducing slack variables. @@ -31,7 +31,7 @@ Convert inequality constraints into equality constraints by introducing slack va -`InequalityToEquality.decode(result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.decode(result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a result of a converted problem into that of the original problem. @@ -51,7 +51,7 @@ The result of the original problem. -`InequalityToEquality.encode(op, name=None, mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.encode(op, name=None, mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a problem with inequality constraints into one with only equality constraints. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.md index 1619e7d5b7a..e0e7e88c4c4 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. @@ -39,7 +39,7 @@ Annealers. arxiv.org:1706.01945. -`IntegerToBinary.decode(result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.decode(result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert the encoded problem (binary variables) back to the original (integer variables). @@ -59,7 +59,7 @@ The result of the original problem. -`IntegerToBinary.encode(op, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.encode(op, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert an integer problem into a new problem with binary variables. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.md index c9713cb5bb9..887c7c737d1 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.IsingToQuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IsingToQuadraticProgram -`IsingToQuadraticProgram(linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/ising_to_quadratic_program.py "view source code") +`IsingToQuadraticProgram(linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/ising_to_quadratic_program.py "view source code") Convert a qubit operator into a quadratic program @@ -24,7 +24,7 @@ Convert a qubit operator into a quadratic program -`IsingToQuadraticProgram.encode(qubit_op, offset=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/ising_to_quadratic_program.py "view source code") +`IsingToQuadraticProgram.encode(qubit_op, offset=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/ising_to_quadratic_program.py "view source code") Convert a qubit operator and a shift value into a quadratic program diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.md index b0cab4e1005..bb0c01180a5 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with only equality constraints to unconstrained with penalty terms. @@ -20,7 +20,7 @@ Convert a problem with only equality constraints to unconstrained with penalty t -`LinearEqualityToPenalty.encode(op, penalty_factor=100000.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.encode(op, penalty_factor=100000.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with equality constraints into an unconstrained problem. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.md index c6253bf3836..3da8a717456 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToIsing.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToIsing -`QuadraticProgramToIsing`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_ising.py "view source code") +`QuadraticProgramToIsing` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_ising.py "view source code") Convert an optimization problem into a qubit operator. @@ -22,7 +22,7 @@ Initialize the internal data structure. -`QuadraticProgramToIsing.encode(op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_ising.py "view source code") +`QuadraticProgramToIsing.encode(op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_ising.py "view source code") Convert a problem into a qubit operator diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.md index 90f1e41fea4..c47a0fc04b1 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToNegativeValueOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToNegativeValueO -`QuadraticProgramToNegativeValueOracle(num_value_qubits, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/0.7.3/qiskit/optimization/converters/quadratic_program_to_negative_value_oracle.py "view source code") +`QuadraticProgramToNegativeValueOracle(num_value_qubits, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/0.7.3/qiskit/optimization/converters/quadratic_program_to_negative_value_oracle.py "view source code") Converts an optimization problem (QUBO) to a negative value oracle. @@ -35,7 +35,7 @@ arxiv:1912.04088. -`QuadraticProgramToNegativeValueOracle.encode(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/0.7.3/qiskit/optimization/converters/quadratic_program_to_negative_value_oracle.py "view source code") +`QuadraticProgramToNegativeValueOracle.encode(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/0.7.3/qiskit/optimization/converters/quadratic_program_to_negative_value_oracle.py "view source code") A helper function that converts a QUBO into an oracle that recognizes negative numbers. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.md index f698d6c739a..21c78c597e5 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a given optimization problem to a new problem that is a QUBO. @@ -35,7 +35,7 @@ Convert a given optimization problem to a new problem that is a QUBO. -`QuadraticProgramToQubo.decode(result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.decode(result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a result of a converted problem into that of the original problem. @@ -55,7 +55,7 @@ The result of the original problem. -`QuadraticProgramToQubo.encode(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.encode(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a problem with linear equality constraints into new one with a QUBO form. @@ -79,7 +79,7 @@ The problem converted in QUBO format. -`static QuadraticProgramToQubo.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`static QuadraticProgramToQubo.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -101,7 +101,7 @@ A message describing the incompatibility. -`QuadraticProgramToQubo.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.md index 72dc47c0947..aba90e08588 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/constraint.py "view source code") Abstract Constraint Class. @@ -95,7 +95,7 @@ The sense of the constraint. -`abstract Constraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/constraint.py "view source code") +`abstract Constraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/constraint.py "view source code") Evaluate left-hand-side of constraint for given values of variables. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.md index 15604365a96..4d01f946064 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_constraint.py "view source code") Representation of a linear constraint. @@ -110,7 +110,7 @@ The sense of the constraint. -`LinearConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.md index 51b0395d61b..71df55b3479 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") Representation of a linear expression by its coefficients. @@ -63,7 +63,7 @@ The parent QuadraticProgram. -`LinearExpression.__getitem__(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.__getitem__(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") Returns the i-th coefficient where i can be a variable name or index. @@ -83,7 +83,7 @@ The coefficient corresponding to the addressed variable. -`LinearExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the linear expression for given variables. @@ -103,7 +103,7 @@ The value of the linear expression given the variable values. -`LinearExpression.to_array()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_array()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as array. @@ -119,7 +119,7 @@ An array with the coefficients corresponding to the linear expression. -`LinearExpression.to_dict(use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_dict(use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as dictionary, either using variable names or indices as keys. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.md index 24ab3da3a75..503592b2c78 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_constraint.py "view source code") Representation of a quadratic constraint. @@ -129,7 +129,7 @@ The sense of the constraint. -`QuadraticConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.md index b449d346280..209195ae05b 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") Representation of a quadratic expression by its coefficients. @@ -63,7 +63,7 @@ The parent QuadraticProgram. -`QuadraticExpression.__getitem__(key)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.__getitem__(key)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficient where i, j can be a variable names or indices. @@ -83,7 +83,7 @@ The coefficient corresponding to the addressed variables. -`QuadraticExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the quadratic expression for given variables: x \* Q \* x. @@ -103,7 +103,7 @@ The value of the quadratic expression given the variable values. -`QuadraticExpression.to_array(symmetric=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_array(symmetric=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as array. @@ -123,7 +123,7 @@ An array with the coefficients corresponding to the quadratic expression. -`QuadraticExpression.to_dict(symmetric=False, use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_dict(symmetric=False, use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as dictionary, either using tuples of variable names or indices as keys. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.md index cba28ac6ad7..d8827081676 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=ObjSense.MINIMIZE)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=ObjSense.MINIMIZE)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_objective.py "view source code") Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. @@ -112,7 +112,7 @@ The sense of the objective function. -`QuadraticObjective.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the quadratic objective for given variable values. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.md index b6e762ee6e0..07806258238 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. @@ -172,7 +172,7 @@ The variable index dictionary. -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -196,7 +196,7 @@ The added variable. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -208,7 +208,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -234,7 +234,7 @@ The added variable. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -250,7 +250,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -272,7 +272,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -297,7 +297,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -313,7 +313,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -329,7 +329,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -345,7 +345,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -361,7 +361,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -377,7 +377,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -397,7 +397,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -422,7 +422,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -442,7 +442,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -468,7 +468,7 @@ The added variable. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -497,7 +497,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -519,7 +519,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -541,7 +541,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string in Docplex’s pretty print format. @@ -557,7 +557,7 @@ A string representing the quadratic program. -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Pretty prints the quadratic program to a given output stream (None = default). @@ -573,7 +573,7 @@ Pretty prints the quadratic program to a given output stream (None = default). -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -603,7 +603,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -628,7 +628,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -649,7 +649,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -670,7 +670,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -695,7 +695,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -715,7 +715,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.md index f3384f36176..a19da57c35e 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=VarType.CONTINUOUS)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=VarType.CONTINUOUS)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/variable.py "view source code") Representation of a variable. @@ -118,7 +118,7 @@ The variable type. -`Variable.as_tuple()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/variable.py "view source code") +`Variable.as_tuple()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/problems/variable.py "view source code") Returns a tuple corresponding to this variable. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.md index d7223e0e1a0..80b6912a242 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.md index 26bf854b566..54e3e577c20 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.19/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Base class for backends. @@ -33,7 +33,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -49,7 +49,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -65,7 +65,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -81,7 +81,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -97,7 +97,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -109,7 +109,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -125,7 +125,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.19/qiskit.providers.BaseJob.md index 000d91e2e5a..611adbb1a6e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.19/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Class to handle asynchronous jobs @@ -27,7 +27,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -39,7 +39,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -47,7 +47,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -59,7 +59,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -71,7 +71,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -83,7 +83,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -95,7 +95,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -103,7 +103,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -115,7 +115,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -123,7 +123,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -131,7 +131,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.md index 1ab63a36c10..a3dd4474932 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.19/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/baseprovider.py "view source code") Base class for a Backend Provider. @@ -20,7 +20,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -43,7 +43,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobError.md b/docs/api/qiskit/0.19/qiskit.providers.JobError.md index 12b779818f1..8775f38b63c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.19/qiskit.providers.JobStatus.md index d02099ea266..10474e95879 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.19/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/jobstatus.py "view source code") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.md index b523ee7dead..ab2fd8f8ba9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.md index 57f6d8a6ff8..969184ce80c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.md index 8dd32921409..f6ad3f0054d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.md index 99fbc01cef8..e8d3d0643f9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") AerJob class. @@ -37,7 +37,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -45,7 +45,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") Attempt to cancel the job. @@ -101,7 +101,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -117,7 +117,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -156,7 +156,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -177,7 +177,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.md index 06468a34fde..2c8e4d02b56 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerprovider.py "view source code") Provider for Qiskit Aer backends. @@ -20,7 +20,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -43,7 +43,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.md index cc08f8c9e97..bb4f324b603 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Pulse schedule simulator backend. @@ -92,7 +92,7 @@ the configuration for the backend. -`PulseSimulator.defaults()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.defaults()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Return defaults. @@ -156,7 +156,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(qobj, system_model, backend_options=None, validate=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(qobj, system_model, backend_options=None, validate=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on system\_model. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.md index 4634e60b026..869bf3aac92 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.md index 80c78196022..cacc8bec214 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.md index c78ce8306e1..3999ff9fcc5 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.md index 048b85f75a8..343c6c5026e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") Simulator snapshot instruction. @@ -64,7 +64,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -123,7 +123,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -131,7 +131,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 423ff76911f..639d582d3c7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Snapshot instruction for density matrix method of Qasm simulator. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index e951d5e80e0..5470b7ae0c7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Snapshot instruction for supported methods of Qasm simulator. @@ -63,7 +63,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 2ada166fd63..649e5e847e9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Snapshot instruction for all methods of Qasm simulator. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 7748e47c273..c4ac0436da2 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Snapshot instruction for stabilizer method of Qasm simulator. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.md index bcd682e1f02..ece71b6ac25 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Snapshot instruction for statevector snapshot type diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.md index add234634f3..4e2e9ea60f2 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Noise model class for Qiskit Aer simulators. @@ -80,7 +80,7 @@ Return the set of noisy qubits for this noise model. -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -102,7 +102,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -123,7 +123,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -138,7 +138,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model. @@ -162,7 +162,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -185,7 +185,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -207,7 +207,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -270,7 +270,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -294,7 +294,7 @@ the noise model. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -302,7 +302,7 @@ Reset the noise model. -`NoiseModel.set_x90_single_qubit_gates(instructions)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.set_x90_single_qubit_gates(instructions)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Declares X90 based gates for noise model. @@ -318,7 +318,7 @@ Declares X90 based gates for noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.md index 021d8ed35dd..36e60286c40 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Quantum error class for Qiskit Aer noise model @@ -81,13 +81,13 @@ Return the number of error circuit. -`QuantumError.__mul__(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.__mul__(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") ### compose -`QuantumError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel other \* self. @@ -115,7 +115,7 @@ The composition error channel. -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -123,7 +123,7 @@ Make a copy of current QuantumError. -`QuantumError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel self \* other. @@ -148,7 +148,7 @@ The composition error channel. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -173,7 +173,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -197,7 +197,7 @@ the tensor product error channel other ⊗ self. -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if current error object is an identity @@ -205,7 +205,7 @@ Return True if current error object is an identity -`QuantumError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the compose of a error channel with itself n times. @@ -229,7 +229,7 @@ the n-times composition error channel. -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -237,7 +237,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -245,7 +245,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -269,7 +269,7 @@ the tensor product error channel self ⊗ other. -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -277,7 +277,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -285,7 +285,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.md index 0ce1192d4e7..6e0bc312b95 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Readout error class for Qiskit Aer noise model. @@ -69,13 +69,13 @@ The relative tolerance parameter for float comparisons. -`ReadoutError.__mul__(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.__mul__(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") ### compose -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -103,7 +103,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -111,7 +111,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -136,7 +136,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -160,7 +160,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -168,7 +168,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -192,7 +192,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -200,7 +200,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -208,7 +208,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -232,7 +232,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -240,7 +240,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.amplitude_damping_error.md index 0963bd33872..5d1324bcd5d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.coherent_unitary_error.md index 5b677b2f1da..f415452bd8a 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.depolarizing_error.md index e0976898ab2..13a1193ea50 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index a29c6157ac7..f48ed16f715 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index 483854faa69..d0b4ed21aca 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_error_values.md index 2a064bc36bc..4a6fd911868 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_length_values.md index 4e2c7d80974..741fbeee353 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_param_values.md index beed585b012..ae65932fcad 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.readout_error_values.md index 6b3fc1361e4..a6ff43b91a4 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index 55f42f90f36..02774580ace 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.kraus_error.md index 4f66f3498f9..7e0bf490a76 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.mixed_unitary_error.md index 7666ed3f063..a4bf5fe06ea 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.pauli_error.md index 74fc04a389a..4bed18c54d7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index fa0a6c90981..29e8d10ffa6 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_damping_error.md index 27a275cc9e5..d36e937e90d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.reset_error.md index c491cdac23b..2f218c3aa0d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.thermal_relaxation_error.md index d33da2ef814..737f6847b42 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.md index 2d824e92001..3eb873644ff 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, qubit_freq_est=None, meas_freq_est=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, qubit_freq_est=None, meas_freq_est=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") Physical model object for pulse simulator. @@ -51,7 +51,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -75,7 +75,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -95,7 +95,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.duffing_system_model.md index df772440f0c..dd706d05351 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/pulse/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.md index 2f0a7a4c062..6a22df3a961 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transforms one quantum channel to another based on a specified criteria. @@ -20,7 +20,7 @@ Transforms one quantum channel to another based on a specified criteria. -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -40,7 +40,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -56,7 +56,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -77,7 +77,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -93,7 +93,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -101,7 +101,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -119,7 +119,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -161,7 +161,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -182,7 +182,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -207,7 +207,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -232,7 +232,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -252,7 +252,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -272,7 +272,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -292,7 +292,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -305,7 +305,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -329,7 +329,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -354,7 +354,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_noise_model.md index 80afd61916f..2132037f02a 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_quantum_error.md index 4bc7fec415d..06bd5227926 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.insert_noise.md index c93f2ab1d8c..09827a16df3 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.remap_noise_model.md index f5364721f97..d4c4ee0d3a9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.5/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.md index 638ec34b810..d6aa90fd123 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.md index 5ac157e83da..34a55730923 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, fn, qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, fn, qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") BasicAerJob class. @@ -37,7 +37,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -45,7 +45,7 @@ Return the instance of the backend used for this job. -`BasicAerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") Attempt to cancel the job. @@ -101,7 +101,7 @@ Return a unique id identifying the job. -`BasicAerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the Qobj submitted for this job. @@ -117,7 +117,7 @@ the Qobj submitted for this job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -156,7 +156,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -177,7 +177,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.md index cac00a5401c..46102719505 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerprovider.py "view source code") Provider for Basic Aer backends. @@ -20,7 +20,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -43,7 +43,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.md index 247ace4c27f..5b877079521 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/qasm_simulator.py "view source code") Python implementation of a qasm simulator. @@ -123,7 +123,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, backend_options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, backend_options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -160,7 +160,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.md index d5abb9df00c..b12e41ac77c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/statevector_simulator.py "view source code") Python statevector simulator. @@ -123,7 +123,7 @@ the Provider responsible for the backend. -`StatevectorSimulatorPy.run(qobj, backend_options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy.run(qobj, backend_options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/statevector_simulator.py "view source code") Run qobj asynchronously. diff --git a/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.md index fca7afb2969..0cefe380bab 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/unitary_simulator.py "view source code") Python implementation of a unitary simulator. @@ -117,7 +117,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, backend_options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, backend_options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -165,7 +165,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.md index cbe63b6c954..651630b0e69 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/accountprovider.py "view source code") Provider for a single IBM Quantum Experience account. @@ -60,7 +60,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.md index 40a382c20b6..44ba19d840c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/backendjoblimit.py "view source code") Job limit for a backend. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index f09f6e633d3..9425a41a7a1 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 654d978bb74..e7455ae9f1a 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index e4c76ba1549..973beb7e44c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 59f9ed2fc70..065b0ef491c 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.md index b2b04555c93..8499762b2db 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 90885477787..36dcc5e09a1 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.md index 43870313a3a..e958a50b6f3 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Backend class interfacing with an IBM Quantum Experience device. @@ -61,7 +61,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -99,7 +99,7 @@ the configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -119,7 +119,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -155,7 +155,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -235,7 +235,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -272,7 +272,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -298,7 +298,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -322,7 +322,7 @@ The job with the given ID. -`IBMQBackend.run(qobj, job_name=None, job_share_level=None, job_tags=None, validate_qobj=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(qobj, job_name=None, job_share_level=None, job_tags=None, validate_qobj=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run a Qobj asynchronously. @@ -366,7 +366,7 @@ The job to be executed, an instance derived from BaseJob. -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.md index 491d26a674e..e47ccecbf7f 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index ef6f988034a..9ad4f8babf4 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.md index 1f15824c545..6bfe1f7cb53 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.md index 42c5c53877a..428663d5b09 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Backend namespace for an IBM Quantum Experience account provider. @@ -45,7 +45,7 @@ IBMQBackendService constructor. -`IBMQBackendService.__call__(name=None, filters=None, timeout=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.__call__(name=None, filters=None, timeout=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -83,7 +83,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -150,7 +150,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.md index 92e6effca60..bfc9185b0f0 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.md index 021a5361066..2741eeb7b90 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.md index 39e8f9b3197..e51c5826600 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Factory and account manager for IBM Quantum Experience. @@ -22,7 +22,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -38,7 +38,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -56,7 +56,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -72,7 +72,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -117,7 +117,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -143,7 +143,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -167,7 +167,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -189,7 +189,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -230,7 +230,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -251,7 +251,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.md index b6c336ffcac..2ad347a3912 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.md index 86a44b0ce5e..f77d8b185ed 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") IBM Quantum Experience account credentials. @@ -37,7 +37,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -53,7 +53,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -65,7 +65,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.md index d2cf36a360f..68d7251e526 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index f94d22171ad..c61c7f403cf 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index c00850aee1f..c513e903669 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.md index 85d33dc0dc5..41203f4d1b9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Representation of a job that executes on an IBM Quantum Experience backend. @@ -86,7 +86,7 @@ Return the backend where this job was executed. -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -122,7 +122,7 @@ Return whether the job has been cancelled. -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -150,7 +150,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -166,7 +166,7 @@ An error report if the job failed or `None` otherwise. -`classmethod IBMQJob.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`classmethod IBMQJob.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Deserialize a dictionary of simple types into an instance of this class. @@ -198,7 +198,7 @@ Return whether the job is in a final job state. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -214,7 +214,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -230,7 +230,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -250,7 +250,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -270,7 +270,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -292,7 +292,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -316,7 +316,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -334,7 +334,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -396,7 +396,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -416,7 +416,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -444,7 +444,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Submit this job to an IBM Quantum Experience backend. @@ -464,7 +464,7 @@ Submit this job to an IBM Quantum Experience backend. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -480,7 +480,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -504,7 +504,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Serialize the model into a Python dict of simple types. @@ -524,7 +524,7 @@ An empty dictionary. -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -549,7 +549,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -589,7 +589,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.md index e3aafca5594..2fdebcefe37 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.md index 09876cf98ff..6d18f3be63f 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 4a953cd59e1..0b29a7a685e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 6aa547c7b9d..a084e69c7bf 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index ad6387e50ae..38fef992cc5 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.md index c14fed9a69c..f21bb306368 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/queueinfo.py "view source code") Queue information for a job. @@ -76,7 +76,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.job_monitor.md index 7de8266d840..aec21b9d3ac 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.least_busy.md index b947f37f13f..b4b56568075 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.md index e2995a1ee23..90c88e7b935 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Job Manager for IBM Quantum Experience. @@ -54,7 +54,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -74,7 +74,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -94,7 +94,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -121,7 +121,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 6408a88362b..3f1b709dc76 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index d276405583b..9d1c726cca7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 85fad20b9f5..9f27e52b639 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index f04d425de50..d2e4753fc15 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 0ed35876af8..b702baf42b1 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 4f8bafd92a2..b04b9ac3114 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.md index 2b0940675d9..57e17bf5509 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Job managed by the Job Manager. @@ -28,7 +28,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -40,7 +40,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -56,7 +56,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -72,7 +72,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -97,7 +97,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -113,7 +113,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(qobj, job_name, backend, executor, submit_lock, job_share_level, job_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(qobj, job_name, backend, executor, submit_lock, job_share_level, job_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.md index 4582560a853..a124074cc39 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") A set of managed jobs. @@ -29,7 +29,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -41,7 +41,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -59,7 +59,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -92,7 +92,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -108,7 +108,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -124,7 +124,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -140,7 +140,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -156,7 +156,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -172,7 +172,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -192,7 +192,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -238,7 +238,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -260,7 +260,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level, job_tags=None, **assemble_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level, job_tags=None, **assemble_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -285,7 +285,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -301,7 +301,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -317,7 +317,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -337,7 +337,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.md index d3a64bd8d3b..da29bf4a0c6 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") Results managed by the Job Manager. @@ -42,7 +42,7 @@ Whether all experiments were successful. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -74,7 +74,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -99,7 +99,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -124,7 +124,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -150,7 +150,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.seconds_to_duration.md index d6d9cf88944..02f6a77e75d 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.to_python_identifier.md index 6f4f7202018..ff98a1ed981 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.update_qobj_config.md index ff5b621ee1d..a2726da8eb8 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.utc_to_local.md index f96a3e19545..c04ef9a56ca 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.validate_job_tags.md index 4918ee24c9a..ed2afcd85c3 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.19/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.7/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.md index e194c440acb..36dcd64cbb9 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Backwards compat shim representing an abstract backend configuration. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.md index f54187e4ab6..3da10da8736 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Class representing backend properties @@ -34,7 +34,7 @@ Initialize a BackendProperties instance. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -54,7 +54,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Create a new Gate object from a dictionary. @@ -76,7 +76,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -97,7 +97,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -118,7 +118,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -144,7 +144,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -169,7 +169,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -189,7 +189,7 @@ Readout error of the given qubit, -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -209,7 +209,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -229,7 +229,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.md index ea779eaadd7..b9fcb1a8db5 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendstatus.py "view source code") Class representing Backend Status. @@ -42,7 +42,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -62,7 +62,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.Command.md b/docs/api/qiskit/0.19/qiskit.providers.models.Command.md index 0846e8bd9a2..5bc1142b869 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") Class representing a Command. @@ -35,7 +35,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -57,7 +57,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.md index 419a36c6358..42ef618db01 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Gate Configuration @@ -50,7 +50,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -70,7 +70,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.md index bfd02cb7919..76a20ab1c40 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/jobstatus.py "view source code") Model for JobStatus. @@ -50,7 +50,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -72,7 +72,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md index 1cca7a4cc3b..0ad3d2fbec4 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. @@ -84,7 +84,7 @@ Sample rate of the signal channels in Hz (1/dt). -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -104,7 +104,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -129,7 +129,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -167,7 +167,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -187,7 +187,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -207,7 +207,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -227,7 +227,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -247,7 +247,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -267,7 +267,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.md index c71cfa86126..8419ccaccaa 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. @@ -47,7 +47,7 @@ Qubit frequencies in Hertz. -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -67,7 +67,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.md index 93618144ee6..da17853eb58 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Qasm Backend Configuration. @@ -122,7 +122,7 @@ In future, n\_qubits should be replaced in favor of num\_qubits for consistent u -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -142,7 +142,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.md index 1909fbdc3d2..3db3d408abf 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a U Channel LO @@ -43,7 +43,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -63,7 +63,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md index de0d6c8bb62..6d5f6c13170 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: @@ -274,7 +274,7 @@ Occupied time slots by this instruction. -`Acquire.__call__(channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.__call__(channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") Return new `Acquire` that is fully instantiated with its channels. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.md index 1a2006f4118..236e287b4be 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Constant.md b/docs/api/qiskit/0.19/qiskit.pulse.Constant.md index 05da91991d5..c535ec89188 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: @@ -105,7 +105,7 @@ matplotlib.figure -`Constant.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Constant.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -117,7 +117,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.md index 6b01917b5fc..ae5f7e0137e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Delay.md b/docs/api/qiskit/0.19/qiskit.pulse.Delay.md index ffd843973a9..4dbf5a42860 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. @@ -176,7 +176,7 @@ Occupied time slots by this instruction. -`Delay.__call__(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") +`Delay.__call__(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") Return new `Delay` that is fully instantiated with both `duration` and a `channel`. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Drag.md b/docs/api/qiskit/0.19/qiskit.pulse.Drag.md index 41589cfd07f..950df090a5d 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. @@ -143,7 +143,7 @@ matplotlib.figure -`Drag.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Drag.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.md index d01890601cf..9badb66b2da 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md index d7b575df79f..796a51c10a4 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): @@ -117,7 +117,7 @@ matplotlib.figure -`Gaussian.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Gaussian.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -129,7 +129,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md index e00bbfeff56..cc879801dcb 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: @@ -130,7 +130,7 @@ matplotlib.figure -`GaussianSquare.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`GaussianSquare.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -142,7 +142,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md index b0ca2445f4a..dacfbc79c15 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration, channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration, channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -155,7 +155,7 @@ Occupied time slots by this instruction. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -172,7 +172,7 @@ Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `s -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -188,7 +188,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -204,7 +204,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -220,7 +220,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -253,7 +253,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -265,7 +265,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -283,7 +283,7 @@ Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `s -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. @@ -300,7 +300,7 @@ Return a new schedule shifted forward by time. -`Instruction.union(*schedules, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.union(*schedules, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule which is the union of self and schedule. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.md index 101269754bf..6fcc875bbcc 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: @@ -50,7 +50,7 @@ The names of all the circuit instructions which have Schedule definitions in thi -`InstructionScheduleMap.add(instruction, qubits, schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -72,7 +72,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -93,7 +93,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") for the given instruction on the given qubits. @@ -116,7 +116,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -137,7 +137,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -158,7 +158,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined `Schedule` for the given instruction on the given qubits. @@ -181,7 +181,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -203,7 +203,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -227,7 +227,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.md index 75eb932ad82..c8a37909838 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.md index 657251d654d..9d6343a08f5 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Play.md b/docs/api/qiskit/0.19/qiskit.pulse.Play.md index a467f1ff48b..527f7e1f763 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.19/qiskit.pulse.PulseError.md index 3513313c0a7..ee01d5abead 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.md index 2a4a897c1ee..0b1d8f0d889 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md index 396563cfe0b..59262a979cb 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SamplePulse -`SamplePulse(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") +`SamplePulse(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. @@ -54,7 +54,7 @@ Return sample values. -`SamplePulse.__call__(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") +`SamplePulse.__call__(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") Call self as a function. @@ -62,7 +62,7 @@ Call self as a function. -`SamplePulse.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, interactive=False, scaling=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") +`SamplePulse.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, interactive=False, scaling=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") Plot the interpolated envelope of pulse. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md index 7ad154c2b11..93f7345dac1 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -121,7 +121,7 @@ Time keeping attribute. -`Schedule.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -143,7 +143,7 @@ $$ -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -159,7 +159,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -175,7 +175,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -191,7 +191,7 @@ Return maximum start time over supplied channels. -`Schedule.draw(dt=1, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None, show_framechange_channels=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.draw(dt=1, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None, show_framechange_channels=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Plot the schedule. @@ -237,7 +237,7 @@ matplotlib.Figure -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a Schedule with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of `self.filter`, so that: @@ -261,7 +261,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -283,7 +283,7 @@ If no arguments are provided, `self` is returned. -`Schedule.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a new schedule which is the flattened schedule contained all `instructions`. @@ -295,7 +295,7 @@ Return a new schedule which is the flattened schedule contained all `instruction -`Schedule.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -313,7 +313,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a new schedule shifted forward by `time`. @@ -330,7 +330,7 @@ Return a new schedule shifted forward by `time`. -`Schedule.union(*schedules, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") +`Schedule.union(*schedules, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/schedule.py "view source code") Return a new schedule which is the union of both `self` and `schedules`. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md index 65c0c8d627f..ba2f9e0ef6e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This command operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md index b557ccfc886..fac6ba11767 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. @@ -184,7 +184,7 @@ Occupied time slots by this instruction. -`ShiftPhase.__call__(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.__call__(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") Return a new ShiftPhase instruction supporting the deprecated syntax of FrameChange. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md index 0a31da5de0b..e17c054ef96 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. @@ -186,7 +186,7 @@ Type of snapshot. -`Snapshot.__call__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.__call__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") Deprecated. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.channels.md b/docs/api/qiskit/0.19/qiskit.pulse.channels.md index ed9a2cf322e..ea1eb983882 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.channels.md @@ -32,7 +32,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. @@ -68,7 +68,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -112,7 +112,7 @@ A shorthand string prefix for characterizing the channel type. -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. @@ -148,7 +148,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. @@ -184,7 +184,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. @@ -220,7 +220,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. @@ -256,7 +256,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`PulseChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`PulseChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Base class of transmit Channels. Pulses can be played on these channels. @@ -292,7 +292,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). @@ -328,7 +328,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`SnapshotChannel`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") +`SnapshotChannel` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/channels.py "view source code") Snapshot channels are used to specify commands for simulators. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md index 2066d6c9f46..1e44568bb5e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: @@ -274,7 +274,7 @@ Occupied time slots by this instruction. -`Acquire.__call__(channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.__call__(channel=None, mem_slot=None, reg_slots=None, mem_slots=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/acquire.py "view source code") Return new `Acquire` that is fully instantiated with its channels. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md index c03ee4efaa1..43b35cbc575 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. @@ -176,7 +176,7 @@ Occupied time slots by this instruction. -`Delay.__call__(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") +`Delay.__call__(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/delay.py "view source code") Return new `Delay` that is fully instantiated with both `duration` and a `channel`. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md index d3b5168c70c..7139a32e49a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration, channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration, channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -155,7 +155,7 @@ Occupied time slots by this instruction. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -172,7 +172,7 @@ Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `s -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -188,7 +188,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -204,7 +204,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -220,7 +220,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -253,7 +253,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -265,7 +265,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -283,7 +283,7 @@ Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `s -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. @@ -300,7 +300,7 @@ Return a new schedule shifted forward by time. -`Instruction.union(*schedules, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.union(*schedules, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule which is the union of self and schedule. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md index e40097e467a..4a65156667a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md index 2b4ee4663f6..393dc98c9aa 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This command operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md index c4ebe68abe8..932e8161c84 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. @@ -184,7 +184,7 @@ Occupied time slots by this instruction. -`ShiftPhase.__call__(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.__call__(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") Return a new ShiftPhase instruction supporting the deprecated syntax of FrameChange. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md index 10aca1bf850..ae2b2357257 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. @@ -186,7 +186,7 @@ Type of snapshot. -`Snapshot.__call__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.__call__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/snapshot.py "view source code") Deprecated. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md index b51ed22acfd..f4ccd8e19d9 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.pulse_lib.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: @@ -105,7 +105,7 @@ matplotlib.figure -`Constant.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Constant.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -117,7 +117,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md index 5210b53bf75..1baf93c3f1d 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.pulse_lib.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. @@ -143,7 +143,7 @@ matplotlib.figure -`Drag.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Drag.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md index e1b6f55f50b..a530fdbb58d 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.pulse_lib.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): @@ -117,7 +117,7 @@ matplotlib.figure -`Gaussian.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Gaussian.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -129,7 +129,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md index 491a0e25ef6..3893b4b244a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.pulse_lib.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: @@ -130,7 +130,7 @@ matplotlib.figure -`GaussianSquare.get_sample_pulse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`GaussianSquare.get_sample_pulse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Return a SamplePulse with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -142,7 +142,7 @@ Return a SamplePulse with samples filled according to the formula that the pulse -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md index c08933929a6..ff6c097bd18 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.pulse_lib.SamplePulse -`SamplePulse(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") +`SamplePulse(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. @@ -54,7 +54,7 @@ Return sample values. -`SamplePulse.__call__(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") +`SamplePulse.__call__(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") Call self as a function. @@ -62,7 +62,7 @@ Call self as a function. -`SamplePulse.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, interactive=False, scaling=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") +`SamplePulse.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, interactive=False, scaling=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/sample_pulse.py "view source code") Plot the interpolated envelope of pulse. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md index 60b73b8b726..2b5241573f7 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md @@ -34,7 +34,7 @@ Note the sampling strategy use for all discrete pulses is midpoint. -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates constant-sampled [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -58,7 +58,7 @@ $$ -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates cosine wave [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -84,7 +84,7 @@ $$ -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates Y-only correction DRAG [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse") for standard nonlinear oscillator (SNO) \[1]. @@ -119,7 +119,7 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates unnormalized gaussian [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -157,7 +157,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates unnormalized gaussian derivative [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -184,7 +184,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates gaussian square [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -224,7 +224,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`sawtooth(duration, amp, freq=None, period=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, period=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates sawtooth wave [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -271,7 +271,7 @@ plt.plot(range(duration), sawtooth_wave) -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates unnormalized sech [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -307,7 +307,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates unnormalized sech derivative [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -334,7 +334,7 @@ i.e. the derivative of $\text{sech}$. -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates sine wave [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -360,7 +360,7 @@ $$ -`square(duration, amp, freq=None, period=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`square(duration, amp, freq=None, period=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates square wave [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -389,7 +389,7 @@ with the convention $\text{sign}(0) = 1$. -`triangle(duration, amp, freq=None, period=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`triangle(duration, amp, freq=None, period=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates triangle wave [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). @@ -436,7 +436,7 @@ plt.plot(range(duration), triangle_wave) -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/pulse_lib/discrete.py "view source code") Generates zero-sampled [`SamplePulse`](qiskit.pulse.SamplePulse "qiskit.pulse.SamplePulse"). diff --git a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.add_implicit_acquires.md b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.add_implicit_acquires.md index ac84265c1d2..21139f11f67 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.add_implicit_acquires.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.reschedule.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/reschedule.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/reschedule.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.align_measures.md b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.align_measures.md index 6ea1b8c88a5..c2c7eb0d8d8 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.align_measures.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.reschedule.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/reschedule.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/reschedule.py "view source code") Return new schedules where measurements occur at the same physical time. Minimum measurement wait time (to allow for calibration pulses) is enforced. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md index e61c85b7a7f..b4f62014e04 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.reschedule.pad -`pad(schedule, channels=None, until=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/reschedule.py "view source code") +`pad(schedule, channels=None, until=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/reschedule.py "view source code") Pad the input `Schedule` with `Delay` s on all unoccupied timeslots until `until` if it is provided, otherwise until `schedule.duration`. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.md index af00b7d202b..ed1af209c3b 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.19/qiskit.qasm.Qasm.md index 026df0391b6..2f8e539962b 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.19/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. @@ -22,7 +22,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -30,7 +30,7 @@ Returns a generator of the tokens. -`Qasm.get_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") +`Qasm.get_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") Deprecated. Use generate\_tokens(). @@ -38,7 +38,7 @@ Deprecated. Use generate\_tokens(). -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -46,7 +46,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.19/qiskit.qasm.QasmError.md index 32a73d17165..cc2d08282a4 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.md index e8565e26620..dfa6fa92722 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.md index 6a3592e34de..22bb39095a5 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.md index de02e94bebd..16131b0dcf3 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") An item in a pulse library. @@ -27,7 +27,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -47,7 +47,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.md index 409c9da58d5..4187a9885dc 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj. @@ -31,7 +31,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -51,7 +51,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.md index 761e5525f3f..ae653cf735f 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") A configuration for a Pulse Qobj. @@ -37,7 +37,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -57,7 +57,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.md index 58aaa0104ae..df9b4cf50c5 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj Experiment. @@ -30,7 +30,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -50,7 +50,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.md index a3dad1df5c8..e605cc5a058 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") A config for a single Pulse experiment in the qobj. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.md index 3fd48b3e755..94d18c4a566 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") A class representing a single instruction in an PulseQobj Experiment. @@ -42,7 +42,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.md index cb1a98a151c..261721f10f3 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj. @@ -31,7 +31,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -51,7 +51,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.md index 279c6f5f674..0b544ae11e9 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, memory_slots=None, n_qubits=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, memory_slots=None, n_qubits=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") A configuration for a QASM Qobj. @@ -33,7 +33,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -53,7 +53,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.md index c3b95c0455f..b4bc81dca5f 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj Experiment. @@ -30,7 +30,7 @@ Instatiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -50,7 +50,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.md index 1bb861a854d..d3878e545f2 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Configuration for a single QASM experiment in the qobj. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.md index a56e7e69713..89902c8882c 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") A class representing a single instruction in an QasmQobj Experiment. @@ -37,7 +37,7 @@ Instatiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -57,7 +57,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.19/qiskit.qobj.Qobj.md index 12ddb574631..b2c826ff6d6 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/__init__.py "view source code") A backwards compat alias for QasmQobj. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.md index 0fd24d69de0..3ba46fded7b 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") A class representing a header dictionary for a Qobj Experiment. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.md index efa9333315d..7dc8d1c5fec 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/qasm_qobj.py "view source code") A class used to represent a dictionary header in Qobj objects. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.md index 8deb7bb3fd1..13fd209ba84 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") An individual measurement option. @@ -27,7 +27,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -47,7 +47,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.19/qiskit.qobj.validate_qobj_against_schema.md b/docs/api/qiskit/0.19/qiskit.qobj.validate_qobj_against_schema.md index 30b8838a8a8..e6a07a7e794 100644 --- a/docs/api/qiskit/0.19/qiskit.qobj.validate_qobj_against_schema.md +++ b/docs/api/qiskit/0.19/qiskit.qobj.validate_qobj_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.validate_qobj_against_schema -`validate_qobj_against_schema(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/utils.py "view source code") +`validate_qobj_against_schema(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/qobj/utils.py "view source code") Validates a QObj against the .json schema. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.md index 051654a091f..83116a295c8 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") Pauli basis Chi-matrix representation of a quantum channel. @@ -120,7 +120,7 @@ Return the adjoint of the operator. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the composed quantum channel self @ other. @@ -150,7 +150,7 @@ Composition (`@`) is defined as left matrix multiplication for [`SuperOp`](qiski -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate of the QuantumChannel. @@ -191,7 +191,7 @@ BaseOperator -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product channel other ⊗ self. @@ -289,7 +289,7 @@ Return tuple of output dimension for specified subsystems. -`Chi.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") The matrix power of the channel. @@ -381,7 +381,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product channel self ⊗ other. @@ -435,7 +435,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose of the QuantumChannel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.md index 1e92e0e227d..6021f99542f 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") Choi-matrix representation of a Quantum Channel. @@ -128,7 +128,7 @@ Return the adjoint of the operator. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the composed quantum channel self @ other. @@ -158,7 +158,7 @@ Composition (`@`) is defined as left matrix multiplication for [`SuperOp`](qiski -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate of the QuantumChannel. @@ -199,7 +199,7 @@ BaseOperator -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product channel other ⊗ self. @@ -297,7 +297,7 @@ Return tuple of output dimension for specified subsystems. -`Choi.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") The matrix power of the channel. @@ -389,7 +389,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product channel self ⊗ other. @@ -443,7 +443,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose of the QuantumChannel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.md index ec95f8a94d9..55f731315b3 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") An N-qubit unitary operator from the Clifford group. @@ -115,7 +115,7 @@ Return a clone with qargs set -`Clifford.__getitem__(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.__getitem__(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a stabilizer Pauli row @@ -151,7 +151,7 @@ BaseOperator -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate transpose of the Clifford @@ -159,7 +159,7 @@ Return the conjugate transpose of the Clifford -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the composed operator. @@ -189,7 +189,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -205,7 +205,7 @@ Make a deep copy of current operator. -`Clifford.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the right multiplied operator self \* other. @@ -230,7 +230,7 @@ The operator self \* other. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product operator other ⊗ self. @@ -250,7 +250,7 @@ the tensor product operator other ⊗ self. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -274,7 +274,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -282,7 +282,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -340,7 +340,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -474,7 +474,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product operator self ⊗ other. @@ -494,7 +494,7 @@ the tensor product operator self ⊗ other. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -517,7 +517,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary represenation of Clifford object. @@ -525,7 +525,7 @@ Return dictionary represenation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -533,7 +533,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -541,7 +541,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -549,7 +549,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.md index bd68037f0a1..de44f2c3e6a 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") DensityMatrix class @@ -92,7 +92,7 @@ LinearOperator -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -116,7 +116,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -141,7 +141,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -165,7 +165,7 @@ the tensor product state other ⊗ self. -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -191,7 +191,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -219,7 +219,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -252,7 +252,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -308,7 +308,7 @@ QuantumState -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -406,7 +406,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -414,7 +414,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -542,7 +542,7 @@ LinearOperator -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -566,7 +566,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_counts()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_counts()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Returns the density matrix as a counts dict of probabilities. @@ -584,7 +584,7 @@ dict -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -657,7 +657,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -665,7 +665,7 @@ Convert to Operator -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.md index 1bce6916a14..5a89fab3e64 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Kraus representation of a quantum channel. @@ -126,7 +126,7 @@ Return the adjoint of the operator. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the composed quantum channel self @ other. @@ -156,7 +156,7 @@ Composition (`@`) is defined as left matrix multiplication for [`SuperOp`](qiski -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate of the QuantumChannel. @@ -172,7 +172,7 @@ Make a deep copy of current operator. -`Kraus.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the right multiplied quantum channel self \* other. @@ -197,7 +197,7 @@ The quantum channel self \* other. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product channel other ⊗ self. @@ -237,7 +237,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -295,7 +295,7 @@ Return tuple of output dimension for specified subsystems. -`Kraus.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") The matrix power of the channel. @@ -387,7 +387,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product channel self ⊗ other. @@ -441,7 +441,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose of the QuantumChannel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.md index f398b859fca..84e4d369ab5 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") A class for decomposing 1-qubit unitaries into Euler angle rotations. @@ -49,7 +49,7 @@ The decomposition basis. -`OneQubitEulerDecomposer.__call__(unitary, simplify=True, atol=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.__call__(unitary, simplify=True, atol=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Decompose single qubit gate into a circuit. @@ -75,7 +75,7 @@ the decomposed single-qubit gate circuit -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -95,7 +95,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.md index 008883c9b68..b47a1fbfe0c 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Matrix operator class @@ -118,7 +118,7 @@ Return the adjoint of the operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the composed operator. @@ -148,7 +148,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the operator. @@ -164,7 +164,7 @@ Make a deep copy of current operator. -`Operator.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the right multiplied operator self \* other. @@ -189,7 +189,7 @@ The operator self \* other. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -211,7 +211,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product operator other ⊗ self. @@ -235,7 +235,7 @@ the tensor product operator other ⊗ self. -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -271,7 +271,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -313,7 +313,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -405,7 +405,7 @@ BaseOperator -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product operator self ⊗ other. @@ -429,7 +429,7 @@ the tensor product operator self ⊗ other. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -437,7 +437,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -445,7 +445,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the operator. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.md index 18ccf39f396..868f91c9a43 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") Pauli Transfer Matrix (PTM) representation of a Quantum Channel. @@ -128,7 +128,7 @@ Return the adjoint of the operator. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the composed quantum channel self @ other. @@ -158,7 +158,7 @@ Composition (`@`) is defined as left matrix multiplication for [`SuperOp`](qiski -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate of the QuantumChannel. @@ -199,7 +199,7 @@ BaseOperator -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product channel other ⊗ self. @@ -297,7 +297,7 @@ Return tuple of output dimension for specified subsystems. -`PTM.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") The matrix power of the channel. @@ -389,7 +389,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product channel self ⊗ other. @@ -443,7 +443,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose of the QuantumChannel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.md index 77db9d1df19..e576c67148d 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(z=None, x=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli(z=None, x=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") A simple class representing Pauli Operators. @@ -66,7 +66,7 @@ Getter of z. -`Pauli.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Return number of qubits. @@ -74,7 +74,7 @@ Return number of qubits. -`Pauli.__mul__(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.__mul__(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Multiply two Paulis. @@ -94,7 +94,7 @@ the multiplied pauli. -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Append pauli at the end. @@ -115,7 +115,7 @@ self -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Delete pauli at the indices. @@ -135,7 +135,7 @@ self -`classmethod Pauli.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`classmethod Pauli.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Take pauli string to construct pauli. @@ -161,7 +161,7 @@ the constructed pauli -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Insert or append pauli to the targeted indices. @@ -193,7 +193,7 @@ self -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Kronecker product of two paulis. @@ -215,7 +215,7 @@ self -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -237,7 +237,7 @@ single qubit pauli -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Return a random Pauli on number of qubits. @@ -258,7 +258,7 @@ the random pauli -`static Pauli.sgn_prod(p1, p2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`static Pauli.sgn_prod(p1, p2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Multiply two Paulis and track the phase. @@ -281,7 +281,7 @@ the multiplied pauli complex: the sign of the multiplication, 1, -1, 1j or -1j -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -289,7 +289,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Present the pauli labels in I, X, Y, Z format. @@ -307,7 +307,7 @@ str -`Pauli.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Convert Pauli to a matrix representation. @@ -325,7 +325,7 @@ numpy.array -`Pauli.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Convert to Operator object. @@ -333,7 +333,7 @@ Convert to Operator object. -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Convert Pauli to a sparse matrix representation (CSR format). @@ -351,7 +351,7 @@ scipy.sparse.csr\_matrix -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Update partial or entire x. @@ -376,7 +376,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Update partial or entire z. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.md index e8e781e1865..bbd6d91a753 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Symplectic representation of a list Pauli matrices. @@ -137,7 +137,7 @@ Return a clone with qargs set -`PauliTable.__getitem__(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.__getitem__(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a view of the PauliTable. @@ -145,7 +145,7 @@ Return a view of the PauliTable. -`PauliTable.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the number of Pauli rows in the table. @@ -189,7 +189,7 @@ Return the adjoint of the operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -211,7 +211,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -233,7 +233,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -259,7 +259,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -281,7 +281,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -323,7 +323,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -339,7 +339,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -366,7 +366,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -407,7 +407,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -447,7 +447,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -480,7 +480,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -508,7 +508,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -526,7 +526,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -652,7 +652,7 @@ Set the class default relative tolerance parameter for float comparisons. -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -733,7 +733,7 @@ BaseOperator -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -773,7 +773,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -802,7 +802,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -832,7 +832,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -840,7 +840,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.md index a3b8aa3bab2..9c9014d1231 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") A class representing a Quaternion. @@ -20,7 +20,7 @@ A class representing a Quaternion. -`Quaternion.__call__(idx)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion.__call__(idx)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Call self as a function. @@ -28,13 +28,13 @@ Call self as a function. -`Quaternion.__mul__(r)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion.__mul__(r)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") ### from\_axis\_rotation -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -59,7 +59,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -80,7 +80,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Norm of quaternion. @@ -88,7 +88,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -108,7 +108,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -124,7 +124,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.md index a8fe58f48f9..15602777a04 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Scalar identity operator class. @@ -103,7 +103,7 @@ Return the adjoint of the operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the composed operator. @@ -133,7 +133,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the operator. @@ -174,7 +174,7 @@ BaseOperator -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product operator other ⊗ self. @@ -202,7 +202,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -244,7 +244,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -336,7 +336,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product operator self ⊗ other. @@ -356,7 +356,7 @@ if other is an ScalarOp. BaseOperator: if other is not an ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -364,7 +364,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -372,7 +372,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the operator. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.md index 12e6feafee6..7796a3edc3b 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sparse N-qubit operator in a Pauli basis representation. @@ -79,7 +79,7 @@ Return a clone with qargs set -`SparsePauliOp.__getitem__(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.__getitem__(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a view of the SparsePauliOp. @@ -87,7 +87,7 @@ Return a view of the SparsePauliOp. -`SparsePauliOp.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the size. @@ -123,7 +123,7 @@ BaseOperator -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the operator. @@ -131,7 +131,7 @@ Return the adjoint of the operator. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the composition channel self∘other. @@ -158,7 +158,7 @@ The composed operator. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the operator. @@ -174,7 +174,7 @@ Make a deep copy of current operator. -`SparsePauliOp.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the composition channel self∘other. @@ -200,7 +200,7 @@ The composed operator. -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product operator other ⊗ self. @@ -224,7 +224,7 @@ the tensor product operator other ⊗ self. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list \[(pauli\_str, coeffs)] @@ -232,7 +232,7 @@ Construct from a list \[(pauli\_str, coeffs)] -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -289,7 +289,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -307,7 +307,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -433,7 +433,7 @@ Set the class default relative tolerance parameter for float comparisons. -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliTable by combining duplicaties and removing zeros. @@ -476,7 +476,7 @@ BaseOperator -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product operator self ⊗ other. @@ -500,7 +500,7 @@ the tensor product operator self ⊗ other. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -522,7 +522,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -542,7 +542,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -550,7 +550,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the operator. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.md index 6ca0188ee6b..e6bd9203bac 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Symplectic representation of a list Stabilizer matrices. @@ -156,7 +156,7 @@ Return a clone with qargs set -`StabilizerTable.__getitem__(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.__getitem__(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a view of StabilizerTable @@ -230,7 +230,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -302,7 +302,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -363,7 +363,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -371,7 +371,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -398,7 +398,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -448,7 +448,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -488,7 +488,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -533,7 +533,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -561,7 +561,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -579,7 +579,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -705,7 +705,7 @@ Set the class default relative tolerance parameter for float comparisons. -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -788,7 +788,7 @@ BaseOperator -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -828,7 +828,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -861,7 +861,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -903,7 +903,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.md index 52c9131750c..fbab1eda513 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Statevector class @@ -92,7 +92,7 @@ LinearOperator -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -116,7 +116,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return True if statevectors are equivalent up to global phase. @@ -138,7 +138,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -163,7 +163,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -187,7 +187,7 @@ the tensor product state other ⊗ self. -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -213,7 +213,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -241,7 +241,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -274,7 +274,7 @@ The N-qubit basis state density matrix. -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -330,7 +330,7 @@ QuantumState -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -428,7 +428,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -436,7 +436,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -564,7 +564,7 @@ LinearOperator -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -588,7 +588,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_counts()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_counts()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Returns the statevector as a counts dict of probabilities. @@ -606,7 +606,7 @@ dict -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -677,7 +677,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -685,7 +685,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.md index b2fd5e54cea..241de64d7f4 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Stinespring representation of a quantum channel. @@ -126,7 +126,7 @@ Return the adjoint of the operator. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the composed quantum channel self @ other. @@ -156,7 +156,7 @@ Composition (`@`) is defined as left matrix multiplication for [`SuperOp`](qiski -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate of the QuantumChannel. @@ -172,7 +172,7 @@ Make a deep copy of current operator. -`Stinespring.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the right multiplied quantum channel self \* other. @@ -197,7 +197,7 @@ The quantum channel self \* other. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product channel other ⊗ self. @@ -237,7 +237,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -295,7 +295,7 @@ Return tuple of output dimension for specified subsystems. -`Stinespring.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") The matrix power of the channel. @@ -387,7 +387,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product channel self ⊗ other. @@ -441,7 +441,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose of the QuantumChannel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.md index af30cf1acfc..c1fd02a54bf 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Superoperator representation of a quantum channel. @@ -120,7 +120,7 @@ Return the adjoint of the operator. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the composed quantum channel self @ other. @@ -150,7 +150,7 @@ Composition (`@`) is defined as left matrix multiplication for [`SuperOp`](qiski -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate of the QuantumChannel. @@ -191,7 +191,7 @@ BaseOperator -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product channel other ⊗ self. @@ -289,7 +289,7 @@ Return tuple of output dimension for specified subsystems. -`SuperOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the compose of a QuantumChannel with itself n times. @@ -381,7 +381,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product channel self ⊗ other. @@ -435,7 +435,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose of the QuantumChannel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 687c66bc3ad..6b5ce8096b5 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. @@ -20,7 +20,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`TwoQubitBasisDecomposer.__call__(target, basis_fidelity=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.__call__(target, basis_fidelity=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose a two-qubit unitary over fixed basis + SU(2) using the best approximation given that each basis application has a finite fidelity. @@ -28,7 +28,7 @@ Decompose a two-qubit unitary over fixed basis + SU(2) using the best approximat -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -36,7 +36,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -50,7 +50,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -66,7 +66,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -74,7 +74,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -82,7 +82,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.19/qiskit.quantum_info.average_gate_fidelity.md index 6e434252cf1..584e87bdcb2 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.19/qiskit.quantum_info.concurrence.md index c91b7f603df..0e43fac7e36 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.19/qiskit.quantum_info.diamond_norm.md index 6acb7cbbc38..a8724ad9cef 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.19/qiskit.quantum_info.entanglement_of_formation.md index fb8d7c09b58..04cf2009aaa 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.19/qiskit.quantum_info.entropy.md index 2bdbca69fd9..3c1e3c5ca32 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.euler_angles_1q.md b/docs/api/qiskit/0.19/qiskit.quantum_info.euler_angles_1q.md index ffff892abb9..7d9dc520ab7 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.euler_angles_1q.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.euler_angles_1q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.euler_angles_1q -`euler_angles_1q(unitary_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`euler_angles_1q(unitary_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") DEPRECATED: Compute Euler angles for a single-qubit gate. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.19/qiskit.quantum_info.gate_error.md index 02967e95dc3..422a3f516b4 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.19/qiskit.quantum_info.hellinger_fidelity.md index dfb06031b58..407c3ec649f 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.19/qiskit.quantum_info.mutual_information.md index c1deeaab1e9..4a43532e643 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.19/qiskit.quantum_info.partial_trace.md index 12d8827089f..a4f595544e6 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_basis.md index eee5774a28a..1a7edfd74aa 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_group.md index 331663d160a..f18efc9462e 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/pauli.py "view source code") Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.19/qiskit.quantum_info.process_fidelity.md index 95c5d19cce5..679c64d511c 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=False, require_cptp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=False, require_cptp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.19/qiskit.quantum_info.purity.md index 97c3688eee5..df9169c52b8 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_clifford.md index e8925b73bcb..2f6725a3aeb 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_density_matrix.md index 9e6496438c2..52724d6e07b 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_hermitian.md index da05f23c54b..18c654d1872 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_pauli_table.md index 9fd260eb6af..0a52f7f4402 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_quantum_channel.md index 4f64f799072..4fdebd029de 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_stabilizer_table.md index 6939967c849..6d16dc963e2 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_state.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_state.md index 88552593542..6e7ab54d0e0 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_state.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_state -`random_state(dim, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/random.py "view source code") +`random_state(dim, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/random.py "view source code") DEPRECATED Return a random quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_statevector.md index 2adcee38d0b..2b0885f2741 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.19/qiskit.quantum_info.random_unitary.md index 3d9ccbde9c9..6e804316d52 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.19/qiskit.quantum_info.shannon_entropy.md index 39a5b4c1541..187526278d8 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.19/qiskit.quantum_info.state_fidelity.md index afa326743f9..6a8c8f7bfb9 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.19/qiskit.result.Result.md b/docs/api/qiskit/0.19/qiskit.result.Result.md index 462337bd590..db444f2514d 100644 --- a/docs/api/qiskit/0.19/qiskit.result.Result.md +++ b/docs/api/qiskit/0.19/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") Model for Results. @@ -102,7 +102,7 @@ BaseModel initializer. -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -146,7 +146,7 @@ Note that this method requires that the model is bound with `@bind_schema`. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -172,7 +172,7 @@ dict\[str -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -206,7 +206,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -231,7 +231,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/result.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.19/qiskit.result.ResultError.md b/docs/api/qiskit/0.19/qiskit.result.ResultError.md index cbbab6c35c1..64d5aefb75d 100644 --- a/docs/api/qiskit/0.19/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.19/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.md index ed3f6283783..32367a5bffa 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.19/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md index a001df671e4..e0e766a94d3 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md @@ -56,7 +56,7 @@ Alias for field number 0 -`as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/methods/basic.py "view source code") +`as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. @@ -81,7 +81,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as late as -`as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/methods/basic.py "view source code") +`as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -104,7 +104,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`translate_gates_to_pulse_defs(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/methods/basic.py "view source code") +`translate_gates_to_pulse_defs(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/methods/basic.py "view source code") Return a list of Schedules and the qubits they operate on, for each element encountered in th input circuit. diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.19/qiskit.scheduler.schedule_circuit.md index 11f2006f231..fd97ad65b19 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.19/qiskit.scheduler.schedule_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.schedule_circuit -`schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/schedule_circuit.py "view source code") +`schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.utils.md b/docs/api/qiskit/0.19/qiskit.scheduler.utils.md index 1d9b05e8c30..7ff5f74b1d2 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.utils.md +++ b/docs/api/qiskit/0.19/qiskit.scheduler.utils.md @@ -22,7 +22,7 @@ Scheduling utility functions. -`format_meas_map(meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/utils.py "view source code") +`format_meas_map(meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/utils.py "view source code") Return a mapping from qubit label to measurement group given the nested list meas\_map returned by a backend configuration. (Qubits can not always be measured independently.) Sorts the measurement group for consistency. @@ -42,7 +42,7 @@ Measure map in map format -`measure(qubits, backend=None, inst_map=None, meas_map=None, qubit_mem_slots=None, measure_name='measure')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/utils.py "view source code") +`measure(qubits, backend=None, inst_map=None, meas_map=None, qubit_mem_slots=None, measure_name='measure')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/utils.py "view source code") Return a schedule which measures the requested qubits according to the given instruction mapping and measure map, or by using the defaults provided by the backend. @@ -73,7 +73,7 @@ A measurement schedule corresponding to the inputs provided. -`measure_all(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/utils.py "view source code") +`measure_all(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/scheduler/utils.py "view source code") Return a Schedule which measures all qubits of the given backend. diff --git a/docs/api/qiskit/0.19/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.19/qiskit.tools.backend_monitor.md index 3f498374d95..d695f58cf95 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.19/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.19/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.19/qiskit.tools.backend_overview.md index b3a1d73db28..cd1fc5bed54 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.19/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.19/qiskit.tools.choi_to_pauli.md b/docs/api/qiskit/0.19/qiskit.tools.choi_to_pauli.md index d3cdfc87ad7..9394565f484 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.choi_to_pauli.md +++ b/docs/api/qiskit/0.19/qiskit.tools.choi_to_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.choi_to_pauli -`choi_to_pauli(choi, order=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`choi_to_pauli(choi, order=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Convert a Choi-matrix to a Pauli-basis superoperator. diff --git a/docs/api/qiskit/0.19/qiskit.tools.chop.md b/docs/api/qiskit/0.19/qiskit.tools.chop.md index 99388de2948..3ef7ecb6d58 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.chop.md +++ b/docs/api/qiskit/0.19/qiskit.tools.chop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.chop -`chop(array, epsilon=1e-10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`chop(array, epsilon=1e-10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Truncate small values of a complex array. diff --git a/docs/api/qiskit/0.19/qiskit.tools.concurrence.md b/docs/api/qiskit/0.19/qiskit.tools.concurrence.md index 72f4c332f0b..53c8742e562 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.concurrence.md +++ b/docs/api/qiskit/0.19/qiskit.tools.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Calculate the concurrence. diff --git a/docs/api/qiskit/0.19/qiskit.tools.devectorize.md b/docs/api/qiskit/0.19/qiskit.tools.devectorize.md index a1af344598e..614e62888dc 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.devectorize.md +++ b/docs/api/qiskit/0.19/qiskit.tools.devectorize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.devectorize -`devectorize(vectorized_mat, method='col')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`devectorize(vectorized_mat, method='col')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Devectorize a vectorized square matrix. diff --git a/docs/api/qiskit/0.19/qiskit.tools.entanglement_of_formation.md b/docs/api/qiskit/0.19/qiskit.tools.entanglement_of_formation.md index c461fcb4c35..57208b88d51 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.entanglement_of_formation.md +++ b/docs/api/qiskit/0.19/qiskit.tools.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.entanglement_of_formation -`entanglement_of_formation(state, d0, d1=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`entanglement_of_formation(state, d0, d1=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Compute the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.tools.entropy.md b/docs/api/qiskit/0.19/qiskit.tools.entropy.md index cd71e814fe1..1011075a0c0 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.entropy.md +++ b/docs/api/qiskit/0.19/qiskit.tools.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.entropy -`entropy(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`entropy(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Compute the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.tools.is_pos_def.md b/docs/api/qiskit/0.19/qiskit.tools.is_pos_def.md index d84db3fe87f..347def85260 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.is_pos_def.md +++ b/docs/api/qiskit/0.19/qiskit.tools.is_pos_def.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.is_pos_def -`is_pos_def(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`is_pos_def(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Return is\_pos\_def. diff --git a/docs/api/qiskit/0.19/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.19/qiskit.tools.job_monitor.md index e52639e2eed..2cfb8cbcf30 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.19/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.19/qiskit.tools.mutual_information.md b/docs/api/qiskit/0.19/qiskit.tools.mutual_information.md index f3a6474502c..0703ada5946 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.mutual_information.md +++ b/docs/api/qiskit/0.19/qiskit.tools.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.mutual_information -`mutual_information(state, d0, d1=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`mutual_information(state, d0, d1=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Compute the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.19/qiskit.tools.outer.md b/docs/api/qiskit/0.19/qiskit.tools.outer.md index b800de6cbb1..cf8c145cbd1 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.outer.md +++ b/docs/api/qiskit/0.19/qiskit.tools.outer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.outer -`outer(vector1, vector2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`outer(vector1, vector2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Construct the outer product of two vectors. diff --git a/docs/api/qiskit/0.19/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.19/qiskit.tools.parallel_map.md index d77f09906b8..f1579c94c71 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.19/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.19/qiskit.tools.partial_trace.md b/docs/api/qiskit/0.19/qiskit.tools.partial_trace.md index c1c3d989f12..16b90c1279b 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.partial_trace.md +++ b/docs/api/qiskit/0.19/qiskit.tools.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.partial_trace -`partial_trace(state, trace_systems, dimensions=None, reverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`partial_trace(state, trace_systems, dimensions=None, reverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Partial trace over subsystems of multi-partite matrix. diff --git a/docs/api/qiskit/0.19/qiskit.tools.qft.md b/docs/api/qiskit/0.19/qiskit.tools.qft.md index 9dff4868ae3..59e148248f0 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.qft.md +++ b/docs/api/qiskit/0.19/qiskit.tools.qft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.qft -`qft(circ, q, n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`qft(circ, q, n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") n-qubit QFT on q in circ. diff --git a/docs/api/qiskit/0.19/qiskit.tools.shannon_entropy.md b/docs/api/qiskit/0.19/qiskit.tools.shannon_entropy.md index 243288d5caf..78021a148ed 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.shannon_entropy.md +++ b/docs/api/qiskit/0.19/qiskit.tools.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.19/qiskit.tools.vectorize.md b/docs/api/qiskit/0.19/qiskit.tools.vectorize.md index 94ceb2e6e94..e2920bd8919 100644 --- a/docs/api/qiskit/0.19/qiskit.tools.vectorize.md +++ b/docs/api/qiskit/0.19/qiskit.tools.vectorize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.vectorize -`vectorize(density_matrix, method='col')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") +`vectorize(density_matrix, method='col')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/tools/qi/qi.py "view source code") Flatten an operator to a vector in a specified basis. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.md index 3fc6b7490a0..0f35c373c69 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Directed graph specifying fixed coupling. @@ -41,7 +41,7 @@ Returns a sorted list of physical\_qubits -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -51,7 +51,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -65,7 +65,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -112,7 +112,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -120,7 +120,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Return qubits connected on a grid of num\_rows x num\_columns. @@ -128,7 +128,7 @@ Return qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -136,7 +136,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -144,7 +144,7 @@ Return a fully connected coupling map on n qubits. -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -160,7 +160,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -170,7 +170,7 @@ Return True if connected, False otherwise -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -194,7 +194,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -219,7 +219,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -227,7 +227,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.md index de6cfcf7ad5..992346e1c1e 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/fencedobjs.py "view source code") A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.md index b0b55b0adc7..294e88e4de1 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/fencedobjs.py "view source code") A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.md index f4cef6f9195..25332914b4b 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") Base class for multiple types of working list. @@ -30,7 +30,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -43,7 +43,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -69,7 +69,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -85,7 +85,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.19/qiskit.transpiler.Layout.md index 016e2dc3bc3..28504c1fbef 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Two-ways dict to represent a Layout. @@ -22,19 +22,19 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.__getitem__(item)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.__getitem__(item)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") ### \_\_len\_\_ -`Layout.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") ### add -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -47,7 +47,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -59,7 +59,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -94,7 +94,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -102,7 +102,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -138,7 +138,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -163,7 +163,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -187,7 +187,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers in regs. @@ -207,7 +207,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -215,7 +215,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A list of Register in the layout :rtype: List @@ -223,7 +223,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -231,7 +231,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -239,7 +239,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -261,7 +261,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.md index 047ca02d472..797dbf70a7b 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") Manager for a set of Passes and their scheduling during transpilation. @@ -32,19 +32,19 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.__getitem__(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.__getitem__(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") ### \_\_len\_\_ -`PassManager.__len__()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.__len__()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") ### append -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -70,7 +70,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -98,7 +98,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -114,7 +114,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -141,7 +141,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.md index 0858c3c07d7..3e380081b8c 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, backend_properties=None, seed_transpiler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, backend_properties=None, seed_transpiler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passmanager_config.py "view source code") Pass Manager Configuration. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.md index a23fddffa82..fe3ca2ba4b2 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/propertyset.py "view source code") A default dictionary-like object diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.md index bceb5f7e233..76b36f4f26b 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.md index 48f367d9437..206aa0a4a25 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.md index 873ac147ccc..e67a8c42551 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Transform a circuit with virtual qubits into a circuit with physical qubits. @@ -44,7 +44,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 33784165820..702ba3ce7b8 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Add a barrier before final measurements. @@ -44,7 +44,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.md index 3c834c15c5c..b69b78219dc 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. @@ -50,7 +50,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.md index 5da71ed4c74..3ad7932a510 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/csp_layout.py "view source code") If possible, chooses a Layout as a CSP, using backtracking. @@ -59,7 +59,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.md index 69ef8ac6b77..016e6198e1a 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Cancel back-to-back cx gates in dag. @@ -42,7 +42,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.md index 2981283f8c1..5502ecd68a1 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Rearrange the direction of the cx nodes to match the directed coupling map. @@ -56,7 +56,7 @@ Return the name of the pass. -`CXDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Run the CXDirection pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.md index 276da891931..934fd07e1f1 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Check if the CNOTs follow the right direction with respect to the coupling map. @@ -52,7 +52,7 @@ Return the name of the pass. -`CheckCXDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Run the CheckCXDirection pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.md index 6761697f98b..901972f18be 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_map.py "view source code") Check if a DAG circuit is already mapped to a coupling map. @@ -50,7 +50,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.md index 52565babcbd..32f6178b10b 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Collect sequences of uninterrupted gates acting on 2 qubits. @@ -54,7 +54,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.md index bdb8d43c791..73aa6865fbe 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Analysis pass to find commutation relations between DAG nodes. @@ -46,7 +46,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.md index 39b9067a8c6..64972cb18da 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Cancel the redundant (self-adjoint) gates through commutation relations. @@ -48,7 +48,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.md index 0302829d6ab..4b0d22876ee 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Replace each block of consecutive gates by a single Unitary node. @@ -55,7 +55,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.md index c2b433e8ec2..30a5925be2f 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Count the operations in a DAG circuit. @@ -44,7 +44,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.md index ea56a9a8fd6..1b24b7b6431 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Count the operations on the longest path in a DAGcircuit. @@ -44,7 +44,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index f18fc8f5109..63e1df63b23 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Crosstalk mitigation through adaptive instruction scheduling. @@ -62,7 +62,7 @@ If the pass is a TransformationPass, that means that the pass can manipulate the -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -70,7 +70,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -78,7 +78,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -86,7 +86,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -94,7 +94,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -102,7 +102,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barries, construct a new dag @@ -110,7 +110,7 @@ Given a set of layers and barries, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -118,7 +118,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -126,7 +126,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -134,7 +134,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -142,7 +142,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -150,7 +150,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -158,7 +158,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -166,7 +166,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -174,7 +174,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -182,7 +182,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -190,7 +190,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -198,7 +198,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -214,7 +214,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -222,7 +222,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -230,7 +230,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -238,7 +238,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -246,7 +246,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -254,7 +254,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -262,7 +262,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -270,7 +270,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -278,7 +278,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.md index 76d3ae4a3ba..3fee1729362 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Check if the DAG has reached a fixed point. @@ -44,7 +44,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.md index ec397850ef5..23ba10734dd 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Return the longest path in a DAGcircuit as a list of DAGNodes. @@ -42,7 +42,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.md index 23d9c7de7bb..35622e83ef2 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/decompose.py "view source code") Expand a gate in a circuit using its decomposition rules. @@ -48,7 +48,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.md index a5d102fc04e..392440818b9 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Choose a Layout by finding the most connected subset of qubits. @@ -55,7 +55,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.md index 66cc212c7a8..175664f7843 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/depth.py "view source code") Calculate the depth of a DAG circuit. @@ -42,7 +42,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.md index 19151f0866c..df9750f93f8 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Extend the dag with virtual qubits that are in layout but not in the circuit yet. @@ -44,7 +44,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.md index efe33376b12..24d5d1c3c74 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Check if a property reached a fixed point. @@ -50,7 +50,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.md index 2966cba5972..676307c89d2 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Allocate all idle nodes from the coupling map as ancilla on the layout. @@ -54,7 +54,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.md index e0be79ad4fc..fe4d1292346 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Evaluate how good the layout selection was. @@ -51,7 +51,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.md index d8c463e9516..f801ce5a02a 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. @@ -66,7 +66,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 47f38da941c..f366dc6b264 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Return a circuit with any adjacent barriers merged together. @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 53a04513dd5..41e45c51152 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Choose a noise-adaptive Layout based on current calibration data for the backend. @@ -92,7 +92,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.md index 2bfa79669c6..781ff935e60 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Calculate the number of tensor factors of a DAG circuit. @@ -44,7 +44,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.md index 4efe7cff08c..9685d692db4 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. @@ -40,7 +40,7 @@ If the pass is a TransformationPass, that means that the pass can manipulate the -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -62,7 +62,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -86,7 +86,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 6d1f04b1dc1..19775c4e234 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Remove diagonal gates (including diagonal 2Q gates) before a measurement. @@ -44,7 +44,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 68cf10ea995..001ea035a2f 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Remove final measurements and barriers at the end of a circuit. @@ -44,7 +44,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.md index 1177b94a100..92b13154e14 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Remove reset gate when the qubit is in zero state. @@ -42,7 +42,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.md index 3263ba0a5fc..72a5c68247d 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/set_layout.py "view source code") Set the `layout` property to the given layout. @@ -50,7 +50,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.md index 45274a28cac..49fc9146126 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/size.py "view source code") Calculate the size of a DAG circuit. @@ -44,7 +44,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.md index c0affac5e69..107d2180a82 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Map a DAGCircuit onto a coupling\_map adding swap gates. @@ -61,7 +61,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.md index 79755e29049..ba74c17f7a3 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. @@ -58,7 +58,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.md index bba57e04dc9..44b62847661 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. @@ -42,7 +42,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.md index 8cacf0f6493..b2c142f7242 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroller.py "view source code") Unroll a circuit to a given basis. @@ -50,7 +50,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.md index 367948536dd..57ed56e5fbb 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/width.py "view source code") Calculate the width of a DAG circuit. @@ -44,7 +44,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index c6bafff5606..1ffc76cd5af 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index b5c56748fba..cf3cdd489e5 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 103a2501cb9..a46646a339d 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 433a279f4b8..7d1f7582c68 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.19/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.19/qiskit.validation.BaseModel.md b/docs/api/qiskit/0.19/qiskit.validation.BaseModel.md index 3f8890c1b31..08ca0856d25 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.BaseModel.md +++ b/docs/api/qiskit/0.19/qiskit.validation.BaseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.BaseModel -`BaseModel(validate=True, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`BaseModel(validate=True, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Base class for Models for validated Qiskit classes. @@ -26,7 +26,7 @@ BaseModel initializer. -`classmethod BaseModel.from_dict(dict_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`classmethod BaseModel.from_dict(dict_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Deserialize a dict of simple types into an instance of this class. @@ -36,7 +36,7 @@ Note that this method requires that the model is bound with `@bind_schema`. -`BaseModel.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`BaseModel.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Serialize the model into a Python dict of simple types. diff --git a/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.md b/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.md index ba1a867e170..f4e8473f896 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.md +++ b/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.BaseSchema -`BaseSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`BaseSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Base class for Schemas for validated Qiskit classes. @@ -102,7 +102,7 @@ Changed in version 3.0.0rc9: Validation no longer occurs upon serialization. -`BaseSchema.dump_additional_data(valid_data, original_data, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`BaseSchema.dump_additional_data(valid_data, original_data, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Include unknown fields after dumping. @@ -254,7 +254,7 @@ Changed in version 3.0.0b7: This method returns the deserialized data rather tha -`BaseSchema.make_model(data, **_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`BaseSchema.make_model(data, **_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Make `load` return a `model_cls` instance instead of a dict. diff --git a/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.md b/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.md index c8ec2894d1a..000ade88d67 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.md +++ b/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.ModelTypeValidator -`ModelTypeValidator(*, load_default=, missing=, dump_default=, default=, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`ModelTypeValidator(*, load_default=, missing=, dump_default=, default=, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") A field able to validate the correct type of a value. @@ -62,7 +62,7 @@ Default error messages for various kinds of errors. The keys in this dictionary -`ModelTypeValidator.check_type(value, attr, data, **_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`ModelTypeValidator.check_type(value, attr, data, **_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Validates a value against the correct type of the field. @@ -139,7 +139,7 @@ Helper method to make a ValidationError with an error message from `self.error_m -`ModelTypeValidator.make_error_serialize(key, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`ModelTypeValidator.make_error_serialize(key, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Helper method to return a ValidationError from \_serialize. diff --git a/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.md b/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.md index 9ed23b93c06..1acbb91e6eb 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.md +++ b/docs/api/qiskit/0.19/qiskit.validation.ModelValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.ModelValidationError -`ModelValidationError(message, field_name=None, data=None, valid_data=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/exceptions.py "view source code") +`ModelValidationError(message, field_name=None, data=None, valid_data=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/exceptions.py "view source code") Raised when a sequence subscript is out of range. diff --git a/docs/api/qiskit/0.19/qiskit.validation.bind_schema.md b/docs/api/qiskit/0.19/qiskit.validation.bind_schema.md index 6a2d7704cea..95c81032c74 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.bind_schema.md +++ b/docs/api/qiskit/0.19/qiskit.validation.bind_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.bind_schema -`bind_schema(schema, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") +`bind_schema(schema, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/validation/base.py "view source code") Class decorator for adding schema validation to its instances. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.md index a428c08d2ac..52fc4a01a04 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.19/qiskit.visualization.circuit_drawer.md index f9205af8b9d..b5c98a52484 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=0.7, filename=None, style=None, output=None, interactive=False, line_length=None, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=0.7, filename=None, style=None, output=None, interactive=False, line_length=None, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/circuit_visualization.py "view source code") Draw a quantum circuit to different formats (set by output parameter): diff --git a/docs/api/qiskit/0.19/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.19/qiskit.visualization.dag_drawer.md index 94f184ea915..e0347b57879 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.iplot_bloch_multivector.md b/docs/api/qiskit/0.19/qiskit.visualization.iplot_bloch_multivector.md index a0e9b9b3968..60eb07cc0d0 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.iplot_bloch_multivector.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.iplot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.iplot_bloch_multivector -`iplot_bloch_multivector(rho, figsize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_blochsphere.py "view source code") +`iplot_bloch_multivector(rho, figsize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_blochsphere.py "view source code") Create a bloch sphere representation. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.iplot_histogram.md b/docs/api/qiskit/0.19/qiskit.visualization.iplot_histogram.md index 8b8a3a3e207..b7b7774747a 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.iplot_histogram.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.iplot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.iplot_histogram -`iplot_histogram(data, figsize=None, number_to_keep=None, sort='asc', legend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_histogram.py "view source code") +`iplot_histogram(data, figsize=None, number_to_keep=None, sort='asc', legend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_histogram.py "view source code") Create a histogram representation. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_city.md b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_city.md index 1f65b1e0b8f..4616e43f955 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_city.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.iplot_state_city -`iplot_state_city(rho, figsize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_cities.py "view source code") +`iplot_state_city(rho, figsize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_cities.py "view source code") Create a cities representation. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_hinton.md b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_hinton.md index ccfda972608..57c58005490 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_hinton.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.iplot_state_hinton -`iplot_state_hinton(rho, figsize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_hinton.py "view source code") +`iplot_state_hinton(rho, figsize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_hinton.py "view source code") Create a hinton representation. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_paulivec.md b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_paulivec.md index 1bbe76a8298..42cae01120d 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_paulivec.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.iplot_state_paulivec -`iplot_state_paulivec(rho, figsize=None, slider=False, show_legend=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_paulivec.py "view source code") +`iplot_state_paulivec(rho, figsize=None, slider=False, show_legend=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_paulivec.py "view source code") Create a paulivec representation. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_qsphere.md b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_qsphere.md index f8288c0c789..0d71bdd5f08 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_qsphere.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.iplot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.iplot_state_qsphere -`iplot_state_qsphere(rho, figsize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_qsphere.py "view source code") +`iplot_state_qsphere(rho, figsize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/interactive/iplot_qsphere.py "view source code") Create a Q sphere representation. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.19/qiskit.visualization.pass_manager_drawer.md index 466fdce8835..ea38e597439 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_multivector.md index f92994b9f7f..44dc30fea29 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(rho, title='', figsize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(rho, title='', figsize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_vector.md index eb8e4ab8e21..238097c7ffc 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_circuit_layout.md index d15249b8fc9..6bac7eb2446 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_error_map.md index e6118e884fc..2a8133bf615 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_gate_map.md index 01d38dbeb23..bfac368e2cc 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_histogram.md index 852d8e2dae6..446e2daabd1 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_city.md index 6ea8efe6808..971d1e55239 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(rho, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(rho, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_hinton.md index 465d0f50485..b53305b6b1c 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(rho, title='', figsize=None, ax_real=None, ax_imag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(rho, title='', figsize=None, ax_real=None, ax_imag=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_paulivec.md index e57e30d6087..9c041cdc5ea 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(rho, title='', figsize=None, color=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(rho, title='', figsize=None, color=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_qsphere.md index 0038c92af9f..0d9e9152f96 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(rho, figsize=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(rho, figsize=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md b/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md index af61545eb2b..21cd4c8deab 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md @@ -39,7 +39,7 @@ Interpolated time vector and real and imaginary part of waveform. -`interp1d(time, samples, nop, kind='linear')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/interpolation.py "view source code") +`interp1d(time, samples, nop, kind='linear')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/interpolation.py "view source code") Scipy interpolation wrapper. @@ -80,7 +80,7 @@ Interpolated time vector and real and imaginary part of waveform. -`step_wise(time, samples, nop)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/interpolation.py "view source code") +`step_wise(time, samples, nop)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/interpolation.py "view source code") Keep uniform variation between sample values. No interpolation is applied. :type time: `ndarray` :param time: Time vector with length of `samples` + 1. :type samples: `ndarray` :param samples: Complex pulse envelope. :type nop: `int` :param nop: This argument is not used. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md b/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md index 965fae45115..e580b268556 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md @@ -19,7 +19,7 @@ Style sheets for pulse visualization. -`PulseStyle(figsize=(7, 5), title_font_size=18, wave_color=None, bg_color=None, num_points=None, dpi=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/qcstyle.py "view source code") +`PulseStyle(figsize=(7, 5), title_font_size=18, wave_color=None, bg_color=None, num_points=None, dpi=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/qcstyle.py "view source code") Style sheet for Qiskit-Pulse sample pulse drawer. @@ -36,7 +36,7 @@ Create new style sheet. -`SchedStyle(figsize=(10, 12), fig_unit_h_table=0.4, use_table=True, table_columns=2, table_font_size=10, axis_font_size=18, label_font_size=10, icon_font_size=18, title_font_size=25, label_ch_linestyle='--', label_ch_color=None, label_ch_alpha=0.3, d_ch_color=None, u_ch_color=None, m_ch_color=None, s_ch_color=None, s_ch_linestyle='-', table_color=None, bg_color=None, num_points=1000, dpi=150, remove_spacing=True, max_table_ratio=0.5, vertical_span=0.2, axis_formatter=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/qcstyle.py "view source code") +`SchedStyle(figsize=(10, 12), fig_unit_h_table=0.4, use_table=True, table_columns=2, table_font_size=10, axis_font_size=18, label_font_size=10, icon_font_size=18, title_font_size=25, label_ch_linestyle='--', label_ch_color=None, label_ch_alpha=0.3, d_ch_color=None, u_ch_color=None, m_ch_color=None, s_ch_color=None, s_ch_linestyle='-', table_color=None, bg_color=None, num_points=1000, dpi=150, remove_spacing=True, max_table_ratio=0.5, vertical_span=0.2, axis_formatter=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse/qcstyle.py "view source code") Style sheet for Qiskit-Pulse schedule drawer. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md b/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md index 2d81fb388b5..d480e615eb9 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_drawer -`pulse_drawer(data, dt=1, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None, scaling=None, show_framechange_channels=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse_visualization.py "view source code") +`pulse_drawer(data, dt=1, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None, scaling=None, show_framechange_channels=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/pulse_visualization.py "view source code") Plot the interpolated envelope of pulse and schedule. diff --git a/docs/api/qiskit/0.19/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.19/qiskit.visualization.visualize_transition.md index cbf1aa2f016..ad014b2c632 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 5e069b70926fcb4f63dfc93f2d24ec46068da055 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:04:13 +0100 Subject: [PATCH 05/41] Regenerate qiskit 0.24.1 --- docs/api/qiskit/0.24/execute.md | 2 +- docs/api/qiskit/0.24/logging.md | 2 +- docs/api/qiskit/0.24/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.24/qiskit.aqua.QuantumInstance.md | 2 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 2 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 2 +- ...ua.algorithms.AmplitudeEstimationResult.md | 2 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 2 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 2 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 2 +- .../qiskit/0.24/qiskit.aqua.algorithms.EOH.md | 2 +- .../qiskit.aqua.algorithms.Eigensolver.md | 2 +- ...iskit.aqua.algorithms.EigensolverResult.md | 2 +- .../0.24/qiskit.aqua.algorithms.Grover.md | 2 +- .../qiskit.aqua.algorithms.GroverResult.md | 2 +- .../qiskit/0.24/qiskit.aqua.algorithms.HHL.md | 2 +- .../0.24/qiskit.aqua.algorithms.HHLResult.md | 2 +- .../0.24/qiskit.aqua.algorithms.IQPE.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.LinearsolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 2 +- ...qua.algorithms.MinimumEigensolverResult.md | 2 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 2 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.24/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.24/qiskit.aqua.algorithms.QGAN.md | 2 +- .../qiskit/0.24/qiskit.aqua.algorithms.QPE.md | 2 +- .../0.24/qiskit.aqua.algorithms.QSVM.md | 2 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 2 +- .../0.24/qiskit.aqua.algorithms.Shor.md | 2 +- .../0.24/qiskit.aqua.algorithms.Simon.md | 2 +- .../0.24/qiskit.aqua.algorithms.SklearnSVM.md | 2 +- .../qiskit/0.24/qiskit.aqua.algorithms.VQC.md | 2 +- .../qiskit/0.24/qiskit.aqua.algorithms.VQE.md | 2 +- .../qiskit/0.24/qiskit.aqua.circuits.CNF.md | 2 +- .../qiskit/0.24/qiskit.aqua.circuits.DNF.md | 2 +- .../qiskit/0.24/qiskit.aqua.circuits.ESOP.md | 2 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 2 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 2 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 2 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 2 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 2 +- ...aqua.components.feature_maps.FeatureMap.md | 2 +- ...omponents.feature_maps.RawFeatureVector.md | 2 +- ...t.aqua.components.initial_states.Custom.md | 2 +- ....components.initial_states.InitialState.md | 2 +- ....components.initial_states.VarFormBased.md | 2 +- ...kit.aqua.components.initial_states.Zero.md | 2 +- ...mponents.multiclass_extensions.AllPairs.md | 2 +- ...lticlass_extensions.ErrorCorrectingCode.md | 2 +- ...lticlass_extensions.MulticlassExtension.md | 2 +- ...ts.multiclass_extensions.OneAgainstRest.md | 2 +- ...s.neural_networks.DiscriminativeNetwork.md | 2 +- ...nents.neural_networks.GenerativeNetwork.md | 2 +- ...ents.neural_networks.NumPyDiscriminator.md | 2 +- ...ts.neural_networks.PyTorchDiscriminator.md | 2 +- ...onents.neural_networks.QuantumGenerator.md | 2 +- .../qiskit.aqua.components.optimizers.ADAM.md | 2 +- .../qiskit.aqua.components.optimizers.AQGD.md | 2 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 2 +- .../qiskit.aqua.components.optimizers.CG.md | 2 +- ...iskit.aqua.components.optimizers.COBYLA.md | 2 +- .../qiskit.aqua.components.optimizers.CRS.md | 2 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 2 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 2 +- .../qiskit.aqua.components.optimizers.ESCH.md | 2 +- .../qiskit.aqua.components.optimizers.GSLS.md | 2 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 2 +- ...qiskit.aqua.components.optimizers.ISRES.md | 2 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 2 +- ....aqua.components.optimizers.NELDER_MEAD.md | 2 +- .../qiskit.aqua.components.optimizers.NFT.md | 2 +- ...it.aqua.components.optimizers.Optimizer.md | 2 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 2 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 2 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 2 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 2 +- .../qiskit.aqua.components.optimizers.SPSA.md | 2 +- .../qiskit.aqua.components.optimizers.TNC.md | 2 +- ....components.oracles.CustomCircuitOracle.md | 2 +- ...ponents.oracles.LogicalExpressionOracle.md | 2 +- .../qiskit.aqua.components.oracles.Oracle.md | 2 +- ...qua.components.oracles.TruthTableOracle.md | 2 +- ...qua.components.reciprocals.LongDivision.md | 2 +- ...a.components.reciprocals.LookupRotation.md | 2 +- ....aqua.components.reciprocals.Reciprocal.md | 2 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 2 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 2 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 2 +- ...els.MultivariateVariationalDistribution.md | 2 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 2 +- ....uncertainty_models.UniformDistribution.md | 2 +- ...certainty_models.UnivariateDistribution.md | 2 +- ...odels.UnivariateVariationalDistribution.md | 2 +- ...ncertainty_problems.MultivariateProblem.md | 2 +- ...uncertainty_problems.UncertaintyProblem.md | 2 +- ...lems.UnivariatePiecewiseLinearObjective.md | 2 +- ....uncertainty_problems.UnivariateProblem.md | 2 +- ...nents.variational_forms.VariationalForm.md | 2 +- .../qiskit.aqua.operators.OperatorBase.md | 2 +- ...qua.operators.converters.AbelianGrouper.md | 2 +- ...qua.operators.converters.CircuitSampler.md | 2 +- ...aqua.operators.converters.ConverterBase.md | 2 +- ...a.operators.converters.DictToCircuitSum.md | 2 +- ...a.operators.converters.PauliBasisChange.md | 2 +- ...aqua.operators.evolutions.EvolutionBase.md | 2 +- ...a.operators.evolutions.EvolutionFactory.md | 2 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 2 +- ...ua.operators.evolutions.MatrixEvolution.md | 2 +- ...rators.evolutions.PauliTrotterEvolution.md | 2 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 2 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 2 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 2 +- ...rators.evolutions.TrotterizationFactory.md | 2 +- ...rators.expectations.AerPauliExpectation.md | 2 +- ....operators.expectations.CVaRExpectation.md | 2 +- ....operators.expectations.ExpectationBase.md | 2 +- ...erators.expectations.ExpectationFactory.md | 2 +- ...perators.expectations.MatrixExpectation.md | 2 +- ...operators.expectations.PauliExpectation.md | 2 +- ...qua.operators.gradients.CircuitGradient.md | 2 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 2 +- ...aqua.operators.gradients.DerivativeBase.md | 2 +- ...iskit.aqua.operators.gradients.Gradient.md | 2 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 2 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 2 +- .../qiskit.aqua.operators.gradients.QFI.md | 2 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 2 +- ...it.aqua.operators.legacy.MatrixOperator.md | 2 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 2 +- ....operators.legacy.WeightedPauliOperator.md | 2 +- ...skit.aqua.operators.legacy.Z2Symmetries.md | 2 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 2 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 2 +- ...qiskit.aqua.operators.list_ops.SummedOp.md | 2 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 2 +- ....aqua.operators.primitive_ops.CircuitOp.md | 2 +- ...t.aqua.operators.primitive_ops.MatrixOp.md | 2 +- ...it.aqua.operators.primitive_ops.PauliOp.md | 2 +- ...qua.operators.primitive_ops.PrimitiveOp.md | 2 +- ...qua.operators.state_fns.CVaRMeasurement.md | 2 +- ...aqua.operators.state_fns.CircuitStateFn.md | 2 +- ...it.aqua.operators.state_fns.DictStateFn.md | 2 +- ...qua.operators.state_fns.OperatorStateFn.md | 2 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 2 +- ....aqua.operators.state_fns.VectorStateFn.md | 2 +- .../0.24/qiskit.aqua.utils.CircuitFactory.md | 2 +- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.24/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.24/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.24/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.24/qiskit.aqua.utils.name_args.md | 2 +- .../0.24/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.24/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.24/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.24/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.24/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.24/qiskit.assembler.RunConfig.md | 2 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.24/qiskit.assembler.disassemble.md | 2 +- .../0.24/qiskit.chemistry.BosonicOperator.md | 2 +- .../qiskit.chemistry.FermionicOperator.md | 2 +- .../qiskit/0.24/qiskit.chemistry.MP2Info.md | 2 +- .../qiskit/0.24/qiskit.chemistry.QMolecule.md | 2 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 2 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 2 +- ...chemistry.algorithms.EigensolverFactory.md | 2 +- ...try.algorithms.ExcitedStatesEigensolver.md | 2 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 2 +- ...istry.algorithms.GroundStateEigensolver.md | 2 +- ....chemistry.algorithms.GroundStateSolver.md | 2 +- ...ry.algorithms.MinimumEigensolverFactory.md | 2 +- ...stry.algorithms.NumPyEigensolverFactory.md | 2 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 2 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 2 +- .../0.24/qiskit.chemistry.algorithms.QEOM.md | 2 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 2 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 2 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 2 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 2 +- ...s.pes_samplers.DifferentialExtrapolator.md | 2 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 2 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 2 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 2 +- ...gorithms.pes_samplers.HarmonicPotential.md | 2 +- ....algorithms.pes_samplers.MorsePotential.md | 2 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 2 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 2 +- ...y.algorithms.pes_samplers.PotentialBase.md | 2 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 2 +- ...thms.pes_samplers.VibronicStructureBase.md | 2 +- ...orithms.pes_samplers.WindowExtrapolator.md | 2 +- ...applications.MolecularGroundStateEnergy.md | 2 +- ...y.components.bosonic_bases.BosonicBasis.md | 2 +- ....components.bosonic_bases.HarmonicBasis.md | 2 +- ...y.components.initial_states.HartreeFock.md | 2 +- ...hemistry.components.initial_states.VSCF.md | 2 +- ...mistry.components.variational_forms.CHC.md | 2 +- ...stry.components.variational_forms.UCCSD.md | 2 +- ...istry.components.variational_forms.UVCC.md | 2 +- ...qiskit.chemistry.core.ChemistryOperator.md | 2 +- .../0.24/qiskit.chemistry.core.Hamiltonian.md | 2 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 2 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 2 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 2 +- ...iskit.chemistry.drivers.FermionicDriver.md | 2 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 2 +- ....chemistry.drivers.GaussianForcesDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogResult.md | 2 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 2 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.24/qiskit.chemistry.drivers.Molecule.md | 2 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 2 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 2 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 2 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 2 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 2 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 2 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 2 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 2 +- .../0.24/qiskit.circuit.AncillaQubit.md | 2 +- .../0.24/qiskit.circuit.AncillaRegister.md | 2 +- .../0.24/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.24/qiskit.circuit.Clbit.md | 2 +- .../0.24/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.24/qiskit.circuit.Delay.md | 2 +- .../0.24/qiskit.circuit.EquivalenceLibrary.md | 2 +- docs/api/qiskit/0.24/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.24/qiskit.circuit.Instruction.md | 2 +- .../0.24/qiskit.circuit.InstructionSet.md | 2 +- .../api/qiskit/0.24/qiskit.circuit.Measure.md | 2 +- .../qiskit/0.24/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.24/qiskit.circuit.ParameterVector.md | 2 +- .../0.24/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.24/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.24/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.24/qiskit.circuit.Reset.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.AND.md | 2 +- .../0.24/qiskit.circuit.library.Barrier.md | 2 +- .../0.24/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.24/qiskit.circuit.library.C3XGate.md | 2 +- .../0.24/qiskit.circuit.library.C4XGate.md | 2 +- .../0.24/qiskit.circuit.library.CCXGate.md | 2 +- .../0.24/qiskit.circuit.library.CHGate.md | 2 +- .../0.24/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.24/qiskit.circuit.library.CRXGate.md | 2 +- .../0.24/qiskit.circuit.library.CRYGate.md | 2 +- .../0.24/qiskit.circuit.library.CRZGate.md | 2 +- .../0.24/qiskit.circuit.library.CSXGate.md | 2 +- .../0.24/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.24/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.24/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.24/qiskit.circuit.library.CUGate.md | 2 +- .../0.24/qiskit.circuit.library.CXGate.md | 2 +- .../0.24/qiskit.circuit.library.CYGate.md | 2 +- .../0.24/qiskit.circuit.library.CZGate.md | 2 +- .../0.24/qiskit.circuit.library.DCXGate.md | 2 +- .../0.24/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.GRZ.md | 2 +- .../0.24/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.24/qiskit.circuit.library.HGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.24/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.24/qiskit.circuit.library.MCMT.md | 2 +- .../0.24/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.24/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.24/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.24/qiskit.circuit.library.MSGate.md | 2 +- .../0.24/qiskit.circuit.library.Measure.md | 2 +- .../0.24/qiskit.circuit.library.NLocal.md | 2 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.24/qiskit.circuit.library.PhaseGate.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.24/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.24/qiskit.circuit.library.RCCXGate.md | 2 +- .../0.24/qiskit.circuit.library.RXGate.md | 2 +- .../0.24/qiskit.circuit.library.RXXGate.md | 2 +- .../0.24/qiskit.circuit.library.RYGate.md | 2 +- .../0.24/qiskit.circuit.library.RYYGate.md | 2 +- .../0.24/qiskit.circuit.library.RZGate.md | 2 +- .../0.24/qiskit.circuit.library.RZXGate.md | 2 +- .../0.24/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.24/qiskit.circuit.library.Reset.md | 2 +- .../0.24/qiskit.circuit.library.SGate.md | 2 +- .../0.24/qiskit.circuit.library.SXGate.md | 2 +- .../0.24/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.24/qiskit.circuit.library.SdgGate.md | 2 +- .../0.24/qiskit.circuit.library.SwapGate.md | 2 +- .../0.24/qiskit.circuit.library.TGate.md | 2 +- .../0.24/qiskit.circuit.library.TdgGate.md | 2 +- .../0.24/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.24/qiskit.circuit.library.U1Gate.md | 2 +- .../0.24/qiskit.circuit.library.U2Gate.md | 2 +- .../0.24/qiskit.circuit.library.U3Gate.md | 2 +- .../0.24/qiskit.circuit.library.UGate.md | 2 +- ...kit.circuit.library.UniformDistribution.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.24/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.24/qiskit.circuit.library.XOR.md | 2 +- .../0.24/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.24/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../0.24/qiskit.circuit.library.iSwapGate.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.24/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.24/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.24/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.24/qiskit.compiler.transpile.md | 2 +- .../0.24/qiskit.converters.ast_to_dag.md | 2 +- .../0.24/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.24/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.24/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.24/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.24/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.24/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.24/qiskit.dagcircuit.DAGDependency.md | 2 +- .../qiskit/0.24/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.24/qiskit.extensions.HamiltonianGate.md | 2 +- .../0.24/qiskit.extensions.Initialize.md | 2 +- .../qiskit/0.24/qiskit.extensions.Snapshot.md | 2 +- .../0.24/qiskit.extensions.UnitaryGate.md | 2 +- .../0.24/qiskit.finance.QiskitFinanceError.md | 2 +- ...it.finance.applications.ising.portfolio.md | 10 +++---- ...cations.ising.portfolio_diversification.md | 6 ++--- ....uncertainty_problems.EuropeanCallDelta.md | 2 +- ...inty_problems.EuropeanCallExpectedValue.md | 2 +- ...ainty_problems.FixedIncomeExpectedValue.md | 2 +- ...finance.data_providers.BaseDataProvider.md | 2 +- ...nce.data_providers.DataOnDemandProvider.md | 2 +- ...nce.data_providers.ExchangeDataProvider.md | 2 +- ...nance.data_providers.RandomDataProvider.md | 2 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 2 +- ...inance.data_providers.YahooDataProvider.md | 2 +- ...t.ignis.characterization.AmpCalCXFitter.md | 2 +- ...kit.ignis.characterization.AmpCalFitter.md | 2 +- ...ignis.characterization.AngleCalCXFitter.md | 2 +- ...t.ignis.characterization.AngleCalFitter.md | 2 +- ...is.characterization.BaseCoherenceFitter.md | 2 +- ...t.ignis.characterization.BaseGateFitter.md | 2 +- ...iskit.ignis.characterization.DragFitter.md | 2 +- ...iskit.ignis.characterization.RabiFitter.md | 2 +- .../qiskit.ignis.characterization.T1Fitter.md | 2 +- .../qiskit.ignis.characterization.T2Fitter.md | 2 +- ...kit.ignis.characterization.T2StarFitter.md | 2 +- .../qiskit.ignis.characterization.ZZFitter.md | 2 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 2 +- .../0.24/qiskit.ignis.logging.IgnisLogger.md | 2 +- .../0.24/qiskit.ignis.logging.IgnisLogging.md | 2 +- ....ignis.measurement.DiscriminationFilter.md | 2 +- ...gnis.measurement.IQDiscriminationFitter.md | 2 +- ...ignis.measurement.LinearIQDiscriminator.md | 2 +- ...is.measurement.QuadraticIQDiscriminator.md | 2 +- ...gnis.measurement.SklearnIQDiscriminator.md | 2 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 2 +- ....mitigation.CompleteExpvalMeasMitigator.md | 2 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 2 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 2 +- ...skit.ignis.mitigation.MeasurementFilter.md | 2 +- ....mitigation.TensoredExpvalMeasMitigator.md | 2 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 2 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 2 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 2 +- ....ignis.verification.AccreditationFitter.md | 2 +- .../0.24/qiskit.ignis.verification.BConfig.md | 2 +- .../qiskit.ignis.verification.CNOTDihedral.md | 2 +- ...ignis.verification.CNOTDihedralRBFitter.md | 2 +- ...is.verification.GatesetTomographyFitter.md | 2 +- .../qiskit.ignis.verification.GraphDecoder.md | 2 +- ....ignis.verification.InterleavedRBFitter.md | 2 +- .../0.24/qiskit.ignis.verification.Plotter.md | 2 +- ...is.verification.ProcessTomographyFitter.md | 2 +- ...iskit.ignis.verification.PurityRBFitter.md | 2 +- .../0.24/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 2 +- .../qiskit.ignis.verification.RBFitter.md | 2 +- ...iskit.ignis.verification.RepetitionCode.md | 2 +- ...gnis.verification.StateTomographyFitter.md | 2 +- ...kit.ignis.verification.TomographyFitter.md | 2 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- .../0.24/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.24/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.24/qiskit.ml.datasets.digits.md | 2 +- .../0.24/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.24/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.24/qiskit.ml.datasets.wine.md | 2 +- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 2 +- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 2 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 2 +- ....optimization.algorithms.CplexOptimizer.md | 2 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 2 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 2 +- ...zation.algorithms.MinimumEigenOptimizer.md | 2 +- ...mization.algorithms.MultiStartOptimizer.md | 2 +- ...zation.algorithms.OptimizationAlgorithm.md | 2 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 2 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 2 +- ....optimization.applications.ising.clique.md | 6 ++--- ....optimization.applications.ising.common.md | 12 ++++----- ...optimization.applications.ising.docplex.md | 2 +- ...mization.applications.ising.exact_cover.md | 6 ++--- ...tion.applications.ising.graph_partition.md | 6 ++--- ...ptimization.applications.ising.knapsack.md | 6 ++--- ...optimization.applications.ising.max_cut.md | 6 ++--- ...timization.applications.ising.partition.md | 4 +-- ...mization.applications.ising.set_packing.md | 6 ++--- ...imization.applications.ising.stable_set.md | 6 ++--- ...kit.optimization.applications.ising.tsp.md | 14 +++++----- ...tion.applications.ising.vehicle_routing.md | 8 +++--- ...ization.applications.ising.vertex_cover.md | 6 ++--- ...ization.converters.InequalityToEquality.md | 2 +- ...optimization.converters.IntegerToBinary.md | 2 +- ...tion.converters.LinearEqualityToPenalty.md | 2 +- ...on.converters.QuadraticProgramConverter.md | 2 +- ...ation.converters.QuadraticProgramToQubo.md | 2 +- ...qiskit.optimization.problems.Constraint.md | 2 +- ....optimization.problems.LinearConstraint.md | 2 +- ....optimization.problems.LinearExpression.md | 2 +- ...timization.problems.QuadraticConstraint.md | 2 +- ...timization.problems.QuadraticExpression.md | 2 +- ...ptimization.problems.QuadraticObjective.md | 2 +- ....optimization.problems.QuadraticProgram.md | 2 +- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 2 +- .../qiskit/0.24/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.24/qiskit.providers.BackendV1.md | 2 +- .../0.24/qiskit.providers.BaseBackend.md | 2 +- .../qiskit/0.24/qiskit.providers.BaseJob.md | 2 +- .../0.24/qiskit.providers.BaseProvider.md | 2 +- docs/api/qiskit/0.24/qiskit.providers.Job.md | 2 +- .../qiskit/0.24/qiskit.providers.JobError.md | 2 +- .../qiskit/0.24/qiskit.providers.JobStatus.md | 2 +- .../0.24/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.24/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.24/qiskit.providers.Options.md | 2 +- .../qiskit/0.24/qiskit.providers.Provider.md | 2 +- .../0.24/qiskit.providers.ProviderV1.md | 2 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.24/qiskit.providers.aer.AerError.md | 2 +- .../0.24/qiskit.providers.aer.AerJob.md | 2 +- .../0.24/qiskit.providers.aer.AerProvider.md | 2 +- .../qiskit.providers.aer.PulseSimulator.md | 2 +- .../qiskit.providers.aer.QasmSimulator.md | 2 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 2 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 2 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 2 +- ...qiskit.providers.aer.noise.QuantumError.md | 2 +- ...qiskit.providers.aer.noise.ReadoutError.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 2 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 2 +- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 2 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.24/qiskit.providers.ibmq.IBMQBackend.md | 2 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 2 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.24/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.24/qiskit.providers.ibmq.IBMQFactory.md | 2 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- ....providers.ibmq.credentials.Credentials.md | 2 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...roviders.ibmq.experiment.AnalysisResult.md | 2 +- ...it.providers.ibmq.experiment.Experiment.md | 2 +- ...iders.ibmq.experiment.ExperimentService.md | 2 +- .../0.24/qiskit.providers.ibmq.job.IBMQJob.md | 2 +- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 2 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.24/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 2 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 2 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 2 +- ...t.providers.ibmq.managed.ManagedResults.md | 2 +- ...skit.providers.ibmq.random.CQCExtractor.md | 2 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 2 +- ...providers.ibmq.random.IBMQRandomService.md | 2 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.24/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../0.24/qiskit.providers.models.JobStatus.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Acquire.md | 2 +- .../0.24/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Constant.md | 2 +- .../0.24/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Delay.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Drag.md | 2 +- .../qiskit/0.24/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Gaussian.md | 2 +- .../0.24/qiskit.pulse.GaussianSquare.md | 2 +- .../qiskit/0.24/qiskit.pulse.Instruction.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- .../0.24/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.24/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Play.md | 2 +- .../qiskit/0.24/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.24/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.24/qiskit.pulse.SetFrequency.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.SetPhase.md | 2 +- .../0.24/qiskit.pulse.ShiftFrequency.md | 2 +- .../qiskit/0.24/qiskit.pulse.ShiftPhase.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Snapshot.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.Waveform.md | 2 +- .../0.24/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.24/qiskit.pulse.builder.align_func.md | 2 +- .../0.24/qiskit.pulse.builder.align_left.md | 2 +- .../0.24/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.24/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.delay.md | 2 +- .../0.24/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.24/qiskit.pulse.builder.inline.md | 2 +- .../0.24/qiskit.pulse.builder.measure.md | 2 +- .../0.24/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.24/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.pad.md | 2 +- .../0.24/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.24/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.24/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.24/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.24/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.24/qiskit.pulse.builder.x.md | 2 +- docs/api/qiskit/0.24/qiskit.pulse.channels.md | 18 ++++++------- .../0.24/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.24/qiskit.pulse.instructions.Delay.md | 2 +- .../qiskit.pulse.instructions.Instruction.md | 2 +- .../0.24/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../0.24/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.24/qiskit.pulse.library.Drag.md | 2 +- .../0.24/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../0.24/qiskit.pulse.library.Waveform.md | 2 +- .../0.24/qiskit.pulse.library.discrete.md | 26 +++++++++---------- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.24/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.24/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.24/qiskit.qasm.Qasm.md | 2 +- docs/api/qiskit/0.24/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.24/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.24/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.24/qiskit.qobj.GateCalibration.md | 2 +- .../0.24/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.md | 2 +- .../0.24/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.24/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.24/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.24/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.24/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.24/qiskit.qobj.QasmQobjInstruction.md | 2 +- docs/api/qiskit/0.24/qiskit.qobj.Qobj.md | 2 +- .../0.24/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.24/qiskit.qobj.QobjHeader.md | 2 +- .../0.24/qiskit.qobj.QobjMeasurementOption.md | 2 +- ...iskit.qobj.validate_qobj_against_schema.md | 2 +- .../qiskit/0.24/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.24/qiskit.quantum_info.Choi.md | 2 +- .../0.24/qiskit.quantum_info.Clifford.md | 2 +- .../0.24/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.24/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.24/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.24/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.24/qiskit.quantum_info.Pauli.md | 2 +- .../0.24/qiskit.quantum_info.PauliTable.md | 2 +- .../0.24/qiskit.quantum_info.Quaternion.md | 2 +- .../0.24/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.24/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerTable.md | 2 +- .../0.24/qiskit.quantum_info.Statevector.md | 2 +- .../0.24/qiskit.quantum_info.Stinespring.md | 2 +- .../0.24/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.24/qiskit.quantum_info.concurrence.md | 2 +- .../0.24/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.24/qiskit.quantum_info.entropy.md | 2 +- .../qiskit.quantum_info.euler_angles_1q.md | 2 +- .../0.24/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.24/qiskit.quantum_info.partial_trace.md | 2 +- .../0.24/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.24/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.24/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../0.24/qiskit.quantum_info.random_state.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.24/qiskit.result.Counts.md | 2 +- docs/api/qiskit/0.24/qiskit.result.Result.md | 2 +- .../qiskit/0.24/qiskit.result.ResultError.md | 2 +- .../0.24/qiskit.result.marginal_counts.md | 2 +- .../0.24/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.24/qiskit.scheduler.methods.basic.md | 4 +-- .../0.24/qiskit.scheduler.schedule_circuit.md | 2 +- .../0.24/qiskit.tools.backend_monitor.md | 2 +- .../0.24/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.24/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.24/qiskit.tools.parallel_map.md | 2 +- .../0.24/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.24/qiskit.transpiler.FlowController.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- .../qiskit/0.24/qiskit.transpiler.Layout.md | 2 +- .../0.24/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.24/qiskit.transpiler.PropertySet.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.24/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- .../0.24/qiskit.transpiler.passes.CheckMap.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- .../0.24/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.24/qiskit.transpiler.passes.Depth.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.24/qiskit.transpiler.passes.Size.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- .../0.24/qiskit.transpiler.passes.Unroller.md | 2 +- .../0.24/qiskit.transpiler.passes.Width.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.24/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...iskit.visualization.pulse.interpolation.md | 4 +-- .../qiskit.visualization.pulse.qcstyle.md | 4 +-- .../0.24/qiskit.visualization.pulse_drawer.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 987 files changed, 1047 insertions(+), 1047 deletions(-) diff --git a/docs/api/qiskit/0.24/execute.md b/docs/api/qiskit/0.24/execute.md index 4d8b019f1c6..fc18fedc1b9 100644 --- a/docs/api/qiskit/0.24/execute.md +++ b/docs/api/qiskit/0.24/execute.md @@ -22,7 +22,7 @@ python_api_name: qiskit.execute -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=1024, memory=False, max_credits=10, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=, meas_return=, memory_slots=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/execute.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=1024, memory=False, max_credits=10, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=, meas_return=, memory_slots=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/execute.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.24/logging.md b/docs/api/qiskit/0.24/logging.md index f3277ac725c..3fdd9b23fb0 100644 --- a/docs/api/qiskit/0.24/logging.md +++ b/docs/api/qiskit/0.24/logging.md @@ -24,7 +24,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.24/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.24/qiskit.aqua.AquaError.md index 4e01a4f30ef..fc49e1f29a7 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.AquaError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.md index 11bc59f4e7f..75633d066eb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.MissingOptionalLibraryError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.md index faf1eb8face..218f714e8e9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.QuantumInstance.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.md index 1052aeccdfe..7833b5b33ee 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index e3ca92e4c54..f8e320d5757 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") AmplitudeEstimationAlgorithm Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 033bec76d5b..88bda148e58 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") AmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.md index 45d48f1fb7b..eb358d095f4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.md index c0d0fa89a27..72a4e37fc0f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.md index 5c113f39be0..204b806f5db 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.md index dd758bd3ac7..4996a38a064 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.DeutschJozsa.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.md index f6c0b2dc369..2b2503ae2cd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EOH.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/eoh.py "view source code") The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.md index b11fee07eef..b8fdb03fe1d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Eigensolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.md index ef5f0a701bb..87bfbb8c1e8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.EigensolverResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.md index 714456e1d08..1c638077b5f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Grover.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.md index e43be9cf4a5..0acb5b938b0 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.GroverResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.md index b4841653926..15bbeaa204b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHL.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") The HHL algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.md index 3c059b335f5..ccd055b55a8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.HHLResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") HHL Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.md index 29a616e89b8..4f8f9e393e9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IQPE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") The Iterative Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index cc63ca8a3a4..676e2827b9f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index 95540007efc..d84e416c00a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") IterativeAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.md index f0ad9113a46..62e66d7ad6a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.LinearsolverResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Linear solver Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 3f69953829f..b1b669f2d70 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 2c4678ba695..ae9e60fe008 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") MaximumLikelihoodAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.md index aad877452f3..36f8f6aa7c0 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.md index 0d84c1369c3..0e054f9dfa2 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.md index 6cc26e73748..c9ddf2f9819 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.md index 3d665cf97dc..6539e0ebcc6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 8915eb1c6d4..8b03134b358 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Numpy LinearSystem Result. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index 0c1897a9f81..9fdebbb32a2 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.md index b447761150f..5b04a23d9a0 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QAOA.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.md index 15076b122e7..b9ed785cd0d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QGAN.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.md index fe12789fb15..b5cc9ed06ea 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QPE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") The Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.md index 00d0f655789..10956c2a1ac 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QSVM.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Quantum SVM algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.md index c525f844d5b..1f6ad18d912 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.md index 743f6c5ea60..db0f0b8134c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Shor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.md index 4e9d0a77901..3cd3960dad1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.Simon.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/education/simon.py "view source code") The Simon algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.md index 652455cf4ab..f50be9a3c6d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.SklearnSVM.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.md index a5039e9f8f5..1fe37711947 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQC.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.md index 5954c8b5363..7683cfa2b67 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.algorithms.VQE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.md index 9a278f59c00..0d7b1ec41c9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.CNF.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.md index 04ef412e240..433dd9f826c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.DNF.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.md index 3ec576ef2a8..45986ea19f5 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.ESOP.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.md index f0fa3377863..bd095474a87 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.md index 713df2fedb7..b77874ead70 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.StateVectorCircuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/statevector_circuit.py "view source code") Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.md index c3511f1d40a..a45ba31c7d4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.circuits.WeightedSumOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds q^T \* w to separate register for non-negative integer weights w. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.md index bdd89bae493..9036fa1fa49 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.Eigenvalues.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/eigs/eigs.py "view source code") Base class for eigenvalue estimation. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.md index e0b6839cf8c..d6edfd8af0e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.eigs.EigsQPE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.md index 8626665c39b..4b5271bce25 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Base class for FeatureMap. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 3b6a01e1dad..2137aaf207f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Raw Feature Vector feature map. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.md index e357515785e..1e91dbaf579 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Custom.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/custom.py "view source code") The custom initial state. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.md index ec231bd8b23..2b7a2e981b1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.InitialState.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/initial_state.py "view source code") Base class for InitialState. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.md index 9c02e482c07..5c39e0653fb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.VarFormBased.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/var_form_based.py "view source code") The variational form based initial state. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.md index 9c1f409ef08..62007b85011 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.initial_states.Zero.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/initial_states/zero.py "view source code") The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.md index 2d44fe3767d..3b5dcba6e89 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index b59220fe69b..bfd1ee4f04d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 0f569adcddc..5380c3ccceb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Base class for multiclass extension. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index ff7a8b92de7..846b38423e3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index 2093ffe1c07..f808b9ee4be 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Base class for discriminative Quantum or Classical Neural Networks. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 4417b8cb6d7..87afe5fdf38 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Base class for generative Quantum and Classical Neural Networks. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 414e1226f4d..1a4620203ef 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Discriminator based on NumPy diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index 70f4ca4b8bd..396bed0fb2b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.md index faa36f60436..a360cdcc60c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Quantum Generator. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.md index bf0e2eded86..c9a3dc4f0a4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ADAM.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.md index cd24b00dc60..0d574e65299 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.AQGD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.md index 94ab88d9063..2405705341c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.BOBYQA.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.md index 127258da2a8..5295ed12721 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CG.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.md index 247165336f3..2c3a37e0352 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.COBYLA.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.md index da978bfeafe..ff8daef8c7c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.CRS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.md index ab360dafd20..3baebc6e77e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index 15bef0e3491..8d3d7cd0889 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.md index d43801f904f..f4f676b891f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ESCH.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.md index 3b5d53f4bb1..80811188885 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.GSLS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.md index acd607b5f4c..5e522c2db0d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.IMFIL.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.md index f69aaa5bb64..2a6816d1bfb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.ISRES.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.md index 17ef2adf6ff..b743200e881 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.md index df60d425fed..281f1cae2aa 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.md index 190ca3ac519..1a06c81c9cb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.NFT.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.md index dc7689e4d26..a0888f93e75 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.Optimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index 81ec2f493ea..2998f66ae45 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.md index 60548fe52a4..e7e2ee4301b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.POWELL.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.md index ad941e51079..79087f02158 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.P_BFGS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.md index d5c6c329580..46c5d13ce6a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SLSQP.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.md index ddafefb79e6..27eaebf86e3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.md index 4c61c77a264..b246be623d4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.SPSA.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.md index 1ed8dcd7357..1f7015ba27e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.optimizers.TNC.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 9ec77e0547f..551ffebdf9a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index fcf46f167e2..62efd51afc9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.md index 8fad2a15242..b88c020da90 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.Oracle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/oracle.py "view source code") Base class for oracles. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.md index 8e2a937f7d5..963b3ef06b6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.md index c27e071c47f..92e078a2059 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LongDivision.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/reciprocals/long_division.py "view source code") The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.md index 472d69041ee..23d8e2ff970 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.md index f02b8386bf2..5cabe40f7f2 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Base class for reciprocal calculation. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 5a8fe6ce322..8a84213b4bb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") The Univariate Bernoulli Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 8558e3f38f3..8a167868afd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") The Gaussian Conditional Independence Model for Credit Risk. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index c8c71c1af85..ef16b82bac8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") The Univariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index e1c83b933e8..4a84c4f8ab8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index dec48b0081c..62e25b55933 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") The Multivariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 66fe4b10877..8408b971613 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") The Multivariate Normal Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index a791b7d1252..7a659e7938a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") The Multivariate Uniform Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index 41392f6b978..b302046f21b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") The Multivariate Variational Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index a7a14b8f04a..e65edf24539 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") The Univariate Normal Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 08b939bfbf5..610590106ad 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") The abstract Uncertainty Model diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 88ba9ee54ae..0f5e272c95f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") The Univariate Uniform Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index c64d2660530..94f5b15c37e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 88f4c25f634..b3e44aefb83 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") The Univariate Variational Distribution. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index afcad019dfa..82cdd65c19c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 7f498acbe55..2d24398ff14 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") The abstract Uncertainty Problem component. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 6e65c8dd136..8d9ebc795d4 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index 056e414aa1c..6376c09f374 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.md index 81beadad17e..9858f5e5b45 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Base class for VariationalForms. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.md index 71802b7bacb..87d32689682 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.OperatorBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.md index 5ae1371be27..d62e5eb1902 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.md index 04395b1ae22..839de2e2da2 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.CircuitSampler.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.md index 14d3839ac90..2ccb28e4f03 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.ConverterBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.md index 816db420755..8a3437c0ccc 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.md index 43135665223..f379cc29fc9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.md index d188f96200b..5efe4756032 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.md index d36f49d37a1..ff342721e51 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.md index 73e993c0279..74a27491ffe 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.md index 6e10e364714..52d833a11de 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index c6020069616..7b5b2851bf9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.md index de503fc0fd1..4af3a07abce 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.QDrift.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.md index 440ffde0bbc..8faaf1e17c6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Suzuki.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.md index f555574e20e..3d0be1bf922 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.Trotter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.md index 130b30547a4..f9a43ae6cca 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index f030f128a35..072eeda851d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.md index ac295738016..0ca96528f81 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.md index 7016a6868b2..d50e7c146ff 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.md index 8a762dc2547..c34adc198ce 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.md index c4bd8e384c6..35d4d29b35e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.md index 29db9ac6f78..6c0edaf6aba 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.md index 6102c30fb25..87490341710 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.md index 45371262fb8..db8ad0129e1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.md index 756bccd69f1..3d4995675fd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.md index c7b6a878bd0..a6968bd95be 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.md index a3f562eb4ee..c8fd3edba6a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Gradient.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.md index 57cf9efe158..992ae1e1df3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.GradientBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.md index ae962069f38..a7f28470dee 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.Hessian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.md index d8d57ca98b6..810939a79f6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.HessianBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.md index d55bd33f1c9..cc2c14d02c7 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.md index dbf7f7b3d52..8fe50e033df 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFI.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.md index da7f1dd6010..c3c617305b8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.gradients.QFIBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 33d8f265193..1d7700d8c57 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/base_operator.py "view source code") Operators relevant for quantum applications. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.md index 0e7fdaacc42..52a50de2a33 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.md index 524076b1bee..214df785fbb 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.PauliGraph.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Pauli Graph. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 10028f69761..079ed0198f3 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") TPB Grouped Weighted Pauli Operator diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index cb6d4aa5029..0144a5f073f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Weighted Pauli Operator diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.md index 8ed7e645578..c5080f4f4c1 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.check_commutativity.md index 49815a0d580..d0d95385a18 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.check_commutativity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.commutator.md index 75d085a5b1a..63466c75a5d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.covariance.md index 3aeb7d24be0..62ecb0e35aa 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.covariance.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.evolution_instruction.md index 59d3955b155..d7fb7988a0d 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.kernel_F2.md index 7c75759aec6..4234bf5a821 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.kernel_F2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.measure_pauli_z.md index c41529e539b..e34616995dd 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.pauli_measurement.md index 46fe85ee462..78497e48cc7 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.row_echelon_F2.md index 5c7553e09cf..95aca661eac 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 17ef0329898..6bbd076e2ee 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.md index fe81bda9eda..acf34b15f15 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.md index 40f29f379f8..5d1b6eaa902 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.ListOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.md index 641c13ecb2f..0d2c121d4db 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.SummedOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.md index c4ddcf97320..1e33015d85f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.md index d34b335f841..0bd9fb9e428 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.md index 4f3817c9746..efef19b4b56 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.md index e2b76829595..0f57c140544 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 24b71f5d93f..f6157a21dce 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 3ac928f8357..4554340e435 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.md index dc57e465138..ceadbf584af 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.md index f4235260224..263e0725491 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.md index 9ac60df9af2..0493d3bab37 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.md index e670d01f717..726a69dec40 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.StateFn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.md index ded7bfcf4c3..db5b86420fc 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.md index 756b3d3eca1..e973193ed5e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.CircuitFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/circuit_factory.py "view source code") Base class for CircuitFactories diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.decimal_to_binary.md index 0630f360286..c47ddf0ad5c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.decimal_to_binary.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_entangler_map.md index 9fe6b92fbd4..fac769a464a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_entangler_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_feature_dimension.md index 037b0e3b8c6..89432879c1b 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_feature_dimension.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_num_classes.md index 138a76f881f..d7b89c74bbc 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_num_classes.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystem_density_matrix.md index d2b87acdffe..478b898bfb5 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystems_counts.md index dbe3944e530..34718b55e4f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.get_subsystems_counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.has_aer.md index ea2cade33e1..a0a3d2b98e8 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.has_aer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.has_ibmq.md index d87af19b0e3..010539980b9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.has_ibmq.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.map_label_to_class_name.md index b007328b09a..51dc34afb90 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.map_label_to_class_name.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.name_args.md index 95e2e384e3e..1ba9fcdb26e 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.name_args.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.optimize_svm.md index f92fe08717a..49e370ebad2 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.optimize_svm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h1_body.md index e71f6203d84..c3017ebe5b9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h1_body.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h2_body.md index 174652d4166..c1107bf6722 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_h2_body.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_hermitian.md index a3ca18da3c6..8329ebf3a8c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_hermitian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_non_hermitian.md index d78ed08c8e2..2916c723b3c 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_non_hermitian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_unitary.md index 6761b9c0f0a..4faee00d81a 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.random_unitary.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 6a980e6cf2c..1a0af9802e9 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 4ae43991fde..391c6ad7c33 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.summarize_circuits.md index 167d8663457..ef892ee4b6f 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.summarize_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.tensorproduct.md index 8fa8c4e1f1d..b538c557d60 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.tensorproduct.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.24/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.24/qiskit.aqua.utils.validate_entangler_map.md index 031793cf07e..b774bc5b3d6 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.24/qiskit.aqua.utils.validate_entangler_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.md index 3b6d8fcd3eb..c86513e5674 100644 --- a/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.24/qiskit.assembler.RunConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/run_config.py "view source code") Class for Run Configuration. diff --git a/docs/api/qiskit/0.24/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.24/qiskit.assembler.assemble_circuits.md index 0171718e125..b0f82bd4045 100644 --- a/docs/api/qiskit/0.24/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.assembler.assemble_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.24/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.24/qiskit.assembler.assemble_schedules.md index 39527bf4996..5633ebad546 100644 --- a/docs/api/qiskit/0.24/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.24/qiskit.assembler.assemble_schedules.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.24/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.24/qiskit.assembler.disassemble.md index 5e9e2cdf2d8..c8fb551e8c0 100644 --- a/docs/api/qiskit/0.24/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.24/qiskit.assembler.disassemble.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.md index 917e4684dc8..97145a76616 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.BosonicOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/bosonic_operator.py "view source code") A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.md index c740652079e..f7b9171301f 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.FermionicOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/fermionic_operator.py "view source code") A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.md index aa7531c94b5..6942926f6d3 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.MP2Info.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/mp2info.py "view source code") A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.md index 6d63bf048b3..f3abb1aea9a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.QMolecule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/qmolecule.py "view source code") Molecule data class containing driver result. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.md index 97602734a1a..403d0ced327 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.QiskitChemistryError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.md index 36913352120..9bd63cfcf5e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.WatsonHamiltonian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/watson_hamiltonian.py "view source code") Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.md index b32322672d5..abba5580ff8 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.AdaptVQE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.md index d7449e5f6f4..29e446b704e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.BOPESSampler.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.md index b0a3c7fa1db..853182ce5c7 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") A factory to construct a eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index b3d90496399..8436346aa1b 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index 0427e097b54..d0ef046876c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") The excited states calculation interface diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 0759f79f24f..ebf006edbc6 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.md index 68ac2815dc2..9b8a310e0e2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") The ground state calculation interface diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index 8f1c1d0c8df..b5eb36f6f01 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") A factory to construct a minimum eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index e78be4ac7f0..eb090d83731 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index b601553aad3..ac699b76be5 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 8a60c1127ca..0e346a66638 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.md index 6ff40230be3..edab65ab5c5 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEOM.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.md index ea070e9dfe8..3941ad48c81 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomEE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") QEomEE algorithm (classical) diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.md index 201f7a8e885..498b2cc726a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.QEomVQE.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") QEomVQE algorithm diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.md index a1cf73f8c31..0eef9e99cbf 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEAdapt.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 59bf4901177..e1d8dd57625 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index 0fe90744b04..55ca24ff556 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 591156413b4..1969bec0d45 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 0a1463883c0..b5b9f4e1759 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index 8a46c6f67b0..7341bde255a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index cb90d93cb79..678e06894cf 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a potential energy surface diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index 733d4c8277c..1a82bfdce6a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index 68eaa5761eb..95784dfeae0 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Implements a 1D Harmonic potential. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index da6f3f38902..a15fe565b52 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Implements a 1D Morse potential. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index 8392847ad0e..cb890fa02a5 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index c0c00c120c7..ade52ca142c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 99017d8e488..c004de492b1 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index 2341a7c7d9c..ee8255e252c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index 29cfa9f88d3..569f6c18cc3 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index b1947e992ce..b22de12768a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index ef6c3743cc4..90c899f760b 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Molecular ground state energy chemistry application diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index 95fbd8148ce..601b1556cb0 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index c9741d7f883..2c208b36d4a 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.md index da4ed5ec922..e45794763ef 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.md index 239682a0ea6..ba1f0dd9c10 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.initial_states.VSCF.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/initial_states/vscf.py "view source code") Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.md index 58e27f81d34..498a34fa689 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.CHC.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/variational_forms/chc.py "view source code") This trial wavefunction is the Compact Heuristic for Chemistry. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.md index 9ddad802c0c..b118f7a3786 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.md index 96b64f3beb8..f80d6138bad 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.components.variational_forms.UVCC.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.md index 70957a51062..79c64c641a3 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.ChemistryOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") Base class for ChemistryOperator. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.md index bf2430d86f3..8226105858c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.Hamiltonian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/hamiltonian.py "view source code") A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.md index cd272ff1408..16eda60e1d2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularChemistryResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular chemistry Result diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.md index 957d51ac518..1b489c9ddb2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Excited States Result diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.md index fd862f2a24d..0e8c6908c0e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Ground State Energy Result. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.md index 27c9d199bb3..27730cbc35c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.QubitMappingType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/hamiltonian.py "view source code") QubitMappingType enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.md index 06cd0029ce2..083f7e3ee61 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.core.TransformationType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/core/hamiltonian.py "view source code") Transformation Type enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.md index fa8beb5edeb..45430cf1794 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BaseDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/base_driver.py "view source code") Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.md index fc1fbe8e1a5..52749927e7c 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BasisType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Basis Type diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.md index 94ae832398f..512d340b2c5 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.BosonicDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Base class for Qiskit’s chemistry bosonic drivers. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.md index a9d98e8e7dc..a1ee1df0ca9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Qiskit chemistry driver reading an FCIDump file. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.md index fa5d8e9f9a8..0a4ee8f4e16 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.FermionicDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Base class for Qiskit’s chemistry fermionic drivers. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.md index b13290a7c71..720271b6bcc 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.md index e6ff8d61043..e00dc12e602 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.md index 9311918f1bc..10a4a8fd88e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.md index cfef30e975e..bbdcfc4ba98 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.GaussianLogResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.md index 1d18c471377..7f1785a2fd4 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HDF5Driver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.md index c304d40905a..7cd48beb185 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.HFMethodType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/fermionic_driver.py "view source code") HFMethodType Enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.md index 87884c16945..40df66a1e8e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.InitialGuess.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Initial Guess Enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.md index 50102d4f7cc..1a160d8a02e 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.Molecule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/molecule.py "view source code") Driver-independent Molecule definition. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.md index e2491cb70b5..81a5f0c7974 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PSI4Driver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.md index ad2a056f23d..f584afcf4f2 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.md index 27e7558420e..a3d4a073610 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.PySCFDriver.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.md index 25d0c216e19..d7901071020 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.drivers.UnitsType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/drivers/units_type.py "view source code") Units Type Enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.md index 8e1f05c0b53..09c28ec4aa9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.BOPESSamplerResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/bopes_sampler_result.py "view source code") The BOPES Sampler result diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.md index 9d7adde9199..ea28a1fdee6 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.EigenstateResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/eigenstate_result.py "view source code") The eigenstate result interface. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.md index 0150297fcfd..3443afd1af3 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.ElectronicStructureResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/electronic_structure_result.py "view source code") The electronic structure result. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.md index 328e80dc254..c5c3269ece9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.results.VibronicStructureResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/vibronic_structure_result.py "view source code") The vibronic structure result. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.md index d5769ee1e5d..0c23249000b 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.md index 3b487611bc5..baab24522b9 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.md index fc19fb5f155..22972dae3f1 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicTransformationType enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 4ad354b5bea..0e516086649 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.md index efdda4c10a1..271c2fb3c08 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.md index 5137a522576..935032bedb4 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.md index 11fd6780727..605206268ca 100644 --- a/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.24/qiskit.chemistry.transformations.Transformation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/transformations/transformation.py "view source code") Base class for transformation to qubit operators for chemistry problems diff --git a/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.md index ea5cfbf6d98..ddb0678806b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.AncillaQubit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register, index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register, index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.md index 95800130bde..df5d30b617d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.AncillaRegister.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") Implement an ancilla register. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.md index af64e3bd8d6..0f8d131eede 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.ClassicalRegister.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalregister.py "view source code") Implement a classical register. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.24/qiskit.circuit.Clbit.md index d1671a56c9b..c537b03fd27 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Clbit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register, index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register, index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalregister.py "view source code") Implement a classical bit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.md index b94cd9f86fb..6eb1bdfd600 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.ControlledGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/controlledgate.py "view source code") Controlled unitary gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Delay.md b/docs/api/qiskit/0.24/qiskit.circuit.Delay.md index 0eda57e96e3..0a99b45c15f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Delay.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/delay.py "view source code") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.md index 4834d0d684e..4ac3ee288ec 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.EquivalenceLibrary.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/equivalence.py "view source code") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Gate.md b/docs/api/qiskit/0.24/qiskit.circuit.Gate.md index 0c0f5bd8d56..26135c6397c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/gate.py "view source code") Unitary gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.24/qiskit.circuit.Instruction.md index 55909149a66..16345bb2a91 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Instruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/instruction.py "view source code") Generic quantum instruction. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.md index 3b96bba1832..fd264c764bf 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.InstructionSet.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/instructionset.py "view source code") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Measure.md b/docs/api/qiskit/0.24/qiskit.circuit.Measure.md index 8971ce935c0..d4655132dba 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Measure.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.24/qiskit.circuit.Parameter.md index bcfd8fb094d..ec7be2d767c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Parameter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/parameter.py "view source code") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.md index f69396fa732..22f0d0ed4fa 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.ParameterExpression.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/parameterexpression.py "view source code") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.md index 0d423d36f4e..9a47c11382d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.ParameterVector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/parametervector.py "view source code") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.md index 1bf161b283c..067e6e617b7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.QuantumCircuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumcircuit.py "view source code") Create a new circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.md index 9f9dd459282..4ca60729afb 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.QuantumRegister.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") Implement a quantum register. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.24/qiskit.circuit.Qubit.md index d053fbb4fff..5681c18fe18 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Qubit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register, index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register, index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/quantumregister.py "view source code") Implement a quantum bit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.Reset.md b/docs/api/qiskit/0.24/qiskit.circuit.Reset.md index 4367ac69a83..f5737d0f4d8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.Reset.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.md index 716e65a45e2..3d874159154 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 5ab1e6ba25a..dd7209de3f7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 0db6e4258fc..0f328f8bc9d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.24/qiskit.circuit.library.AND.md index d4365e8c8f2..9ac32cba71c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.AND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.md index e16204b0e4a..cedfc4a2d24 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Barrier.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/barrier.py "view source code") Barrier instruction. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.md index b27ade56728..caa921c559f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.C3SXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.md index 722fbf85ae7..1fc53deda12 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.C3XGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.md index 55350ac85ba..6d7abe68440 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.C4XGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.md index 37b16d864d6..b4d307c2e91 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CCXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.md index 9d733d511db..c2486868dd7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CHGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/h.py "view source code") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.md index a2ab4f521f5..57d98393e81 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CPhaseGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.md index 8d4acc02d83..1e3578838bb 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CRXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rx.py "view source code") Controlled-RX gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.md index b7cb8b84b1a..e0ed32c335b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CRYGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ry.py "view source code") Controlled-RY gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.md index 9180b2397bf..64d76d1db75 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CRZGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rz.py "view source code") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.md index 843baebea1a..b3642e0cdc8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CSXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/sx.py "view source code") Controlled-√X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.md index e23b27d2e81..6b1e4654b20 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CSwapGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/swap.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.md index a10f306208a..69abab13b4b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CU1Gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.md index c5941a2e434..12432b6ec30 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CU3Gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u3.py "view source code") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.md index c906a047503..da52ce7ba59 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CUGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u.py "view source code") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.md index 28faa3733e1..0edf79fc3b8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.md index c8a14e176a3..6f12d984003 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CYGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/y.py "view source code") Controlled-Y gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.md index 37955d0333a..0732195eb1e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.CZGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/z.py "view source code") Controlled-Z gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.md index a62d3d66f36..b0172198367 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.DCXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/dcx.py "view source code") Double-CNOT gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.md index 3f0af1ec886..4afa8f4f39b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Diagonal.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Diagonal circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.md index a377a8217e7..5e9c943ddbd 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.EfficientSU2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/efficient_su2.py "view source code") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.md index 1058e4f6441..e6352256ee7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ExcitationPreserving.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") The heurisitic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.md index df0ab492604..376ab7c370d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.FourierChecking.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/fourier_checking.py "view source code") Fourier checking circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.md index 78379836264..0420fcac5fe 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.FunctionalPauliRotations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.md index 3bb88747b72..47931ecbe7c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GMS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GR.md index c699e0b30cb..0f451dc2bf2 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GR.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global R gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.md index 6feee87972a..5e9f0780dcf 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GRX.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RX gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.md index fbb59b98cd1..0528b7f68f9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GRY.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RY gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.md index 182a3c52611..7d00f461f50 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GRZ.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RZ gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.md index 65cdbc837f4..575b12e95e5 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GraphState.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/graph_state.py "view source code") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.md index 9b1abbf04f1..b1ba2f6f19d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.GroverOperator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/grover_operator.py "view source code") The Grover operator. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.md index 767507816ec..6f464ebca96 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.HGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/h.py "view source code") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.md index 94b30dc2274..e7e7b0dd6ea 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.HiddenLinearFunction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/hidden_linear_function.py "view source code") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.md index 57f51161025..fdb6f746c94 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.IGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/i.py "view source code") Identity gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.md index 4252148ab33..eea61024f9b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.IQP.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/iqp.py "view source code") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.md index 1caf696ccb8..52618346a7b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.InnerProduct.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") An n\_qubit circuit that computes the inner product of two registers. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.md index 8221000d114..9c8d00a8876 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.IntegerComparator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Integer Comparator. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.md index 958233d9af1..224a08a665c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.md index ded8b65d863..bee63e1ab5b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.LinearPauliRotations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.md index fbb2f929c55..6d91d337842 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.LogNormalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.md index 5960cc11979..cb964a3cc7c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMT.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.md index 01bdbb61df2..a672ce6a0a7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCMTVChain.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.md index 1cefc70640c..604a36a6b1d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCPhaseGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/p.py "view source code") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.md index 2f611b02b69..748d0673c71 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The general, multi-controlled X gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.md index 7e5662bc5fe..fb3ce469ad9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXGrayCode.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.md index 63e8cec31ae..5fdfd5ba8a9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXRecursive.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using recursion. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.md index 7f09eb9c14e..59a82c8a517 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MCXVChain.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using a V-chain of CX gates. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.md index ab3018ca728..94afc5d0788 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.MSGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ms.py "view source code") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.md index 8658402ccb5..d12a83a11da 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Measure.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.md index 8355eebb97b..a459be4837c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.NLocal.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/n_local.py "view source code") The n-local circuit class. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.md index c5a5bc202f8..9baaa5e1995 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.NormalDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/probability_distributions/normal.py "view source code") A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.24/qiskit.circuit.library.OR.md index bcca1944e31..9b92b025bc9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.OR.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.md index d1cf154804a..fca00ae6f19 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PauliFeatureMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.md index 8ee2c9d1994..9da8a095f82 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Permutation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/generalized_gates/permutation.py "view source code") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.md index d0bffc85276..d41f7634f64 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseEstimation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/phase_estimation.py "view source code") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.md index b901c00e760..e3c198fa4b8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PhaseGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/p.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 1cacdfde75e..75afbba6861 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.md index 5157e19129a..93ec310c1c6 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.PolynomialPauliRotations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.md index a0ac4c04a9b..656466b9b52 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.QFT.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/basis_change/qft.py "view source code") Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.md index a61e210cb39..1db2612efe7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.QuadraticForm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Implements a quadratic form on binary variables encoded in qubit registers. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.md index 38d06dd01be..edf9cde4aad 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.QuantumVolume.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/quantum_volume.py "view source code") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.md index 1037be08cfd..25e397dcc98 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RC3XGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.md index f73b1c5fe33..57d751cfc6e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RCCXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.md index 3c1106b30f0..0ace55839a5 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rx.py "view source code") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.md index 98cb6201508..3f7228ac9ec 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RXXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rxx.py "view source code") A parameteric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.md index 9ef5fa1c7ba..55687c577e1 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RYGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ry.py "view source code") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.md index a0fe6dd695d..99557521b94 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RYYGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/ryy.py "view source code") A parameteric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.md index eb29623e9f5..0b8dd6a6c23 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RZGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rz.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.md index b09491a31e0..b92c4b8f92a 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RZXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rzx.py "view source code") A parameteric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.md index 36bbc631c96..83b0048c539 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RZZGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/rzz.py "view source code") A parameteric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.md index 4b60f39909e..d4b2093f072 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.RealAmplitudes.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.md index 6a1fb786858..03a4e96ee8f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.Reset.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.md index ad0d9a0c0ae..d13684e9c77 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.md index 6e0e5309cfa..a01132f1c71 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SXGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/sx.py "view source code") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.md index 76c8a09fc92..5e8e640db72 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SXdgGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/sx.py "view source code") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.md index 2332be3e977..da5f7e9eea2 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SdgGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.md index d8f6b206e8a..8d1b565d907 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.SwapGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/swap.py "view source code") The SWAP gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.md index 2c96bc5afc0..fe01d59ee7c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.TGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.md index c6ed61a8db0..8893c1c74be 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.TdgGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.md index 3f56d136c35..e5e2534ba4e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.TwoLocal.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/two_local.py "view source code") The two-local circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.md index 45d7a16d3cb..d4e080206a9 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.U1Gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u1.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.md index ed9fb61c418..7ce5886ff50 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.U2Gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u2.py "view source code") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.md index f13c1e357d8..b4ac8eab67d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.U3Gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u3.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.md index 626f69dad43..194f852b077 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.UGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/u.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.md index 12d67d799d6..fad5029db3d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.UniformDistribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/probability_distributions/uniform.py "view source code") A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.md index a4459bdbab6..18b64fc3778 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.WeightedAdder.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.md index 0edc51266ad..8531bd5a5c5 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.XGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/x.py "view source code") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.md index 900fc888c3d..b3b47dd620d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.XOR.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.md index 454878df476..6be5d156781 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.YGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/y.py "view source code") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.md index b5461b83187..0e362b33dc7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ZFeatureMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.md index 45586efeecc..503a5875946 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ZGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/z.py "view source code") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.md index eb89f2ba606..494ef37d36c 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.ZZFeatureMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.md index 5aea2c058a0..88d40f51a03 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.iSwapGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/standard_gates/iswap.py "view source code") iSWAP gate. diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 57e9ad48d77..3bcf7da05a4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index fa83b8e5781..ea31e3efaf4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 0a037e63b5a..3ce82eb6b47 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 2ee272edfc8..e50c36fa025 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 613c818d209..ea842ec4596 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 75235055fb4..41ff257366d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 4afa0525d0c..f70c81a1d46 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 31d0109337e..e2146991811 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 77711d41e0a..e659948c3b3 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index caf89ea4a69..0a208dbc6d3 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 802646609cb..6e8fcb279fa 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index 29e81934851..19f8c167cb2 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index a6751fac24d..654b3390dd7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index c2281ae4127..cf4b9fa0684 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index c2d81dfcb2c..5c19234cf30 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 65740c32a14..c1a46239bce 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 1560b68be35..d0bd2457ef4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index e463aae98d4..9ede107774f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 08255d1b1e8..31749009815 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 679e21da837..7bf6d6fe607 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 948f0a4e2bd..b18c4774b35 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 7ce101407eb..d301eae929e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 3df0a0aa7b7..bdc0a2b90a8 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index bcde339ad5b..6f7da894156 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 915cc9430e9..42bacfb0979 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index c0d7fbdf523..13fd25cada7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index f7e8d0ee7bb..e34c7d8e3c2 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index a2d44bcc620..41fd6c2523b 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index fb749acff7e..d0f20c975d4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index a6f7159a5d9..1b21d3eec87 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index c782bcfb905..84ac7ced2a7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index ed9000d41e3..4ba5580bd2d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index c1a556bc8ec..32a3170ce5e 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 77065cdc712..2da5d172dd4 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 675c3a3d646..de42485c9a1 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index bd0c33be5aa..1df27aa2496 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 2335479d4bd..1915fcdfaf7 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 5d0b353c59c..e38fba839da 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 4f6522e39dd..b57dacaecb6 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index cf47d4e4cf2..cc2093548e2 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 6b570254ed4..4e2fc5dfe17 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 76581333fc1..5cb6ab6422d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index cf9f84c55d8..ab925ca256f 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 3141dbeb938..2bb8da50996 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 15c39c0509a..375ad534c08 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index ddbd691ae54..e4206cbd430 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 57605796da4..34f8f06cfaf 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.24/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.24/qiskit.circuit.random.random_circuit.md index 25950902524..51496c7479d 100644 --- a/docs/api/qiskit/0.24/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.24/qiskit.circuit.random.random_circuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.24/qiskit.compiler.assemble.md b/docs/api/qiskit/0.24/qiskit.compiler.assemble.md index aeff7214a01..1f75c719046 100644 --- a/docs/api/qiskit/0.24/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.24/qiskit.compiler.assemble.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/assemble.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/assemble.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.24/qiskit.compiler.schedule.md b/docs/api/qiskit/0.24/qiskit.compiler.schedule.md index a95de2fa9be..f9f1f4ce6ba 100644 --- a/docs/api/qiskit/0.24/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.24/qiskit.compiler.schedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/schedule.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/schedule.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.24/qiskit.compiler.sequence.md b/docs/api/qiskit/0.24/qiskit.compiler.sequence.md index 73c36f34767..967672f50b8 100644 --- a/docs/api/qiskit/0.24/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.24/qiskit.compiler.sequence.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/sequence.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/sequence.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.24/qiskit.compiler.transpile.md b/docs/api/qiskit/0.24/qiskit.compiler.transpile.md index 79110dee651..2a496f43abe 100644 --- a/docs/api/qiskit/0.24/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.24/qiskit.compiler.transpile.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/transpile.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/compiler/transpile.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.24/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.24/qiskit.converters.ast_to_dag.md index 7953f783bd4..434b2a25414 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.24/qiskit.converters.ast_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dag.md index 6b72ea07384..a5f89a46932 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dagdependency.md index 9317a86add3..2a8ab95ac30 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_dagdependency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_gate.md index e527fd9e704..9a4c4e68c4d 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_instruction.md index ca04a17e9f2..5000975b7ae 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.24/qiskit.converters.circuit_to_instruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.24/qiskit.converters.dag_to_circuit.md index e3c88bb6d94..d236a0a17ba 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.24/qiskit.converters.dag_to_circuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.24/qiskit.converters.dag_to_dagdependency.md index 7e63d07dc2e..f132cb82d2b 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.24/qiskit.converters.dag_to_dagdependency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_circuit.md index 0cc626df815..487680598cc 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_circuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_dag.md index 2095d29b8a1..bf97dc09d56 100644 --- a/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.24/qiskit.converters.dagdependency_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.md index e55209474f4..a7daec70da8 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagcircuit.py "view source code") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.md index d56efe37878..f120910f4df 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGCircuitError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.md index e7da38334d1..492c82b5f86 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDepNode.md @@ -12,7 +12,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagdepnode.py "view source code") Object to represent the information at a node in the DAGDependency(). diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.md index 5d19b6ed74f..a567168d1ac 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGDependency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagdependency.py "view source code") Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.md index b39e28f200c..1ec28aba1a8 100644 --- a/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.24/qiskit.dagcircuit.DAGNode.md @@ -12,7 +12,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/dagcircuit/dagnode.py "view source code") Object to represent the information at a node in the DAGCircuit. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.md index 125445ee164..0437191a8e9 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.24/qiskit.extensions.HamiltonianGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/hamiltonian_gate.py "view source code") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.24/qiskit.extensions.Initialize.md index aff6c814438..940ad94563e 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.24/qiskit.extensions.Initialize.md @@ -12,7 +12,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/quantum_initializer/initializer.py "view source code") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.md index f625dfb6224..0de118e77ae 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.24/qiskit.extensions.Snapshot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/simulator/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.md index 61242120afe..2cf660e86f3 100644 --- a/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.24/qiskit.extensions.UnitaryGate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/extensions/unitary.py "view source code") Class for representing unitary gates diff --git a/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.md index 01f1eb99be0..cac69542913 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.24/qiskit.finance.QiskitFinanceError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio.md index d2300bc15ba..c7aa83f2b76 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio.md @@ -28,7 +28,7 @@ Convert portfolio optimization instances into Pauli list -`get_operator(mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") +`get_operator(mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") get qubit op @@ -36,7 +36,7 @@ get qubit op -`portfolio_expected_value(x, mu)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_expected_value(x, mu)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio expected value @@ -44,7 +44,7 @@ returns portfolio expected value -`portfolio_value(x, mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_value(x, mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio value @@ -52,7 +52,7 @@ returns portfolio value -`portfolio_variance(x, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_variance(x, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio variance @@ -60,7 +60,7 @@ returns portfolio variance -`random_model(n, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") +`random_model(n, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio.py "view source code") Generate random model (mu, sigma) for portfolio optimization problem. diff --git a/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio_diversification.md index b2ad96495e0..75ddadb9509 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.24/qiskit.finance.applications.ising.portfolio_diversification.md @@ -26,7 +26,7 @@ portfolio diversification -`get_operator(rho, n, q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_operator(rho, n, q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Converts an instance of portfolio optimization into a list of Paulis. @@ -48,7 +48,7 @@ operator for the Hamiltonian -`get_portfoliodiversification_solution(rho, n, q, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_solution(rho, n, q, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. @@ -71,7 +71,7 @@ a vector describing the solution. -`get_portfoliodiversification_value(rho, n, q, x_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_value(rho, n, q, x_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). diff --git a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 9926555a5c6..afaff6b4064 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") The European Call Option Delta. diff --git a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index 71d7d9510ce..0cda21b29e5 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 11f2b35910a..c98afa39078 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.24/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.md index 2691caaaa04..902798f1cc3 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.BaseDataProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/_base_data_provider.py "view source code") The abstract base class for data\_provider modules within Qiskit’s finance module. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.md index 35c6dd1f2df..34b6b9dbffb 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.md index 2e5ce97d661..892035dcf6a 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Exchange data provider. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.md index 912aee68f94..8c1384d60b8 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.RandomDataProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/random_data_provider.py "view source code") Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.md index beb1b82c797..221c4ff4c8c 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.StockMarket.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/_base_data_provider.py "view source code") Stock Market enum diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.md index 978777e9c1f..2716873411d 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Wikipedia data provider. diff --git a/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.md index 6d8d7730d75..584241088a7 100644 --- a/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.24/qiskit.finance.data_providers.YahooDataProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Yahoo data provider. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.md index 1ca30f96044..ced5e4b5458 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.md index 176a96f07b2..c2ebe140507 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AmpCalFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.md index 45a2f5ab2a8..1eb12d762f1 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.md index d226e1cb574..a5ab1fceb97 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.AngleCalFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.md index 27c02e45ecd..a0f9e81d6b0 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.md index 5811c84bc24..8970dc4fe47 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.BaseGateFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.md index 70c6916e436..47c292984f2 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.DragFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Drag Experiment fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.md index 3e7e3a35eca..c2be793ae10 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.RabiFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Rabi Experiment fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.md index 57752db08bc..71cdcee018d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T1Fitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.md index 4efc1366a3b..b8b75326d37 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2Fitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.md index 3a813129d40..83556a39ada 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.T2StarFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.md index 7a7b5adb4ca..fa84e52292d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ZZFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") ZZ fitter diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_1Q_circuits.md index c0ff8e18914..bca2b4021ef 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_cx_circuits.md index c46f3cb6a59..6a1046f8c66 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 83cffb838f5..0b472099489 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_cx_circuits.md index 8be54e65c3c..d9d40e2f6b9 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.drag_schedules.md index a1b64ac2bff..bc6e3c8a21a 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.drag_schedules.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.get_single_q_pulse.md index 768ac12e6ad..3fff2c515b4 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.get_single_q_pulse.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.rabi_schedules.md index 3c755ae3446..82e6f5251d3 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.rabi_schedules.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.t1_circuits.md index 56f8a5898ef..558f3350a2a 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.t1_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2_circuits.md index 92139ad6d37..639f92e858f 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2star_circuits.md index 80c35232f1c..5b61ce48cbc 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.t2star_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.update_u_gates.md index d3310bf241e..fb7973a6429 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.update_u_gates.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.24/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.characterization.zz_circuits.md index b9c09e6d81b..91f6b1c4d0a 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.characterization.zz_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.md index bf24d3860cc..530e2a5e9eb 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogReader.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") Class to read from Ignis log files diff --git a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.md index 01371b1668d..2302698185b 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogger.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.md index 29f3041002d..fc9d9f76e45 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.logging.IgnisLogging.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/logging/ignis_logging.py "view source code") Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.md index f5896734072..5d356a624d1 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.DiscriminationFilter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/filters.py "view source code") Implements a filter based on a discriminator that takes level 1 data to level 2 data. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.md index dd17c761a35..0d739fdcd54 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Abstract discriminator that implements the data formatting for IQ level 1 data. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.md index 08484d0f763..41bd53935c7 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index e338f9602ca..bf2cc0a8a59 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.md index 1db0dd101b1..b9d710e1d79 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index ada163ca64f..c127b61263f 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 66e86837a1a..1ae772d61e6 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.md index ad20567e7c5..55f87303fa7 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index b379ea8c522..2c728d7a301 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/fitter.py "view source code") Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.md index ded53cc7fee..e09cfb68958 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.MeasurementFilter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/filters.py "view source code") Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 7827d2d4e1b..1b7c81ebaf7 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.md index 6f72055b617..316b571cc89 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredFilter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/filters.py "view source code") Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.md index 3c175d4f59d..b0fa5fa3e3f 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.complete_meas_cal.md index 2fbb4e0c056..3174f563f4d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.complete_meas_cal.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expectation_value.md index 0a6be171d09..88982fc6114 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expectation_value.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index 248a187565d..469963f1093 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.tensored_meas_cal.md index c948806dbf1..7dc94682250 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.md index 087bfa5c984..e9f367d9847 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationCircuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/circuits.py "view source code") This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.md index 9d234221aed..f2caefebd3e 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.AccreditationFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/fitters.py "view source code") Class for fitters for accreditation diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.md index dcb98c01adf..19ba003479e 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.BConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.md index a66281fcb6b..0ac9ed541da 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedral.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.md index da2a74c1822..e85fb398d3c 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.md index 04f2ee89e19..799ff0fc15b 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.md index fac91b7acd8..dc3ce8122f5 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.GraphDecoder.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.md index cfb01e327eb..77b486634a7 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.InterleavedRBFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.md index 039cd558b5a..1af6ed8d16a 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.Plotter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.md index 4d7ac330152..b1af1ca8055 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.md index 5200396d7e0..095f21a23e1 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.PurityRBFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitter for purity RB. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTP.md index 302c4be1f23..99b639390dd 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTP.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTPCorrectCounts.md index 0bcde1140b2..2ccd569dd37 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.md index 6ccbd87a24d..8dc7e2de101 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.QVFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.md index 3d7ea9dd854..ae380c37187 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.RBFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.md index 3a94595b437..e4897636a3d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.RepetitionCode.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.md index f37bd2ebb99..b06ba580563 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.StateTomographyFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.md index fd6e861ccd7..a54c30b2fff 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.TomographyFitter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epc.md index 3cd360d3949..cf74f5a3e24 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epc.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epg.md index 5d4dff06ffa..a70cdddea97 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_1q_epg.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epc.md index 9b2399fcbf3..df0188c4418 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epc.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epg.md index bf37e22574a..4d0b007aa5a 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.calculate_2q_epg.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.coherence_limit.md index c21631165fc..96e3ba2f8a2 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.coherence_limit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.combine_counts.md index c763a2fecee..6c363eb6361 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.combine_counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z.md index 7066a9a939f..68631b12a7b 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z_expvalue.md index 43be397f722..8ee9c66cae3 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.count_gates.md index c9caa5426cc..9255aeb41b8 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.count_gates.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.count_keys.md index b2163b5f562..11320b343f9 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.count_keys.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.expectation_counts.md index 7ce118ff7e8..c4551d5df3d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.expectation_counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.gates_per_clifford.md index d020a88c617..4da69f7b8ba 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.gates_per_clifford.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.gateset_tomography_circuits.md index 62ebc23c17b..1bb5b0b5257 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc.md index 82ef9e7c077..2c7b4d1582d 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc_para.md index e9c8977d15d..00e59c93eff 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po.md index e8bb579235a..f8d10ba871e 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po_para.md index a40d3552707..0959be26997 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_po_para.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_simple.md index af83cf62c0b..9dcfc1be18c 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.get_ghz_simple.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.lookuptable_decoding.md index 41e71101278..8387296ba70 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.lookuptable_decoding.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.marginal_counts.md index f4e6cda62d1..20497b4f4d8 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.marginal_counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.ordered_list_generator.md index 165b23afab0..d7eebab2d25 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.ordered_list_generator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.postselection_decoding.md index bce94953904..7af70933c79 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.postselection_decoding.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.process_tomography_circuits.md index fa77797e08b..a90b0b53875 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.process_tomography_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.qv_circuits.md index f1314e3bb78..2efbc644a44 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.qv_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.randomized_benchmarking_seq.md index c461232a367..d7b3f365365 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.rho_to_fidelity.md index 4f9725916a9..62a76dd8a32 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.rho_to_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.state_tomography_circuits.md index f5ebff9fc90..75c40889549 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.state_tomography_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.24/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.24/qiskit.ignis.verification.twoQ_clifford_error.md index 84f59530d3d..65c43a67623 100644 --- a/docs/api/qiskit/0.24/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.24/qiskit.ignis.verification.twoQ_clifford_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.5/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.ad_hoc_data.md index 064e107d4b7..d3039a542ce 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.ad_hoc_data.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.breast_cancer.md index 79f2ce83c23..59a034183bd 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.breast_cancer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.digits.md index 224debe833e..a2b90f82dd5 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.digits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.gaussian.md index 0721e0bd6e1..65e3a232216 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.gaussian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.iris.md index 35948de84f0..46dae5ce1f0 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.iris.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.sample_ad_hoc_data.md index 6ca17bb4c57..8cb1b479db3 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.24/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.24/qiskit.ml.datasets.wine.md index 07cc1a156ed..c305cd08b3f 100644 --- a/docs/api/qiskit/0.24/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.24/qiskit.ml.datasets.wine.md @@ -12,7 +12,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.md index 8644ddc3028..e2193793cd0 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.md index 6b66992f241..7c7534a52ae 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.QuadraticProgram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 9bf962d4717..05226f7f42a 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") ADMMOptimization Result. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.md index 92e529700a3..780ce567cfd 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.md index 72742464861..8f7de02c1a3 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMParameters.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.md index 34c71079791..c0a1e4272be 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.ADMMState.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.md index 31325b94199..02d16e6039c 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.md index 6647a51357a..9b58d6c06f3 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.CplexOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.md index de1d2fda74e..ef8920ff5b7 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/grover_optimizer.py "view source code") A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.md index 3809e1905eb..5cfc1486afa 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.GroverOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.md index 8264b406f95..b309a27f2c9 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.IntermediateResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index b97df5163b5..a08bbeb37b6 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples, min_eigen_solver_result=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples, min_eigen_solver_result=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index ef0add30481..3408bfda3b5 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.md index 9d770497094..36d79f0df45 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") An abstract class that implements multi start optimization and should be sub-classed by other optimizers. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.md index a3ff3adf95b..ab0cc6f7160 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") An abstract class for optimization algorithms in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.md index cd6dd18189f..0ac9ef61e35 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A base class for optimization results. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.md index 6887b4d052f..5c00c190cc4 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index 2397d61f82c..9e56b5a98b7 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index 40dcdb18fe0..9e6984fbb4b 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 10f4c152267..17fb0e1248f 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.md index e2aff35755e..aff8b4b6dfd 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.clique.md index fa1868aa69c..f5a0101e843 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.clique.md @@ -28,7 +28,7 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/clique.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/clique.py "view source code") Get graph solution from binary string. @@ -48,7 +48,7 @@ numpy.ndarray -`get_operator(weight_matrix, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/clique.py "view source code") +`get_operator(weight_matrix, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/clique.py "view source code") Generate Hamiltonian for the clique. @@ -91,7 +91,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`satisfy_or_not(x, w, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/clique.py "view source code") +`satisfy_or_not(x, w, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/clique.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.common.md index c003ce9bacc..5872b143c96 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.common.md @@ -29,7 +29,7 @@ common module -`get_gset_result(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") +`get_gset_result(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") Get graph solution in Gset format from binary string. @@ -49,7 +49,7 @@ Dict\[int, int] -`parse_gset_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") +`parse_gset_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") Read graph in Gset format from file. @@ -69,7 +69,7 @@ numpy.ndarray -`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") +`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") Generate random Erdos-Renyi graph. @@ -94,7 +94,7 @@ numpy.ndarray -`random_number_list(n, weight_range=100, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") +`random_number_list(n, weight_range=100, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") Generate a set of positive integers within the given range. @@ -117,7 +117,7 @@ numpy.ndarray -`read_numbers_from_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") +`read_numbers_from_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") Read numbers from a file @@ -137,7 +137,7 @@ numpy.ndarray -`sample_most_likely(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") +`sample_most_likely(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/common.py "view source code") Compute the most likely binary string from state vector. :param state\_vector: state vector or counts. :type state\_vector: numpy.ndarray or dict diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.docplex.md index 4be71c3c217..d8b128c844a 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.docplex.md @@ -64,7 +64,7 @@ print('tsp objective:', result['energy'] + offset) -`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/docplex.py "view source code") +`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/docplex.py "view source code") Generate Ising Hamiltonian from a model of DOcplex. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.exact_cover.md index f8cedeb67cf..bcab9eb5b7c 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.exact_cover.md @@ -26,7 +26,7 @@ exact cover -`check_solution_satisfiability(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`check_solution_satisfiability(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/exact_cover.py "view source code") check solution satisfiability @@ -34,7 +34,7 @@ check solution satisfiability -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/exact_cover.py "view source code") Construct the Hamiltonian for the exact solver problem. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/exact_cover.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.graph_partition.md index a30175cf7f4..617378a641f 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.graph_partition.md @@ -26,7 +26,7 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/graph_partition.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/graph_partition.py "view source code") Generate Hamiltonian for the graph partitioning @@ -76,7 +76,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`objective_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`objective_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/graph_partition.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.knapsack.md index 1c004d895ed..76c8d2f2d6b 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.knapsack.md @@ -30,7 +30,7 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We -`get_operator(values, weights, max_weight)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_operator(values, weights, max_weight)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/knapsack.py "view source code") Generate Hamiltonian for the knapsack problem. @@ -69,7 +69,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`get_solution(x, values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_solution(x, values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian @@ -92,7 +92,7 @@ numpy.ndarray -`knapsack_value_weight(solution, values, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/knapsack.py "view source code") +`knapsack_value_weight(solution, values, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the total wight and value of the items taken in the knapsack. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.max_cut.md index c87d9d0f57b..825f93b1fa1 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.max_cut.md @@ -26,7 +26,7 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/max_cut.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/max_cut.py "view source code") Generate Hamiltonian for the max-cut problem of a graph. @@ -66,7 +66,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`max_cut_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/max_cut.py "view source code") +`max_cut_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/max_cut.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.partition.md index 82ed1a0d98c..88a3718ec87 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.partition.md @@ -25,7 +25,7 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami -`get_operator(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/partition.py "view source code") +`get_operator(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/partition.py "view source code") Construct the Hamiltonian for a given Partition instance. @@ -47,7 +47,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`partition_value(x, number_list)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/partition.py "view source code") +`partition_value(x, number_list)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/partition.py "view source code") Compute the value of a partition. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.set_packing.md index 3c0f9e32e1e..cf821f2f3f8 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.set_packing.md @@ -26,7 +26,7 @@ set packing module -`check_disjoint(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/set_packing.py "view source code") +`check_disjoint(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/set_packing.py "view source code") check disjoint @@ -34,7 +34,7 @@ check disjoint -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/set_packing.py "view source code") Construct the Hamiltonian for the set packing. @@ -66,7 +66,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/set_packing.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.stable_set.md index e992bb76508..3e05629f52d 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.stable_set.md @@ -26,7 +26,7 @@ Convert stable set instances into Pauli list. We read instances in the Gset form -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/stable_set.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_operator(w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/stable_set.py "view source code") Generate Hamiltonian for the maximum stable set in a graph. @@ -66,7 +66,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`stable_set_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/stable_set.py "view source code") +`stable_set_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/stable_set.py "view source code") Compute the value of a stable set, and its feasibility. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.md index c39039a6a03..e1a7b4a8611 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.md @@ -92,7 +92,7 @@ Alias for field number 3 -`calc_distance(coord, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`calc_distance(coord, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") calculate distance @@ -100,7 +100,7 @@ calculate distance -`get_operator(ins, penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_operator(ins, penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") Generate Hamiltonian for TSP of a graph. @@ -121,7 +121,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_tsp_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_tsp_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") Get graph solution from binary string. @@ -147,7 +147,7 @@ Instance data of TSP -`parse_tsplib_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`parse_tsplib_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") Read graph in TSPLIB format from file. @@ -167,7 +167,7 @@ instance data. -`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") Generate a random instance for TSP. @@ -192,7 +192,7 @@ instance data. -`tsp_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") Check whether a solution is feasible or not. @@ -212,7 +212,7 @@ bool -`tsp_value(z, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_value(z, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/tsp.py "view source code") Compute the TSP value of a solution. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vehicle_routing.md index b553b05892c..2fdd38287fa 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vehicle_routing.md @@ -27,7 +27,7 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela -`get_operator(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_operator(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Converts an instance of a vehicle routing problem into a list of Paulis. @@ -49,7 +49,7 @@ operator for the Hamiltonian. -`get_vehiclerouting_cost(instance, n, K, x_sol)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_cost(instance, n, K, x_sol)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Computes the cost of a solution to an instance of a vehicle routing problem. @@ -72,7 +72,7 @@ objective function value. -`get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_matrices(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Constructs auxiliary matrices from a vehicle routing instance,** @@ -96,7 +96,7 @@ a matrix defining the interactions between variables. a matrix defining the cont -`get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_solution(instance, n, K, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Tries to obtain a feasible solution (in vector form) of an instance** diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vertex_cover.md index 133d6c4d5bc..b9871f8d1cb 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.vertex_cover.md @@ -26,7 +26,7 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https -`check_full_edge_coverage(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`check_full_edge_coverage(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vertex_cover.py "view source code") **Parameters** @@ -45,7 +45,7 @@ float -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Get graph solution from binary string. @@ -65,7 +65,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. :type weight\_matrix: numpy.ndarray diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.md index 455696f639f..2738de25801 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.InequalityToEquality.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.md index 500bd734eb3..442725f4ad5 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.IntegerToBinary.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.md index 90ce9d244d8..f4690f343fd 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.md index b59c63ee58a..06d0c1e7846 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/quadratic_program_converter.py "view source code") An abstract class for converters of quadratic programs in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.md index f5161befd4b..8e21c625f69 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a given optimization problem to a new problem that is a QUBO. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.md index 964c5810620..9b5425f9e00 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.Constraint.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/constraint.py "view source code") Abstract Constraint Class. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.md index a87b7a6828e..072d6d268ea 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearConstraint.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/linear_constraint.py "view source code") Representation of a linear constraint. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.md index 2169fecb74a..3b178edf6f9 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.LinearExpression.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/linear_expression.py "view source code") Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.md index 40d46e18c12..718ce07c273 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticConstraint.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_constraint.py "view source code") Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.md index 80650f97339..4fece7ae341 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticExpression.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_expression.py "view source code") Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.md index 1ba63bf9bfb..a3504b4bfd0 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticObjective.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_objective.py "view source code") Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.md index 7cc240a8727..27ebd806c95 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.md index 36f14cf9465..bc85099c9a8 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.QuadraticProgramElement.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/quadratic_program_element.py "view source code") Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.md index 06dc093cab1..9f6aa379888 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.24/qiskit.optimization.problems.Variable.md @@ -12,7 +12,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/problems/variable.py "view source code") Representation of a variable. diff --git a/docs/api/qiskit/0.24/qiskit.providers.Backend.md b/docs/api/qiskit/0.24/qiskit.providers.Backend.md index 3c2d9cb10db..e4934c19980 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.24/qiskit.providers.Backend.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/backend.py "view source code") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.md index 3e7325342c5..1f0baa912c6 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.BackendPropertyError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.24/qiskit.providers.BackendV1.md index a51cd1e6a52..a41422d250a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.24/qiskit.providers.BackendV1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/backend.py "view source code") Abstract class for Backends diff --git a/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.md index 1cdc78eb4e7..68cbe5598ec 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.24/qiskit.providers.BaseBackend.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basebackend.py "view source code") Legacy Base class for backends. diff --git a/docs/api/qiskit/0.24/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.24/qiskit.providers.BaseJob.md index 9b45166e603..db10bbf8043 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.24/qiskit.providers.BaseJob.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basejob.py "view source code") Legacy Class to handle asynchronous jobs diff --git a/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.md index f151d379461..0db55e7b964 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.24/qiskit.providers.BaseProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/baseprovider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.24/qiskit.providers.Job.md b/docs/api/qiskit/0.24/qiskit.providers.Job.md index d57e3c9c8ab..9a90747c797 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.24/qiskit.providers.Job.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/job.py "view source code") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobError.md b/docs/api/qiskit/0.24/qiskit.providers.JobError.md index a308b4c9c7d..8ccdf20d2ad 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.JobError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.24/qiskit.providers.JobStatus.md index ade75167fc1..29cd54e0a30 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.24/qiskit.providers.JobStatus.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/jobstatus.py "view source code") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.md index 99e592ece97..6eabdfdbb9e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.JobTimeoutError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.24/qiskit.providers.JobV1.md b/docs/api/qiskit/0.24/qiskit.providers.JobV1.md index eb4b30ed84d..e0540869430 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.24/qiskit.providers.JobV1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/job.py "view source code") Class to handle jobs diff --git a/docs/api/qiskit/0.24/qiskit.providers.Options.md b/docs/api/qiskit/0.24/qiskit.providers.Options.md index 261d9b3c72f..cdfdd1606a4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.24/qiskit.providers.Options.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/options.py "view source code") Base options object diff --git a/docs/api/qiskit/0.24/qiskit.providers.Provider.md b/docs/api/qiskit/0.24/qiskit.providers.Provider.md index 8ef6280b8a6..fd3b4aaf714 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.24/qiskit.providers.Provider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/provider.py "view source code") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.md index bd1c3ae1033..b34465a4007 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ProviderV1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/provider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.md index 2f4a00a461f..95fd2389405 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.QiskitBackendNotFoundError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.md index c5fc5599440..e61d63e6691 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.AerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.md index 707093e9ca7..fef3d84dcde 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.AerJob.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/aerjob.py "view source code") AerJob class. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.md index 709852f2fea..06728794f32 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.AerProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/aerprovider.py "view source code") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.md index 4372600ad57..ab7abf3b423 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.PulseSimulator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Pulse schedule simulator backend. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.md index 780ad6482f3..e325b1a4690 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.QasmSimulator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.md index d4226382d98..7d5fdb287f3 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.StatevectorSimulator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.md index bbc06965b90..8a5a7f5618a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.UnitarySimulator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.md index 79f793f413d..190e25f96dc 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.Snapshot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 3e5953ba480..bf5ff800a27 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Snapshot instruction for density matrix method of Qasm simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 3d1aa17a312..4cbd31bb8db 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Snapshot instruction for supported methods of Qasm simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 0ff793362ca..44b7c9d3a9a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Snapshot instruction for all methods of Qasm simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 10201a67470..dd542f53449 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Snapshot instruction for stabilizer method of Qasm simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.md index bb921cd218a..f7e148112aa 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Snapshot instruction for statevector snapshot type diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.md index 695297e5bb2..ffbf4819855 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.NoiseModel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/noise_model.py "view source code") Noise model class for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.md index 65e4995be7c..a0d5b2859ba 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.QuantumError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Quantum error class for Qiskit Aer noise model diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.md index 096351091bc..069eed1abcc 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.ReadoutError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Readout error class for Qiskit Aer noise model. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.amplitude_damping_error.md index 79bf1bb922b..76ef2fa77ec 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.coherent_unitary_error.md index 70ce7f992e3..59b3f9ef0c5 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.depolarizing_error.md index 1f6bd084101..85f658c654e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.depolarizing_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index c5927fd9ed8..346f8769b20 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index 968edcdec41..02ea4f36682 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_error_values.md index 5acf5658bc3..368a183388c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_error_values.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_length_values.md index 11570c3e5d9..638aa6ab165 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_length_values.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_param_values.md index 3749bc09ef7..7e7f20378c0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.gate_param_values.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.readout_error_values.md index d9090a010ef..6791d01db43 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.readout_error_values.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index f108d675b4a..321b2d4c9e6 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.kraus_error.md index 8950d3dba76..54cc41a35b0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.kraus_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.mixed_unitary_error.md index fc8b2568407..54b368ce38f 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.pauli_error.md index 9d9e3f7aa65..f1ce3efe89e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.pauli_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index 52e0703f140..46cfeb9717d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_damping_error.md index e76bbc6cad8..2ee8e09dd3a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.phase_damping_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.reset_error.md index de0cfe6745d..96057c0327d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.reset_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.thermal_relaxation_error.md index e750da76dd8..655f3d96373 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.md index 183ba0c69db..10fab2e0764 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Physical model object for pulse simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.duffing_system_model.md index 62522ba556b..3ed2389bfff 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.pulse.duffing_system_model.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.md index d924097f48a..387b98ebda4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.NoiseTransformer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transforms one quantum channel to another based on a specified criteria. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_noise_model.md index 52780a48ae7..b2d36943070 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_noise_model.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_quantum_error.md index 42a30401799..0b1053d1b55 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.insert_noise.md index efd055091cf..a3f683eeb4b 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.insert_noise.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.remap_noise_model.md index 04e63fd6e18..c25ace8992c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.24/qiskit.providers.aer.utils.remap_noise_model.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.7/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.md index e769597f28c..04a5d5d073d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.md index 636ff66f5e8..254e53b461f 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerJob.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, fn, qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, fn, qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/basicaerjob.py "view source code") BasicAerJob class. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.md index 191bf730924..afe92a5339d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.BasicAerProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/basicaerprovider.py "view source code") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.md index ec5328c06dc..8745fbef975 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/qasm_simulator.py "view source code") Python implementation of a qasm simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 03a4cb97f7a..eb8fc112265 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/statevector_simulator.py "view source code") Python statevector simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.md index 93fff507125..629571d9feb 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.24/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/basicaer/unitary_simulator.py "view source code") Python implementation of a unitary simulator. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.md index 95ea065d8f8..a25bf95c6d0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.AccountProvider.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/accountprovider.py "view source code") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.md index fbd902c74d2..0d6e0ad04bc 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.BackendJobLimit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/backendjoblimit.py "view source code") Job limit for a backend. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index 256cfbe102d..8a7cb81c4c9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index cdf185f283f..257368306b3 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index ce4afc7b4a9..a52d537b6ad 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 96459ba420f..857edd5da79 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.md index 66db6654f7a..5774b85df96 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 2c733064310..35e361ac60a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.md index 2f3cf32ab51..e395664f7c3 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackend.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackend.py "view source code") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.md index caa1c2d3a52..c6e4173f1a4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 01c590a20b1..409961471c0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.md index 2798beea958..13d9cef6369 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.md index 6b4cf28e014..e69590b0d92 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendService.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.md index d28826953cd..f2f485198a4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.md index 8b1c8197213..b088cf57449 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.md index 4291e0955f6..9fbfe3c053d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQFactory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqfactory.py "view source code") Factory and account manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.md index 5b851ef84c5..7096070c3f3 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.IBMQProviderError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.md index 96b9df10a31..f36341be660 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.Credentials.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/credentials.py "view source code") IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.md index 14e13d2a720..34114b8ce65 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 17f0a105843..89242b9ff06 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index ee620294dd5..ca2327d4c3d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.md index 6af4f61519b..b20792b36f4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.AnalysisResult.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult -`AnalysisResult(experiment_uuid, device_components, fit, result_type, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") +`AnalysisResult(experiment_uuid, device_components, fit, result_type, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") Class representing an analysis result for an experiment. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.md index 7b752a36f93..f91b1c03598 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.Experiment.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment -`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experiment.py "view source code") +`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experiment.py "view source code") Class representing an experiment. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.md index 019af27c47a..161f7f6858e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.experiment.ExperimentService.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService -`ExperimentService(provider, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") +`ExperimentService(provider, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") Provides experiment related services. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.md index c6ed988cef7..dcf2257ad0a 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJob.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.md index d90a91e91f5..c5dd5bce06c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.md index 65307ff9e03..20b4e7de736 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.md index dab8f637c67..ac3e5e88ade 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index fd36d3f2281..93030f138f9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 89dc7d8c5f1..24fb2aae640 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.md index ebd283f8284..f6af60962a8 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.QueueInfo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.job_monitor.md index 02acfa9bf01..896aaf1733d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.job.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.least_busy.md index 0af8939b956..f9af87b0914 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.least_busy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.md index 8adb0ab2407..b5010d4bf92 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index dd0d2e55cc6..df6d7a8e1a4 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 0d91927bcc3..0e2ef1a2485 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 8d55b30a32f..4bc86c4dec1 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 8c5e969a2ea..4e728b52232 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 500aa6b60bc..72f56537304 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 90ba089b889..bc514301990 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.md index ebfd52f8fd7..8fa3f62dc52 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJob.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjob.py "view source code") Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.md index 9deaf439eef..53abaeadffd 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjobset.py "view source code") A set of managed jobs. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.md index 3c076553dea..e038af71d9c 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.managed.ManagedResults.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedresults.py "view source code") Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.md index 89dd803d048..141dcd23a23 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.md index 43b313119ca..d4c451c035e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.md index 7ed9c359f9e..7596b272353 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.seconds_to_duration.md index 96aee5a1f2f..15663d7872e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.to_python_identifier.md index a26d7943e61..06e222f3501 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.update_qobj_config.md index b9cd2c7ab77..81b6f8f19c5 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.utc_to_local.md index 8cef9875f5b..03116387338 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.utc_to_local.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.validate_job_tags.md index ffa58780e81..2fe2b8976f9 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.24/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.md index 54f4a837e40..e4f6ed37423 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.BackendConfiguration.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") Backwards compat shim representing an abstract backend configuration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.md index e4f174c8656..da8fa082d5b 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.BackendProperties.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendproperties.py "view source code") Class representing backend properties diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.md index 587249ed32e..daffd93e7e0 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.BackendStatus.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendstatus.py "view source code") Class representing Backend Status. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.Command.md b/docs/api/qiskit/0.24/qiskit.providers.models.Command.md index f4fbbeb799a..34543bbf52d 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.Command.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/pulsedefaults.py "view source code") Class representing a Command. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.md index 8fa1cc21938..fd3d0f533af 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.GateConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Gate Configuration diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.md index 2ceba9c19be..0592f5e869e 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.JobStatus.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/jobstatus.py "view source code") Model for JobStatus. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.md index 33a8d0812bc..8b2a833f584 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.PulseBackendConfiguration.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.md index 753f748d164..eceee297f47 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.PulseDefaults.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/pulsedefaults.py "view source code") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.md index 36ee47ad5ed..a5f49b44e08 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.QasmBackendConfiguration.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Qasm Backend Configuration. diff --git a/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.md index fe6a43ec328..0172e3520f7 100644 --- a/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.24/qiskit.providers.models.UchannelLO.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a U Channel LO diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.24/qiskit.pulse.Acquire.md index 6020d9b767c..3ae33913c80 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Acquire.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.md index 1dc4468080e..1004aac5699 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.AcquireChannel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Constant.md b/docs/api/qiskit/0.24/qiskit.pulse.Constant.md index be68443060c..aac8b6d038b 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Constant.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.md index 0ce95ea91df..050de431b06 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.ControlChannel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Delay.md b/docs/api/qiskit/0.24/qiskit.pulse.Delay.md index f4157881fb8..94acc0c09c6 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Delay.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Drag.md b/docs/api/qiskit/0.24/qiskit.pulse.Drag.md index 8066323af93..b4cd1556014 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Drag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.md index cb71ad9d4c6..7bd43501800 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.DriveChannel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.md index 44ad058c148..f6971a52ab1 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Gaussian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.md index 9dc1917e18f..70557d92f52 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.GaussianSquare.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.24/qiskit.pulse.Instruction.md index 072364e6bea..82f71816b5f 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Instruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration, channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration, channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.md index 9541eddfb8b..07596c76663 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.InstructionScheduleMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instruction_schedule_map.py "view source code") Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.md index e8e4f848379..2d1be56b27d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.MeasureChannel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.md index 0a5327a73b8..9ef8b4a3296 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.MemorySlot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Play.md b/docs/api/qiskit/0.24/qiskit.pulse.Play.md index d4e958ee93c..7b4711984ef 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Play.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.24/qiskit.pulse.PulseError.md index 11be63e6c5c..9688621ac87 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.PulseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.md index 5d839476cae..12cd8975118 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.RegisterSlot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.24/qiskit.pulse.Schedule.md index 512cd3652ba..46cfd24f4d3 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Schedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/schedule.py "view source code") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.md index 4b0eab4d739..007ec73cffc 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.SetFrequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.md index d2955b7be1a..56ba0641e7e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.SetPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.md index 13b0713f8ae..1e66d832e4d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.ShiftFrequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.md index 3b7ca58bdd3..019d2dce80c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.md index db81a3868ea..92288b4a278 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Snapshot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.24/qiskit.pulse.Waveform.md index f7b4d44089e..e4189d7000c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.Waveform.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire.md index 276b0ea95b3..008d5ceae8c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire_channel.md index edb6d82c4b5..4ed9d5ee374 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.acquire_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.active_backend.md index 7021afc5f1a..66ec158ece1 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.active_backend.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.active_circuit_scheduler_settings.md index c6e25189f64..4abc1147f6e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.active_transpiler_settings.md index 7f352d2f16f..94910486b75 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.active_transpiler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_equispaced.md index 4c32edb7ca5..9a9fde47af4 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_equispaced.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_func.md index 819590d1789..acbfdf4481e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_func.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_left.md index 24676a3c2d2..367bebebffa 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_left.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_right.md index 0811265f5dd..6673b78b6a9 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_right.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_sequential.md index dddf0a656fa..031d29d8c1e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.align_sequential.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.barrier.md index 58a00bcdb93..a8396e3288e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.barrier.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.build.md index d3bc6afffa9..178231d9fdc 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.build.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.call.md index c6f14daf116..15aa26e7cbe 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.call.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`call(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.circuit_scheduler_settings.md index 02b4ac53d46..a8e192bf4ae 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.control_channels.md index 3e816828544..31f607f0f01 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.control_channels.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.cx.md index 607282745cb..43e3421461d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.cx.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.delay.md index 3f2e86d4c4c..3b3004806bd 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.delay.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`delay(duration, channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.delay_qubits.md index a9b02a1c82a..899bc3076fb 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.delay_qubits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.drive_channel.md index 6af28c1a9ef..54e5bd64def 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.drive_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.frequency_offset.md index 5907327081b..f5050c0f748 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.frequency_offset.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.inline.md index a537bbc89a8..7727d34adf0 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.inline.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.measure.md index 0692afa986e..2619b5e95f1 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.measure.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_all.md index ffb7f905159..6c3e0e3485d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_all.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_channel.md index 613db21cae0..bbf151c3893 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.measure_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.num_qubits.md index 3765c12ac0a..6e56ba77811 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.num_qubits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.pad.md index d7f2f14b8bd..6d4fc2c30b8 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.pad.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Pad all availale timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.phase_offset.md index 3dc4ac5b83f..e3da6b9cad0 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.phase_offset.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.play.md index 8cf611fbdcd..797babea5a8 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.play.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`play(pulse, channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.qubit_channels.md index d39159b1644..a93173f7116 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.qubit_channels.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.samples_to_seconds.md index 2238a5ab5a6..9a8f17f4e80 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.samples_to_seconds.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.seconds_to_samples.md index 414140e3db0..2d6e17f7c03 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.seconds_to_samples.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.set_frequency.md index 2e29e804415..19d2126c7c5 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.set_frequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.set_phase.md index 15899d12c35..b9051ffb49c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.set_phase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_frequency.md index eac89661507..da4a4fce6e4 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_frequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_phase.md index 33dba6dde49..c92f3fcf450 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.shift_phase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.snapshot.md index e32c9500449..ba32aae4a76 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.snapshot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.transpiler_settings.md index 47f16ac8108..9e44ac66dec 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.transpiler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.u1.md index a96df502d78..dd4df5d441c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.u1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.u2.md index 3d3a7eaff36..622e56dc734 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.u2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.u3.md index 7bbc96fb887..b4ab2fd9aa5 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.u3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.24/qiskit.pulse.builder.x.md index 54d52970725..2a9e282d5d4 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.builder.x.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.channels.md b/docs/api/qiskit/0.24/qiskit.pulse.channels.md index 1608f1113ff..826c8e142cb 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.channels.md @@ -36,7 +36,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. @@ -76,7 +76,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -124,7 +124,7 @@ A shorthand string prefix for characterizing the channel type. -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. @@ -164,7 +164,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. @@ -204,7 +204,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. @@ -244,7 +244,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. @@ -284,7 +284,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`PulseChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`PulseChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Base class of transmit Channels. Pulses can be played on these channels. @@ -324,7 +324,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). @@ -364,7 +364,7 @@ Return the shorthand alias for this channel, which is based on its type and inde -`SnapshotChannel`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") +`SnapshotChannel` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/channels.py "view source code") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.md index 8694768b2a9..e279fa60ac7 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Acquire.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.md index ec4e1dfbc39..c84012f9578 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Delay.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.md index 85c279460cd..e73b4f4923c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Instruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration, channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration, channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.md index e6acd8d0790..beb026767f7 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Play.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.md index f03e9a3b9b0..3a43525ec1e 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetFrequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.md index a79724b5a36..a408c8f4b64 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.SetPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.md index 284f7715a11..4d0cf513254 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftFrequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.md index 9f09551ec16..5cbb555d064 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.md index fdfe5712267..0445ac21ff9 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.instructions.Snapshot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.md index f2d9a67a47f..0f0ec91e03d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Constant.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.md index d88ff738163..a206960e616 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Drag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.md index 70d61c2152f..fe9c54423c2 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Gaussian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.md index 88ff3520e5a..8c59c7f0919 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.GaussianSquare.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.md index 538e9483e0a..0175ef6ff6d 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.Waveform.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.24/qiskit.pulse.library.discrete.md index fcd116e207f..9a9e23b031b 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.library.discrete.md @@ -38,7 +38,7 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -62,7 +62,7 @@ $$ -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -88,7 +88,7 @@ $$ -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -123,7 +123,7 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -161,7 +161,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -188,7 +188,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -228,7 +228,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -276,7 +276,7 @@ plt.plot(range(duration), sawtooth_wave) -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -312,7 +312,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -339,7 +339,7 @@ i.e. the derivative of $\text{sech}$. -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -365,7 +365,7 @@ $$ -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -393,7 +393,7 @@ with the convention $\text{sign}(0) = 1$. -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -441,7 +441,7 @@ plt.plot(range(duration), triangle_wave) -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). diff --git a/docs/api/qiskit/0.24/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.24/qiskit.pulse.transforms.add_implicit_acquires.md index 85046e511f1..c2a27686914 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.transforms.add_implicit_acquires.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/transforms.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/transforms.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.24/qiskit.pulse.transforms.align_measures.md index fd19f42ba7a..b788073f71c 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.transforms.align_measures.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/transforms.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/transforms.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.24/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.24/qiskit.pulse.transforms.pad.md index e77f4e31b00..b035980feeb 100644 --- a/docs/api/qiskit/0.24/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.24/qiskit.pulse.transforms.pad.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/transforms.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/pulse/transforms.py "view source code") Pad the input Schedule with `Delay`s on all unoccupied timeslots until `schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.md index 079813bd5a0..1d74569038f 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.24/qiskit.qasm.OpenQASMLexer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.24/qiskit.qasm.Qasm.md index 12f5351e846..210f39daaac 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.24/qiskit.qasm.Qasm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.24/qiskit.qasm.QasmError.md index 663d6600eac..e1438bd9f14 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.24/qiskit.qasm.QasmError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.md index d15dae36a5e..d81b0b4d4ba 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.24/qiskit.qasm.QasmHTMLStyle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.md index 728458a62b8..40a61151704 100644 --- a/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.24/qiskit.qasm.QasmTerminalStyle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.md index 8cc22abd4f7..93cb36e3a39 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.GateCalibration.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.md index 9fe0fabc582..5d59d18f9c7 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseLibraryItem.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") An item in a pulse library. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.md index 82af9f94e68..36ae503e189 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobj.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.md index 999e5347f89..2977758c37b 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") A configuration for a Pulse Qobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.md index e96e09d0edd..5eb22dfa16e 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperiment.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj Experiment. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.md index b879ee2a681..200a8060d1c 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjExperimentConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") A config for a single Pulse experiment in the qobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.md index 3c813cd58b6..48af8940fd2 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.PulseQobjInstruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") A class representing a single instruction in an PulseQobj Experiment. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.md index 9aa469125a2..71039689ab2 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmExperimentCalibrations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.md index e928481e796..57a836bc800 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobj.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.md index 9f28b62932a..b9096f99eb1 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") A configuration for a QASM Qobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.md index aafe13fc841..55b6a8ef347 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperiment.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj Experiment. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.md index bbc4a751353..62bc426dcdb 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjExperimentConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") Configuration for a single QASM experiment in the qobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.md index 60297f195e6..0a76bc283b3 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QasmQobjInstruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/qasm_qobj.py "view source code") A class representing a single instruction in an QasmQobj Experiment. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.24/qiskit.qobj.Qobj.md index 444a49ecd90..9e88025754b 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.Qobj.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/__init__.py "view source code") A backwards compat alias for QasmQobj. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.md index 74cb6a451d1..cd27143aeee 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QobjExperimentHeader.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/common.py "view source code") A class representing a header dictionary for a Qobj Experiment. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.md index b197d15cc07..4afe74003f5 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QobjHeader.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/common.py "view source code") A class used to represent a dictionary header in Qobj objects. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.md index 0b01080e04c..6d2b140ab62 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.QobjMeasurementOption.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/pulse_qobj.py "view source code") An individual measurement option. diff --git a/docs/api/qiskit/0.24/qiskit.qobj.validate_qobj_against_schema.md b/docs/api/qiskit/0.24/qiskit.qobj.validate_qobj_against_schema.md index 7b160eed48a..99385185697 100644 --- a/docs/api/qiskit/0.24/qiskit.qobj.validate_qobj_against_schema.md +++ b/docs/api/qiskit/0.24/qiskit.qobj.validate_qobj_against_schema.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qobj.validate_qobj_against_schema -`validate_qobj_against_schema(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/utils.py "view source code") +`validate_qobj_against_schema(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/qobj/utils.py "view source code") Validates a QObj against the .json schema. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.md index 175fb7ee344..89d951e1764 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Chi.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/chi.py "view source code") Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.md index 4a5e024727c..7e3ed34044a 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Choi.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/choi.py "view source code") Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.md index f5bc67a5c07..748e653202e 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Clifford.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") An N-qubit unitary operator from the Clifford group. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.md index ec9c46bb440..9ef79b1199c 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.DensityMatrix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/densitymatrix.py "view source code") DensityMatrix class diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.md index 2e95f86d9cc..eb754b5791c 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Kraus.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/kraus.py "view source code") Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.md index 6f2ad08fe80..7536df0ec84 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.md index ea135367095..52ea7dfe5f5 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Operator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/operator.py "view source code") Matrix operator class diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.md index 057b6e8103d..940d8e48e64 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.PTM.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/ptm.py "view source code") Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.md index 606316f5ff5..77e7bb8857d 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Pauli.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(z=None, x=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/pauli.py "view source code") +`Pauli(z=None, x=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/pauli.py "view source code") A simple class representing Pauli Operators. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.md index 281aa8f0724..ccf3bb88cf3 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.PauliTable.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Symplectic representation of a list Pauli matrices. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.md index cd051df0ee0..47dd686e4ea 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Quaternion.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/quaternion.py "view source code") A class representing a Quaternion. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.md index 89b014d4887..9d572a45ddb 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.ScalarOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/scalar_op.py "view source code") Scalar identity operator class. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.md index f0b1a7c8b3b..e0251c29c83 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.SparsePauliOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sparse N-qubit operator in a Pauli basis representation. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.md index bc51e2342bc..12fdca31632 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.StabilizerTable.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Symplectic representation of a list Stabilizer matrices. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.md index fd535fc1057..539ea6acd15 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Statevector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/statevector.py "view source code") Statevector class diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.md index 023a9b8876a..8e95b8a5d79 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.Stinespring.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.md index ee563ab7c24..21fb1e7d308 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.SuperOp.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/channel/superop.py "view source code") Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.md index ef326aee8a1..fcefb1ebda9 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.24/qiskit.quantum_info.average_gate_fidelity.md index f83e6830a30..fee68f5cc75 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.average_gate_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.24/qiskit.quantum_info.concurrence.md index 1658b8c8a2e..9217399bda2 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.concurrence.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.24/qiskit.quantum_info.diamond_norm.md index bfe49f148c4..753f4efa2d1 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.diamond_norm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.24/qiskit.quantum_info.entanglement_of_formation.md index 0668bfb8d04..2259f3b46a8 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.entanglement_of_formation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.24/qiskit.quantum_info.entropy.md index 58c2be92ae3..095a2f93ac6 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.entropy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.euler_angles_1q.md b/docs/api/qiskit/0.24/qiskit.quantum_info.euler_angles_1q.md index a4a8fa93d23..52a5950afe1 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.euler_angles_1q.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.euler_angles_1q.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.euler_angles_1q -`euler_angles_1q(unitary_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`euler_angles_1q(unitary_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") DEPRECATED: Compute Euler angles for a single-qubit gate. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.24/qiskit.quantum_info.gate_error.md index 17ea33a2955..0279733225f 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.gate_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.24/qiskit.quantum_info.hellinger_fidelity.md index 4528419266e..a69f8d179b2 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.hellinger_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.24/qiskit.quantum_info.mutual_information.md index fb196600672..760bbcef54b 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.mutual_information.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.24/qiskit.quantum_info.partial_trace.md index 38735f86235..fdfbe319875 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.partial_trace.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_basis.md index 8d2280af330..3605468ede5 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_group.md index 7c084ba4656..02fd83b29f4 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.pauli_group.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/pauli.py "view source code") Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.24/qiskit.quantum_info.process_fidelity.md index 28b9e13ca71..0e4089f3e17 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.process_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=False, require_cptp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=False, require_cptp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.24/qiskit.quantum_info.purity.md index c78299bf051..74df280651e 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.purity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_clifford.md index 95a6c4b19dc..90e1a8ebdec 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_clifford.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_density_matrix.md index b65b0b12d05..9db0cd1ac9f 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_density_matrix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_hermitian.md index 53566e7a58a..c2c4c5d19af 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_hermitian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_pauli_table.md index c85d0631ad6..1779606ae78 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_pauli_table.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_quantum_channel.md index 972fb38e62c..1b79f6bf268 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_quantum_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_stabilizer_table.md index ab8e7c16863..8d0793c4069 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_stabilizer_table.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_state.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_state.md index c7859adc54d..03ac2ae917b 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_state.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_state.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_state -`random_state(dim, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/random.py "view source code") +`random_state(dim, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/random.py "view source code") DEPRECATED Return a random quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_statevector.md index 781b46769ac..3fe9c06670d 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_statevector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.24/qiskit.quantum_info.random_unitary.md index 49ceaf812b8..960c140fe2e 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.random_unitary.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.24/qiskit.quantum_info.shannon_entropy.md index 052daaab759..a840de1d8c4 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.shannon_entropy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.24/qiskit.quantum_info.state_fidelity.md index 595264c8a1b..afd3bf3a562 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.state_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.24/qiskit.result.Counts.md b/docs/api/qiskit/0.24/qiskit.result.Counts.md index ee8b482af53..3f1ccef00c2 100644 --- a/docs/api/qiskit/0.24/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.24/qiskit.result.Counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/counts.py "view source code") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.24/qiskit.result.Result.md b/docs/api/qiskit/0.24/qiskit.result.Result.md index 924f2a26ee1..03960844363 100644 --- a/docs/api/qiskit/0.24/qiskit.result.Result.md +++ b/docs/api/qiskit/0.24/qiskit.result.Result.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/result.py "view source code") Model for Results. diff --git a/docs/api/qiskit/0.24/qiskit.result.ResultError.md b/docs/api/qiskit/0.24/qiskit.result.ResultError.md index 883f839eb8b..84b36e31585 100644 --- a/docs/api/qiskit/0.24/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.24/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.24/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.24/qiskit.result.marginal_counts.md index 5eef39d8f33..51c765ebb03 100644 --- a/docs/api/qiskit/0.24/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.24/qiskit.result.marginal_counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.md index 5748a00a27f..77bab9fd3a3 100644 --- a/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.24/qiskit.scheduler.ScheduleConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.24/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.24/qiskit.scheduler.methods.basic.md index 2b4829a1d2f..b66734828f1 100644 --- a/docs/api/qiskit/0.24/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.24/qiskit.scheduler.methods.basic.md @@ -25,7 +25,7 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat -`as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/methods/basic.py "view source code") +`as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. @@ -50,7 +50,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as late as -`as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/methods/basic.py "view source code") +`as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. diff --git a/docs/api/qiskit/0.24/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.24/qiskit.scheduler.schedule_circuit.md index a674c0fc2d1..6fbe0479cfd 100644 --- a/docs/api/qiskit/0.24/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.24/qiskit.scheduler.schedule_circuit.md @@ -24,7 +24,7 @@ QuantumCircuit to Pulse scheduler. -`schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/schedule_circuit.py "view source code") +`schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. diff --git a/docs/api/qiskit/0.24/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.24/qiskit.tools.backend_monitor.md index 9706e4f4230..a43f98d207f 100644 --- a/docs/api/qiskit/0.24/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.24/qiskit.tools.backend_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.24/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.24/qiskit.tools.backend_overview.md index 441b6b05609..9fdc0242d88 100644 --- a/docs/api/qiskit/0.24/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.24/qiskit.tools.backend_overview.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.24/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.24/qiskit.tools.job_monitor.md index a374d57c894..6720effb3e4 100644 --- a/docs/api/qiskit/0.24/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.24/qiskit.tools.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.24/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.24/qiskit.tools.parallel_map.md index d293d5b0622..a31377fbbc3 100644 --- a/docs/api/qiskit/0.24/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.24/qiskit.tools.parallel_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.md index 41e4bc3da2f..8aaa1a35b34 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.CouplingMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/coupling.py "view source code") Directed graph specifying fixed coupling. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.md index da7c880c693..655705033d4 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.FencedDAGCircuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/fencedobjs.py "view source code") A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.md index a7bd6b5933a..0ece729942a 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.FencedPropertySet.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/fencedobjs.py "view source code") A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.md index 5122f7eb638..71452d94488 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.FlowController.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/runningpassmanager.py "view source code") Base class for multiple types of working list. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.md index aa91c90b070..c9b79fb29a4 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.InstructionDurations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/instruction_durations.py "view source code") Helper class to provide durations of instructions for scheduling. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.24/qiskit.transpiler.Layout.md index c6e4155108c..2f433bca9ac 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.Layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/layout.py "view source code") Two-ways dict to represent a Layout. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.md index 37fa0c29d95..b2cce52c770 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.PassManager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passmanager.py "view source code") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.md index 44406139972..55f6e222a30 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.PassManagerConfig.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, seed_transpiler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, seed_transpiler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passmanager_config.py "view source code") Pass Manager Configuration. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.md index d9d98e9fec6..31a67fa5a08 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.PropertySet.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/propertyset.py "view source code") A default dictionary-like object diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.md index 7df9fd9e319..d4af5d82244 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerAccessError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.md index 8dafb06b214..bc215de5c6e 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.TranspilerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.md index 334db0189c0..aa3e19182e1 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ALAPSchedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/scheduling/alap.py "view source code") ALAP Scheduling. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.md index 3c85523530e..a8fce614c42 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ASAPSchedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/scheduling/asap.py "view source code") ASAP Scheduling. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.md index 4aaf72aa508..1bd4c052601 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ApplyLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index ae440b07c75..b6faf6780c9 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.md index c195d74abf0..8456d772c1b 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasicSwap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.md index 09aee39e15d..0d6e26fe737 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.BasisTranslator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.md index 6c6fce302ee..a8bda0cb202 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CSPLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/csp_layout.py "view source code") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.md index e022da7a85c..6bc3295723c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXCancellation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.md index 8f6b8622d90..18095ff8620 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CXDirection.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Rearrange the direction of the cx nodes to match the directed coupling map. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.md index 63889842068..0c4a4c2a98c 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckCXDirection.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Check if the CNOTs follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.md index 54e53d6024c..55dcd2b8ca6 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CheckMap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/check_map.py "view source code") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.md index 2cb29cb51dc..287dd5e9b59 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Collect2qBlocks.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.md index ecf36be7531..23923df05ad 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutationAnalysis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.md index 8250a595bf0..d95f718ac61 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CommutativeCancellation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.md index 6d12d8a6f3c..d5f3ffa2530 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.md index c7652e13cf8..1e885272366 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOps.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.md index df9c97198f7..c6d56665c76 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 82de40ac712..f356ec3d705 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.md index b09fb13eb70..02b9df9b4de 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGFixedPoint.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.md index a408697ad9d..a71436c5632 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DAGLongestPath.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.md index a6a732f4d11..90e0d857659 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Decompose.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/decompose.py "view source code") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.md index b028ac48fdc..fa874f706ac 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.DenseLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.md index 0de6bb2b86f..ffdefd438a9 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Depth.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/depth.py "view source code") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.md index 967682e3526..af85390a17e 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.md index 35b397786ab..ca759ff4ac1 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FixedPoint.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.md index 2be332db023..ec890c0c3b0 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Allocate all idle nodes from the coupling map as ancilla on the layout. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.md index 12b4adb55e7..0dc86215a12 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Layout2qDistance.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.md index 0de8bed4428..0468aa63f36 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.LookaheadSwap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 43025e680a2..1e448ae0bc4 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 7046bc0f3ea..1bfb36ccfe7 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.md index 38346f99512..9865e7fdf63 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.NumTensorFactors.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.md index dc77feb4ac4..26f4006a46e 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGates.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 4ef66df6818..1f39b49b32f 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 6fe76528633..9f96e5b922f 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.md index e1292786580..6f99f196178 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.md index 520ade07f84..cb631b61ff5 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.md index 190d4013b6b..f4d3f14c195 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.md index 99a00150a7c..90106d9f063 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SabreSwap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.md index b650d34c20c..26d4e4653f0 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.SetLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/set_layout.py "view source code") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.md index 74c40b4f480..6fcce585412 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Size.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/size.py "view source code") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.md index 57a6a689905..52ea46740db 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.StochasticSwap.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.md index 9c611ea14f4..c6a26db9874 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TemplateOptimization.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.md index 84c771c048a..eb0ad72f2ea 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.TrivialLayout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.md index 5752b9bf76a..8fc3bfe5c18 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnitarySynthesis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.md index dd6a9e3248a..61234a37d4d 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 110df21f1e2..29f2152ae2b 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.md index e926ec9d02f..f294e48be0b 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Unroller.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/basis/unroller.py "view source code") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.md index 586ebcb2474..951c6d84b99 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.passes.Width.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/analysis/width.py "view source code") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index d449308821c..d111383e2c4 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 23ddb176237..fdefcf6d74b 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 7db79fbce41..6923f3a9643 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 2ec3a595a7a..dfe5cb47a5a 100644 --- a/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.24/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.md index e46ef17c4d4..9d6e7f57807 100644 --- a/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.24/qiskit.validation.jsonschema.SchemaValidationError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.24/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.24/qiskit.validation.jsonschema.validate_json_against_schema.md index a836a07218e..c0302e1c8d2 100644 --- a/docs/api/qiskit/0.24/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.24/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -12,7 +12,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.md index 80de2427a19..51226555dc4 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.VisualizationError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.24/qiskit.visualization.circuit_drawer.md index 597cc11b694..fe860fcdb82 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/circuit_visualization.py "view source code") Draw a quantum circuit to different formats (set by output parameter): diff --git a/docs/api/qiskit/0.24/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.24/qiskit.visualization.dag_drawer.md index 0fd1658a2e2..aa740da4783 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.24/qiskit.visualization.pass_manager_drawer.md index e4a0cbb2cfc..125929a08d6 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_multivector.md index 7d2a74ffd21..8b9d9c9c1a0 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_vector.md index 07bafddd29f..81ed20792c0 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_circuit_layout.md index 8e8d9b17064..0d3e75778d0 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_error_map.md index 03290d8ca05..db0fe5ba92e 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_gate_map.md index db66e95c3cc..8e25399f0c5 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_histogram.md index 66e7bc14068..ce8ddbf0a08 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_city.md index 52773ca547b..40443b0dbcf 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_hinton.md index 0a25c2d181c..e9c4e865c38 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_paulivec.md index cad5f44365e..c73a25a15ee 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_qsphere.md index cc68173353a..c1e7e1ec500 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.pulse.interpolation.md b/docs/api/qiskit/0.24/qiskit.visualization.pulse.interpolation.md index a730e84cf07..a7720d24223 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.pulse.interpolation.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.pulse.interpolation.md @@ -43,7 +43,7 @@ Interpolated time vector and real and imaginary part of waveform. -`interp1d(time, samples, nop, kind='linear')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/interpolation.py "view source code") +`interp1d(time, samples, nop, kind='linear')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/interpolation.py "view source code") Scipy interpolation wrapper. @@ -84,7 +84,7 @@ Interpolated time vector and real and imaginary part of waveform. -`step_wise(time, samples, nop)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/interpolation.py "view source code") +`step_wise(time, samples, nop)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/interpolation.py "view source code") Keep uniform variation between sample values. No interpolation is applied. :type time: `ndarray` :param time: Time vector with length of `samples` + 1. :type samples: `ndarray` :param samples: Complex pulse envelope. :type nop: `int` :param nop: This argument is not used. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.md b/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.md index 23e8a174014..13cb9caad39 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.pulse.qcstyle.md @@ -65,7 +65,7 @@ Alias for field number 0 -`PulseStyle(figsize=(7.0, 5.0), title_font_size=18, wave_color=('#ff0000', '#0000ff'), bg_color='#f2f3f4', num_points=1000, dpi=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/qcstyle.py "view source code") +`PulseStyle(figsize=(7.0, 5.0), title_font_size=18, wave_color=('#ff0000', '#0000ff'), bg_color='#f2f3f4', num_points=1000, dpi=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/qcstyle.py "view source code") Style sheet for Qiskit-Pulse sample pulse drawer. @@ -84,7 +84,7 @@ For any of the Optional fields, if that field is None then it will revert to its -`SchedStyle(figsize=(10.0, 12.0), fig_unit_h_table=0.4, use_table=True, table_columns=2, table_font_size=10, axis_font_size=18, label_font_size=10, icon_font_size=18, title_font_size=25, label_ch_linestyle='--', label_ch_color='#222222', label_ch_alpha=0.3, d_ch_color=('#648fff', '#002999'), u_ch_color=('#ffb000', '#994A00'), m_ch_color=('#dc267f', '#760019'), s_ch_color='#7da781', s_ch_linestyle='-', table_color=('#e0e0e0', '#f6f6f6', '#f6f6f6'), bg_color='#f2f3f4', num_points=1000, dpi=150, remove_spacing=True, max_table_ratio=0.5, vertical_span=0.2, axis_formatter='%s')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/qcstyle.py "view source code") +`SchedStyle(figsize=(10.0, 12.0), fig_unit_h_table=0.4, use_table=True, table_columns=2, table_font_size=10, axis_font_size=18, label_font_size=10, icon_font_size=18, title_font_size=25, label_ch_linestyle='--', label_ch_color='#222222', label_ch_alpha=0.3, d_ch_color=('#648fff', '#002999'), u_ch_color=('#ffb000', '#994A00'), m_ch_color=('#dc267f', '#760019'), s_ch_color='#7da781', s_ch_linestyle='-', table_color=('#e0e0e0', '#f6f6f6', '#f6f6f6'), bg_color='#f2f3f4', num_points=1000, dpi=150, remove_spacing=True, max_table_ratio=0.5, vertical_span=0.2, axis_formatter='%s')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse/qcstyle.py "view source code") Style sheet for Qiskit-Pulse schedule drawer. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.pulse_drawer.md b/docs/api/qiskit/0.24/qiskit.visualization.pulse_drawer.md index 197e7fc7313..64834335923 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.pulse_drawer.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.pulse_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pulse_drawer -`pulse_drawer(data, dt=1, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, plot_all=False, plot_range=None, interactive=False, table=False, label=False, framechange=True, channels=None, show_framechange_channels=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse_visualization.py "view source code") +`pulse_drawer(data, dt=1, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, plot_all=False, plot_range=None, interactive=False, table=False, label=False, framechange=True, channels=None, show_framechange_channels=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/pulse_visualization.py "view source code") Plot the interpolated envelope of pulse and schedule. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.24/qiskit.visualization.timeline.draw.md index 497af018630..3c6dafb3578 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.timeline.draw.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.24/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.24/qiskit.visualization.visualize_transition.md index b05eccc8e90..9cfc2f67238 100644 --- a/docs/api/qiskit/0.24/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.24/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 3d370e4822860b0a10773acebc0af2f7e872747d Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:09:14 +0100 Subject: [PATCH 06/41] Regenerate qiskit 0.25.4 --- docs/api/qiskit/0.25/execute.md | 2 +- docs/api/qiskit/0.25/logging.md | 2 +- .../0.25/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.25/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.25/qiskit.algorithms.Grover.md | 2 +- .../0.25/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.25/qiskit.algorithms.HHL.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- .../0.25/qiskit.algorithms.LinearSolver.md | 2 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.algorithms.NumPyLinearSolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.25/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.25/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.25/qiskit.algorithms.Shor.md | 2 +- .../0.25/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.25/qiskit.algorithms.VQE.md | 2 +- .../0.25/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.25/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.25/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.25/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.25/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.25/qiskit.algorithms.optimizers.GSLS.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.25/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.25/qiskit.algorithms.optimizers.SPSA.md | 2 +- .../0.25/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.25/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.25/qiskit.aqua.QuantumInstance.md | 2 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 2 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 2 +- ...ua.algorithms.AmplitudeEstimationResult.md | 2 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 2 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 2 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 2 +- .../qiskit/0.25/qiskit.aqua.algorithms.EOH.md | 2 +- .../qiskit.aqua.algorithms.Eigensolver.md | 2 +- ...iskit.aqua.algorithms.EigensolverResult.md | 2 +- .../0.25/qiskit.aqua.algorithms.Grover.md | 2 +- .../qiskit.aqua.algorithms.GroverResult.md | 2 +- .../qiskit/0.25/qiskit.aqua.algorithms.HHL.md | 2 +- .../0.25/qiskit.aqua.algorithms.HHLResult.md | 2 +- .../0.25/qiskit.aqua.algorithms.IQPE.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.LinearsolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 2 +- ...qua.algorithms.MinimumEigensolverResult.md | 2 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 2 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.25/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.25/qiskit.aqua.algorithms.QGAN.md | 2 +- .../qiskit/0.25/qiskit.aqua.algorithms.QPE.md | 2 +- .../0.25/qiskit.aqua.algorithms.QSVM.md | 2 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 2 +- .../0.25/qiskit.aqua.algorithms.Shor.md | 2 +- .../0.25/qiskit.aqua.algorithms.Simon.md | 2 +- .../0.25/qiskit.aqua.algorithms.SklearnSVM.md | 2 +- .../qiskit/0.25/qiskit.aqua.algorithms.VQC.md | 2 +- .../qiskit/0.25/qiskit.aqua.algorithms.VQE.md | 2 +- .../qiskit/0.25/qiskit.aqua.circuits.CNF.md | 2 +- .../qiskit/0.25/qiskit.aqua.circuits.DNF.md | 2 +- .../qiskit/0.25/qiskit.aqua.circuits.ESOP.md | 2 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 2 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 2 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 2 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 2 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 2 +- ...aqua.components.feature_maps.FeatureMap.md | 2 +- ...omponents.feature_maps.RawFeatureVector.md | 2 +- ...t.aqua.components.initial_states.Custom.md | 2 +- ....components.initial_states.InitialState.md | 2 +- ....components.initial_states.VarFormBased.md | 2 +- ...kit.aqua.components.initial_states.Zero.md | 2 +- ...mponents.multiclass_extensions.AllPairs.md | 2 +- ...lticlass_extensions.ErrorCorrectingCode.md | 2 +- ...lticlass_extensions.MulticlassExtension.md | 2 +- ...ts.multiclass_extensions.OneAgainstRest.md | 2 +- ...s.neural_networks.DiscriminativeNetwork.md | 2 +- ...nents.neural_networks.GenerativeNetwork.md | 2 +- ...ents.neural_networks.NumPyDiscriminator.md | 2 +- ...ts.neural_networks.PyTorchDiscriminator.md | 2 +- ...onents.neural_networks.QuantumGenerator.md | 2 +- .../qiskit.aqua.components.optimizers.ADAM.md | 2 +- .../qiskit.aqua.components.optimizers.AQGD.md | 2 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 2 +- .../qiskit.aqua.components.optimizers.CG.md | 2 +- ...iskit.aqua.components.optimizers.COBYLA.md | 2 +- .../qiskit.aqua.components.optimizers.CRS.md | 2 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 2 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 2 +- .../qiskit.aqua.components.optimizers.ESCH.md | 2 +- .../qiskit.aqua.components.optimizers.GSLS.md | 2 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 2 +- ...qiskit.aqua.components.optimizers.ISRES.md | 2 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 2 +- ....aqua.components.optimizers.NELDER_MEAD.md | 2 +- .../qiskit.aqua.components.optimizers.NFT.md | 2 +- ...it.aqua.components.optimizers.Optimizer.md | 2 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 2 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 2 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 2 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 2 +- .../qiskit.aqua.components.optimizers.SPSA.md | 2 +- .../qiskit.aqua.components.optimizers.TNC.md | 2 +- ....components.oracles.CustomCircuitOracle.md | 2 +- ...ponents.oracles.LogicalExpressionOracle.md | 2 +- .../qiskit.aqua.components.oracles.Oracle.md | 2 +- ...qua.components.oracles.TruthTableOracle.md | 2 +- ...qua.components.reciprocals.LongDivision.md | 2 +- ...a.components.reciprocals.LookupRotation.md | 2 +- ....aqua.components.reciprocals.Reciprocal.md | 2 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 2 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 2 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 2 +- ...els.MultivariateVariationalDistribution.md | 2 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 2 +- ....uncertainty_models.UniformDistribution.md | 2 +- ...certainty_models.UnivariateDistribution.md | 2 +- ...odels.UnivariateVariationalDistribution.md | 2 +- ...ncertainty_problems.MultivariateProblem.md | 2 +- ...uncertainty_problems.UncertaintyProblem.md | 2 +- ...lems.UnivariatePiecewiseLinearObjective.md | 2 +- ....uncertainty_problems.UnivariateProblem.md | 2 +- ...nents.variational_forms.VariationalForm.md | 2 +- .../qiskit.aqua.operators.OperatorBase.md | 2 +- ...qua.operators.converters.AbelianGrouper.md | 2 +- ...qua.operators.converters.CircuitSampler.md | 2 +- ...aqua.operators.converters.ConverterBase.md | 2 +- ...a.operators.converters.DictToCircuitSum.md | 2 +- ...a.operators.converters.PauliBasisChange.md | 2 +- ...aqua.operators.evolutions.EvolutionBase.md | 2 +- ...a.operators.evolutions.EvolutionFactory.md | 2 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 2 +- ...ua.operators.evolutions.MatrixEvolution.md | 2 +- ...rators.evolutions.PauliTrotterEvolution.md | 2 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 2 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 2 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 2 +- ...rators.evolutions.TrotterizationFactory.md | 2 +- ...rators.expectations.AerPauliExpectation.md | 2 +- ....operators.expectations.CVaRExpectation.md | 2 +- ....operators.expectations.ExpectationBase.md | 2 +- ...erators.expectations.ExpectationFactory.md | 2 +- ...perators.expectations.MatrixExpectation.md | 2 +- ...operators.expectations.PauliExpectation.md | 2 +- ...qua.operators.gradients.CircuitGradient.md | 2 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 2 +- ...aqua.operators.gradients.DerivativeBase.md | 2 +- ...iskit.aqua.operators.gradients.Gradient.md | 2 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 2 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 2 +- .../qiskit.aqua.operators.gradients.QFI.md | 2 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 2 +- ...it.aqua.operators.legacy.MatrixOperator.md | 2 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 2 +- ....operators.legacy.WeightedPauliOperator.md | 2 +- ...skit.aqua.operators.legacy.Z2Symmetries.md | 2 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 2 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 2 +- ...qiskit.aqua.operators.list_ops.SummedOp.md | 2 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 2 +- ....aqua.operators.primitive_ops.CircuitOp.md | 2 +- ...t.aqua.operators.primitive_ops.MatrixOp.md | 2 +- ...it.aqua.operators.primitive_ops.PauliOp.md | 2 +- ...qua.operators.primitive_ops.PrimitiveOp.md | 2 +- ...qua.operators.state_fns.CVaRMeasurement.md | 2 +- ...aqua.operators.state_fns.CircuitStateFn.md | 2 +- ...it.aqua.operators.state_fns.DictStateFn.md | 2 +- ...qua.operators.state_fns.OperatorStateFn.md | 2 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 2 +- ....aqua.operators.state_fns.VectorStateFn.md | 2 +- .../0.25/qiskit.aqua.utils.CircuitFactory.md | 2 +- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.25/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.25/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.25/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.25/qiskit.aqua.utils.name_args.md | 2 +- .../0.25/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.25/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.25/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.25/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.25/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.25/qiskit.assembler.RunConfig.md | 2 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.25/qiskit.assembler.disassemble.md | 2 +- .../0.25/qiskit.chemistry.BosonicOperator.md | 2 +- .../qiskit.chemistry.FermionicOperator.md | 2 +- .../qiskit/0.25/qiskit.chemistry.MP2Info.md | 2 +- .../qiskit/0.25/qiskit.chemistry.QMolecule.md | 2 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 2 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 2 +- ...chemistry.algorithms.EigensolverFactory.md | 2 +- ...try.algorithms.ExcitedStatesEigensolver.md | 2 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 2 +- ...istry.algorithms.GroundStateEigensolver.md | 2 +- ....chemistry.algorithms.GroundStateSolver.md | 2 +- ...ry.algorithms.MinimumEigensolverFactory.md | 2 +- ...stry.algorithms.NumPyEigensolverFactory.md | 2 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 2 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 2 +- .../0.25/qiskit.chemistry.algorithms.QEOM.md | 2 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 2 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 2 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 2 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 2 +- ...s.pes_samplers.DifferentialExtrapolator.md | 2 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 2 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 2 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 2 +- ...gorithms.pes_samplers.HarmonicPotential.md | 2 +- ....algorithms.pes_samplers.MorsePotential.md | 2 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 2 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 2 +- ...y.algorithms.pes_samplers.PotentialBase.md | 2 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 2 +- ...thms.pes_samplers.VibronicStructureBase.md | 2 +- ...orithms.pes_samplers.WindowExtrapolator.md | 2 +- ...applications.MolecularGroundStateEnergy.md | 2 +- ...y.components.bosonic_bases.BosonicBasis.md | 2 +- ....components.bosonic_bases.HarmonicBasis.md | 2 +- ...y.components.initial_states.HartreeFock.md | 2 +- ...hemistry.components.initial_states.VSCF.md | 2 +- ...mistry.components.variational_forms.CHC.md | 2 +- ...stry.components.variational_forms.UCCSD.md | 2 +- ...istry.components.variational_forms.UVCC.md | 2 +- ...qiskit.chemistry.core.ChemistryOperator.md | 2 +- .../0.25/qiskit.chemistry.core.Hamiltonian.md | 2 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 2 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 2 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 2 +- ...iskit.chemistry.drivers.FermionicDriver.md | 2 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 2 +- ....chemistry.drivers.GaussianForcesDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogResult.md | 2 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 2 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.25/qiskit.chemistry.drivers.Molecule.md | 2 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 2 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 2 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 2 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 2 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 2 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 2 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 2 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 2 +- .../0.25/qiskit.circuit.AncillaQubit.md | 2 +- .../0.25/qiskit.circuit.AncillaRegister.md | 2 +- .../0.25/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.25/qiskit.circuit.Clbit.md | 2 +- .../0.25/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.25/qiskit.circuit.Delay.md | 2 +- .../0.25/qiskit.circuit.EquivalenceLibrary.md | 2 +- docs/api/qiskit/0.25/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.25/qiskit.circuit.Instruction.md | 2 +- .../0.25/qiskit.circuit.InstructionSet.md | 2 +- .../api/qiskit/0.25/qiskit.circuit.Measure.md | 2 +- .../qiskit/0.25/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.25/qiskit.circuit.ParameterVector.md | 2 +- .../0.25/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.25/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.25/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.25/qiskit.circuit.Reset.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.AND.md | 2 +- .../0.25/qiskit.circuit.library.Barrier.md | 2 +- .../0.25/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.25/qiskit.circuit.library.C3XGate.md | 2 +- .../0.25/qiskit.circuit.library.C4XGate.md | 2 +- .../0.25/qiskit.circuit.library.CCXGate.md | 2 +- .../0.25/qiskit.circuit.library.CHGate.md | 2 +- .../0.25/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.25/qiskit.circuit.library.CRXGate.md | 2 +- .../0.25/qiskit.circuit.library.CRYGate.md | 2 +- .../0.25/qiskit.circuit.library.CRZGate.md | 2 +- .../0.25/qiskit.circuit.library.CSXGate.md | 2 +- .../0.25/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.25/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.25/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.25/qiskit.circuit.library.CUGate.md | 2 +- .../0.25/qiskit.circuit.library.CXGate.md | 2 +- .../0.25/qiskit.circuit.library.CYGate.md | 2 +- .../0.25/qiskit.circuit.library.CZGate.md | 2 +- .../0.25/qiskit.circuit.library.DCXGate.md | 2 +- .../0.25/qiskit.circuit.library.Diagonal.md | 2 +- .../0.25/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.GRZ.md | 2 +- .../0.25/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.25/qiskit.circuit.library.HGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.25/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.25/qiskit.circuit.library.MCMT.md | 2 +- .../0.25/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.25/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.25/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.25/qiskit.circuit.library.MSGate.md | 2 +- .../0.25/qiskit.circuit.library.Measure.md | 2 +- .../0.25/qiskit.circuit.library.NLocal.md | 2 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.25/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.25/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.25/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.25/qiskit.circuit.library.RCCXGate.md | 2 +- .../0.25/qiskit.circuit.library.RGate.md | 2 +- .../0.25/qiskit.circuit.library.RVGate.md | 2 +- .../0.25/qiskit.circuit.library.RXGate.md | 2 +- .../0.25/qiskit.circuit.library.RXXGate.md | 2 +- .../0.25/qiskit.circuit.library.RYGate.md | 2 +- .../0.25/qiskit.circuit.library.RYYGate.md | 2 +- .../0.25/qiskit.circuit.library.RZGate.md | 2 +- .../0.25/qiskit.circuit.library.RZXGate.md | 2 +- .../0.25/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.25/qiskit.circuit.library.Reset.md | 2 +- .../0.25/qiskit.circuit.library.SGate.md | 2 +- .../0.25/qiskit.circuit.library.SXGate.md | 2 +- .../0.25/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.25/qiskit.circuit.library.SdgGate.md | 2 +- .../0.25/qiskit.circuit.library.SwapGate.md | 2 +- .../0.25/qiskit.circuit.library.TGate.md | 2 +- .../0.25/qiskit.circuit.library.TdgGate.md | 2 +- .../0.25/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.25/qiskit.circuit.library.U1Gate.md | 2 +- .../0.25/qiskit.circuit.library.U2Gate.md | 2 +- .../0.25/qiskit.circuit.library.U3Gate.md | 2 +- .../0.25/qiskit.circuit.library.UGate.md | 2 +- ...kit.circuit.library.UniformDistribution.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.25/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.25/qiskit.circuit.library.XOR.md | 2 +- .../0.25/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.25/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.25/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.25/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.25/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.25/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.25/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.25/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.25/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.25/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.25/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.25/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.25/qiskit.compiler.transpile.md | 2 +- .../0.25/qiskit.converters.ast_to_dag.md | 2 +- .../0.25/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.25/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.25/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.25/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.25/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.25/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.25/qiskit.dagcircuit.DAGDependency.md | 2 +- .../qiskit/0.25/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.25/qiskit.extensions.HamiltonianGate.md | 2 +- .../0.25/qiskit.extensions.Initialize.md | 2 +- .../qiskit/0.25/qiskit.extensions.Snapshot.md | 2 +- .../0.25/qiskit.extensions.UnitaryGate.md | 2 +- .../0.25/qiskit.finance.QiskitFinanceError.md | 2 +- ...it.finance.applications.ising.portfolio.md | 10 +++---- ...cations.ising.portfolio_diversification.md | 6 ++--- ....uncertainty_problems.EuropeanCallDelta.md | 2 +- ...inty_problems.EuropeanCallExpectedValue.md | 2 +- ...ainty_problems.FixedIncomeExpectedValue.md | 2 +- ...finance.data_providers.BaseDataProvider.md | 2 +- ...nce.data_providers.DataOnDemandProvider.md | 2 +- ...nce.data_providers.ExchangeDataProvider.md | 2 +- ...nance.data_providers.RandomDataProvider.md | 2 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 2 +- ...inance.data_providers.YahooDataProvider.md | 2 +- ...t.ignis.characterization.AmpCalCXFitter.md | 2 +- ...kit.ignis.characterization.AmpCalFitter.md | 2 +- ...ignis.characterization.AngleCalCXFitter.md | 2 +- ...t.ignis.characterization.AngleCalFitter.md | 2 +- ...is.characterization.BaseCoherenceFitter.md | 2 +- ...t.ignis.characterization.BaseGateFitter.md | 2 +- ...iskit.ignis.characterization.DragFitter.md | 2 +- ...iskit.ignis.characterization.RabiFitter.md | 2 +- .../qiskit.ignis.characterization.T1Fitter.md | 2 +- .../qiskit.ignis.characterization.T2Fitter.md | 2 +- ...kit.ignis.characterization.T2StarFitter.md | 2 +- .../qiskit.ignis.characterization.ZZFitter.md | 2 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 2 +- .../0.25/qiskit.ignis.logging.IgnisLogger.md | 2 +- .../0.25/qiskit.ignis.logging.IgnisLogging.md | 2 +- ....ignis.measurement.DiscriminationFilter.md | 2 +- ...gnis.measurement.IQDiscriminationFitter.md | 2 +- ...ignis.measurement.LinearIQDiscriminator.md | 2 +- ...is.measurement.QuadraticIQDiscriminator.md | 2 +- ...gnis.measurement.SklearnIQDiscriminator.md | 2 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 2 +- ....mitigation.CompleteExpvalMeasMitigator.md | 2 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 2 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 2 +- ...skit.ignis.mitigation.MeasurementFilter.md | 2 +- ....mitigation.TensoredExpvalMeasMitigator.md | 2 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 2 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 2 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 2 +- ....ignis.verification.AccreditationFitter.md | 2 +- .../0.25/qiskit.ignis.verification.BConfig.md | 2 +- .../qiskit.ignis.verification.CNOTDihedral.md | 2 +- ...ignis.verification.CNOTDihedralRBFitter.md | 2 +- ...is.verification.GatesetTomographyFitter.md | 2 +- .../qiskit.ignis.verification.GraphDecoder.md | 2 +- ....ignis.verification.InterleavedRBFitter.md | 2 +- .../0.25/qiskit.ignis.verification.Plotter.md | 2 +- ...is.verification.ProcessTomographyFitter.md | 2 +- ...iskit.ignis.verification.PurityRBFitter.md | 2 +- .../0.25/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 2 +- .../qiskit.ignis.verification.RBFitter.md | 2 +- ...iskit.ignis.verification.RepetitionCode.md | 2 +- ...gnis.verification.StateTomographyFitter.md | 2 +- ...kit.ignis.verification.TomographyFitter.md | 2 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 2 +- .../0.25/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.25/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.25/qiskit.ml.datasets.digits.md | 2 +- .../0.25/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.25/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.25/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.25/qiskit.opflow.OperatorBase.md | 2 +- .../qiskit/0.25/qiskit.opflow.OpflowError.md | 2 +- .../0.25/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.25/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../0.25/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.25/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.25/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.25/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.25/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.25/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.25/qiskit.opflow.gradients.QFI.md | 2 +- .../0.25/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.25/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.25/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.25/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.25/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.25/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 2 +- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 2 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 2 +- ....optimization.algorithms.CplexOptimizer.md | 2 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 2 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 2 +- ...zation.algorithms.MinimumEigenOptimizer.md | 2 +- ...mization.algorithms.MultiStartOptimizer.md | 2 +- ...zation.algorithms.OptimizationAlgorithm.md | 2 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 2 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 2 +- ....optimization.algorithms.SolutionSample.md | 2 +- ....optimization.applications.ising.clique.md | 6 ++--- ....optimization.applications.ising.common.md | 12 ++++----- ...optimization.applications.ising.docplex.md | 2 +- ...mization.applications.ising.exact_cover.md | 6 ++--- ...tion.applications.ising.graph_partition.md | 6 ++--- ...ptimization.applications.ising.knapsack.md | 6 ++--- ...optimization.applications.ising.max_cut.md | 6 ++--- ...timization.applications.ising.partition.md | 4 +-- ...mization.applications.ising.set_packing.md | 6 ++--- ...imization.applications.ising.stable_set.md | 6 ++--- ...kit.optimization.applications.ising.tsp.md | 14 +++++----- ...tion.applications.ising.vehicle_routing.md | 8 +++--- ...ization.applications.ising.vertex_cover.md | 6 ++--- ...ization.converters.InequalityToEquality.md | 2 +- ...optimization.converters.IntegerToBinary.md | 2 +- ...tion.converters.LinearEqualityToPenalty.md | 2 +- ...on.converters.QuadraticProgramConverter.md | 2 +- ...ation.converters.QuadraticProgramToQubo.md | 2 +- ...qiskit.optimization.problems.Constraint.md | 2 +- ....optimization.problems.LinearConstraint.md | 2 +- ....optimization.problems.LinearExpression.md | 2 +- ...timization.problems.QuadraticConstraint.md | 2 +- ...timization.problems.QuadraticExpression.md | 2 +- ...ptimization.problems.QuadraticObjective.md | 2 +- ....optimization.problems.QuadraticProgram.md | 2 +- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 2 +- .../qiskit/0.25/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.25/qiskit.providers.BackendV1.md | 2 +- .../0.25/qiskit.providers.BaseBackend.md | 2 +- .../qiskit/0.25/qiskit.providers.BaseJob.md | 2 +- .../0.25/qiskit.providers.BaseProvider.md | 2 +- docs/api/qiskit/0.25/qiskit.providers.Job.md | 2 +- .../qiskit/0.25/qiskit.providers.JobError.md | 2 +- .../qiskit/0.25/qiskit.providers.JobStatus.md | 2 +- .../0.25/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.25/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.25/qiskit.providers.Options.md | 2 +- .../qiskit/0.25/qiskit.providers.Provider.md | 2 +- .../0.25/qiskit.providers.ProviderV1.md | 2 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.25/qiskit.providers.aer.AerError.md | 2 +- .../0.25/qiskit.providers.aer.AerJob.md | 2 +- .../0.25/qiskit.providers.aer.AerProvider.md | 2 +- .../0.25/qiskit.providers.aer.AerSimulator.md | 2 +- .../qiskit.providers.aer.PulseSimulator.md | 2 +- .../qiskit.providers.aer.QasmSimulator.md | 2 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 2 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 2 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 2 +- ...qiskit.providers.aer.noise.QuantumError.md | 2 +- ...qiskit.providers.aer.noise.ReadoutError.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 2 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 2 +- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 2 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.25/qiskit.providers.ibmq.IBMQBackend.md | 2 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 2 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.25/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.25/qiskit.providers.ibmq.IBMQFactory.md | 2 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- ....providers.ibmq.credentials.Credentials.md | 2 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...roviders.ibmq.experiment.AnalysisResult.md | 2 +- ...it.providers.ibmq.experiment.Experiment.md | 2 +- ...iders.ibmq.experiment.ExperimentService.md | 2 +- .../0.25/qiskit.providers.ibmq.job.IBMQJob.md | 2 +- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 2 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.25/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 2 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 2 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 2 +- ...t.providers.ibmq.managed.ManagedResults.md | 2 +- ...skit.providers.ibmq.random.CQCExtractor.md | 2 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 2 +- ...providers.ibmq.random.IBMQRandomService.md | 2 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.25/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../0.25/qiskit.providers.models.JobStatus.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Acquire.md | 2 +- .../0.25/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Call.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Constant.md | 2 +- .../0.25/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Delay.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Drag.md | 2 +- .../qiskit/0.25/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Gaussian.md | 2 +- .../0.25/qiskit.pulse.GaussianSquare.md | 2 +- .../qiskit/0.25/qiskit.pulse.Instruction.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- .../0.25/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.25/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Play.md | 2 +- .../qiskit/0.25/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.25/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.25/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit/0.25/qiskit.pulse.SetFrequency.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md | 2 +- .../0.25/qiskit.pulse.ShiftFrequency.md | 2 +- .../qiskit/0.25/qiskit.pulse.ShiftPhase.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.Waveform.md | 2 +- .../0.25/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.25/qiskit.pulse.builder.align_func.md | 2 +- .../0.25/qiskit.pulse.builder.align_left.md | 2 +- .../0.25/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.25/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.delay.md | 2 +- .../0.25/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.25/qiskit.pulse.builder.inline.md | 2 +- .../0.25/qiskit.pulse.builder.measure.md | 2 +- .../0.25/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.25/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.pad.md | 2 +- .../0.25/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.25/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.25/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.25/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.25/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.25/qiskit.pulse.builder.x.md | 2 +- docs/api/qiskit/0.25/qiskit.pulse.channels.md | 18 ++++++------- .../0.25/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.25/qiskit.pulse.instructions.Call.md | 2 +- .../0.25/qiskit.pulse.instructions.Delay.md | 2 +- .../qiskit.pulse.instructions.Instruction.md | 2 +- .../0.25/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../0.25/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.25/qiskit.pulse.library.Drag.md | 2 +- .../0.25/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../0.25/qiskit.pulse.library.Waveform.md | 2 +- .../0.25/qiskit.pulse.library.discrete.md | 26 +++++++++---------- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.25/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.25/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.25/qiskit.qasm.Qasm.md | 2 +- docs/api/qiskit/0.25/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.25/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.25/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.25/qiskit.qobj.GateCalibration.md | 2 +- .../0.25/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.md | 2 +- .../0.25/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.25/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.25/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.25/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.25/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.25/qiskit.qobj.QasmQobjInstruction.md | 2 +- docs/api/qiskit/0.25/qiskit.qobj.Qobj.md | 2 +- .../0.25/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.25/qiskit.qobj.QobjHeader.md | 2 +- .../0.25/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.25/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.25/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.25/qiskit.quantum_info.Choi.md | 2 +- .../0.25/qiskit.quantum_info.Clifford.md | 2 +- .../0.25/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.25/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.25/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.25/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.25/qiskit.quantum_info.Pauli.md | 2 +- .../0.25/qiskit.quantum_info.PauliTable.md | 2 +- .../0.25/qiskit.quantum_info.Quaternion.md | 2 +- .../0.25/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.25/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerTable.md | 2 +- .../0.25/qiskit.quantum_info.Statevector.md | 2 +- .../0.25/qiskit.quantum_info.Stinespring.md | 2 +- .../0.25/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.25/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.25/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.25/qiskit.quantum_info.entropy.md | 2 +- .../0.25/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.25/qiskit.quantum_info.partial_trace.md | 2 +- .../0.25/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.25/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.25/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.25/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.25/qiskit.result.Counts.md | 2 +- docs/api/qiskit/0.25/qiskit.result.Result.md | 2 +- .../qiskit/0.25/qiskit.result.ResultError.md | 2 +- .../0.25/qiskit.result.marginal_counts.md | 2 +- .../0.25/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.25/qiskit.scheduler.methods.basic.md | 4 +-- .../0.25/qiskit.scheduler.schedule_circuit.md | 2 +- .../0.25/qiskit.tools.backend_monitor.md | 2 +- .../0.25/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.25/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.25/qiskit.tools.parallel_map.md | 2 +- .../0.25/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.25/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.25/qiskit.transpiler.FlowController.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- .../qiskit/0.25/qiskit.transpiler.Layout.md | 2 +- .../0.25/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.25/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.25/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.25/qiskit.transpiler.passes.CheckMap.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- .../0.25/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.25/qiskit.transpiler.passes.Depth.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.25/qiskit.transpiler.passes.Size.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- .../0.25/qiskit.transpiler.passes.Unroller.md | 2 +- .../0.25/qiskit.transpiler.passes.Width.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.25/qiskit.utils.QuantumInstance.md | 2 +- .../qiskit/0.25/qiskit.utils.apply_prefix.md | 2 +- .../0.25/qiskit.utils.deprecate_arguments.md | 2 +- .../0.25/qiskit.utils.deprecate_function.md | 2 +- .../0.25/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.25/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.25/qiskit.utils.has_ibmq.md | 2 +- .../0.25/qiskit.utils.is_main_process.md | 2 +- .../0.25/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.25/qiskit.utils.name_args.md | 2 +- .../0.25/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.25/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1199 files changed, 1257 insertions(+), 1257 deletions(-) diff --git a/docs/api/qiskit/0.25/execute.md b/docs/api/qiskit/0.25/execute.md index f8e620f7153..396c542b693 100644 --- a/docs/api/qiskit/0.25/execute.md +++ b/docs/api/qiskit/0.25/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.25/logging.md b/docs/api/qiskit/0.25/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.25/logging.md +++ b/docs/api/qiskit/0.25/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.md index 2d896f3128d..399182a81fc 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.md index f799eec0eae..0c5c3774a63 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.md index 759cbb1f65e..c2836cd23a1 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.md index f5e0c2f1458..eefb858540c 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.md index b556964d697..e80e0ad124c 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The Amplitude Estimation interface. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.md index e2bf527b243..bce7fdcd886 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.md index d76e5f2dbcc..f1ba5b78959 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.md index f3bea317eb5..406952446e9 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.md index 956caa9f16a..c733f091a7f 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.md index c27702c06ad..55005595d01 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 802aefeae6e..1321c3b62aa 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.25/qiskit.algorithms.Grover.md index 652e7d89fd4..81439018082 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.md index 45b3bf0cb95..d2a41d6a70b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.25/qiskit.algorithms.HHL.md index d52ce666225..ca6f2d14556 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/hhl.py "view source code") Systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4c5df5656a4..d35103f35ad 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 6542136e76a..37bb09ff020 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.md index 2e53f8abb25..703f520771a 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 16aea5c0c06..4ff530ca25f 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.md index 90f59f74936..99f9df925a3 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") An abstract class for linear system solvers in Qiskit. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.md index ace4ff0075a..195d6ae7a97 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") A base class for linear systems results. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 5d435e06011..828071085f8 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 346339eac91..43eca5da3b7 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.md index 2be2ffe8d92..dab4dfd4f10 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.md index 49cf01feaae..b7784de4cbc 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.md index 29ff1e70f59..8016ad1d832 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.md index 5d558a83797..308ddf79339 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.md index e15f655a13c..155b6730e86 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.md index 80985c59f79..6b95a4d11ab 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.md index 2a9caa1e2bc..dd79745f27b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.md index d9b6f50ade3..58dd8c1c7cc 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.md index c9ee200f03d..297b227f82c 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.25/qiskit.algorithms.Shor.md index 43d9d239c44..bf44ef3032f 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.md index 29429c230ab..8666044bbc3 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") Shor Result. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.25/qiskit.algorithms.VQE.md index 974e34a1d63..a71f7763e19 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.md index 8667004cd86..c0088011ce9 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.md index 043c72235c4..3cfde2deeb7 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.md index 282299ccc49..c685e6e6cd1 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.md index a2eb42c003d..f689ce5137a 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.md index 8cc769b8779..4535e33a34e 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.md index 320a2da2045..c8fa927308a 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.md index c33a9198de8..cd14867f526 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5db2468fec2..c7642b708ef 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.md index 4b08da729f7..1f575ddcfec 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.md index e4e32268446..3d16d6e192b 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.md index 20df721fd7a..038a472e106 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.md index b7361c2bd7b..9d09d71d01a 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.md index 4e29aec7286..edd2a901880 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.md index e288e1ce8e6..d988f51f278 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.md index 75acbf82ce6..ec21a1922f6 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.md index 2ef52d30202..655c1f1bee4 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 0856e50bf5b..fc5ebf7953c 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.md index 0a8cefe3e5d..fc196284bd8 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.md index 5eb307d6470..32e64af2d05 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.md index 0ed226faf24..e07787c2b9a 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.md index 0ee40c914bf..ec70d18b8fd 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.md index 0a31ffb9b99..a0ec22f3126 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.md index b9628dad7d8..4a27afbfd5f 100644 --- a/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.25/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.25/qiskit.aqua.AquaError.md index 72bdd21c8cf..b0bbe2c81ef 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.md index a2705fb67ae..eef98fffca2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.md index 9ee4dad3049..0d8d6fc9477 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.md index c82a3f32b92..630926f0093 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 1f4556654dd..055cccfe474 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") AmplitudeEstimationAlgorithm Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 0450944cb6f..6382e73321e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") AmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.md index c782a8d61a8..33fd16d3b8f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 2c7ef4f8ac5..bbbc746c26d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.md index 39823865eaa..a67ca03ffc4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.md index 8ea64d5fad0..d3f8f9d731e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.md index 60113e9584c..e4598fd3333 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.md index f65a77574de..5d0835978d2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.md index 31d6a1c92f5..d1dc9805d11 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.md index 21f87ab7b5f..716729919ab 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.md index 40e4e5b30c0..c20a7413d27 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.md index ade87bb3d36..deeafde8261 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") The HHL algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.md index 711bc422e46..fe9eef0961f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") HHL Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.md index 3f5ba5aa9ab..b0a14448851 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") The Iterative Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index 8f2f88b7644..31a0777eceb 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index ca43e5778c6..79f7e665c21 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") IterativeAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.md index b2f1bbffc4f..ecfc7c0798e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Linear solver Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 24fc5dce30d..8a298d586b7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5c5d5e9ba73..148f0f90794 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") MaximumLikelihoodAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.md index b2572553aed..9f3296c218d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.md index 7f00556e724..bbb0f773d64 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.md index b6ce362fe1f..5ffd928f1e5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.md index be768fecf96..13f5d645b9b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 3bfdd481080..f97e6f296e7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Numpy LinearSystem Result. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index c424f9e0e3e..d4a62ade0f5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.md index a6e445c0c3a..075785e6fdb 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.md index 1c9433e0d0c..e49adddc4c4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.md index bf43630fd78..e2f4eba9f96 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") The Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.md index 4b11c7633ba..b3deb6dbdd5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Quantum SVM algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.md index e6dd5b1eaca..ce3d74260e7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.md index 56b4c11512f..2e3a4acafad 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.md index 8c76ae0bbda..4c781638b97 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") The Simon algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.md index 138ef590f05..a49fe1e2bf2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.md index de10c7051e1..d94d46d0847 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.md index 6889911df56..15795469c33 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.md index 433ff83adf1..8fbf05eac12 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.md index e309a95bd69..2385738c43c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.md index 99920079c46..73bd8cdd705 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 567d5d259dd..6df044e0ba4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.md index 2d4db79e802..9bc47428835 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.md index 345d2660260..2522a4854c2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds q^T \* w to separate register for non-negative integer weights w. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.md index 65c6382293c..9806b883b54 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Base class for eigenvalue estimation. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.md index f1abaff3330..bc20afe9d56 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.md index d09393cf480..e9f7b7b57f3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Base class for FeatureMap. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 9a188d126e0..8ea631c0a78 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Raw Feature Vector feature map. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.md index b1d1f7b7271..5a1982c7ace 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") The custom initial state. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.md index 4bed6eca882..ca765509ba7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Base class for InitialState. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.md index 446d360c9bb..6eb58020d6b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") The variational form based initial state. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.md index b9a66f9d084..86296612375 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.md index c97d45b3cf4..34bae3465dc 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 4b2eb2401d1..33d47cdb258 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 2eb6d3936db..e5ddf888858 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Base class for multiclass extension. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99d97264a8a..2ef53d7a23d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index cd60657c2a6..96ff7c3a0d4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Base class for discriminative Quantum or Classical Neural Networks. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 9724d541106..00fd1c50839 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Base class for generative Quantum and Classical Neural Networks. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 258ba48db93..cbede1b9f11 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Discriminator based on NumPy diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index dd11fb4be31..b3a32c57436 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 4cd9e258717..fdbc49aae48 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Quantum Generator. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.md index c20e5fb3db1..95d989bc92b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.md index 954ee20efcb..5823c34e847 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.md index 6f1df370dec..05c8a097e53 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.md index 4fdf15efc24..99abed6409e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.md index 67750b21b4d..58775337bc4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.md index 69f36fe5624..183be12c4e2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.md index f56e5ea574b..b14e7f6c251 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index cccef7e7320..72a9933e1f2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.md index 0906f993280..279ce0fb387 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.md index f88b865421e..636612e97c7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.md index 7387deb4d94..f7995f0a52d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.md index 555b00309b0..3cd707eaf29 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.md index 63dc681d75d..79558fd2d4d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.md index 34a97f3e91f..171aa2b67d9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.md index dae5ca40b91..c04ac766d9b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.md index 116295f4b6a..69dca758b6d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index d0e669bb1a7..37309e501f9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.md index 9c92991e2f7..56344c968b7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.md index 942baa7df9f..64596f96b46 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.md index c8ae54d9375..f4088801997 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.md index f883074badd..716c298f629 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.md index 211bbe75eb9..9d62ecb9d94 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.md index 52d1edcfb01..8575b1a8289 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 1efaf9e160d..6e6feb2e2c1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index 65747fac0be..3f4147f11aa 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.md index 29b17616d91..04bc2a4d417 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Base class for oracles. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.md index c8e8073d3e4..154378c14ca 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.md index 733b94065b9..8a122be5cc1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.md index 9b6aa75d977..e35cb5fddb6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.md index 29c83c2fd62..86c1b50d8a7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Base class for reciprocal calculation. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 945b9184909..e3e1dff27f1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") The Univariate Bernoulli Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 3715f75da1b..eea2bf371e7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") The Gaussian Conditional Independence Model for Credit Risk. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index ad68dffadeb..f04631bb7f6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") The Univariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 5ea01becec1..3622ff695a2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index e6038a59507..f2abd17b3d9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") The Multivariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 94b689e8499..702881b3beb 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") The Multivariate Normal Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index 7b2d17d5126..8c73d966e65 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") The Multivariate Uniform Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index a55a92a56e6..3406fdf8517 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") The Multivariate Variational Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index ad8841dd922..b3e399cf438 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") The Univariate Normal Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 082f187b3b9..b9a129ad8b4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") The abstract Uncertainty Model diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 089a4e41e48..54b2b6b2020 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") The Univariate Uniform Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index 8cc2bde0c8b..336f9e61c25 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 61ddd07d327..3eee9c45c7a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") The Univariate Variational Distribution. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 0f147dad700..32b5cf95140 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 4efc7c450e2..1570c4b049e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") The abstract Uncertainty Problem component. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 00398280d6c..4455c3fde38 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index c03f18d2b15..3763244e48e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.md index 7f77cc6a568..ae54370571e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Base class for VariationalForms. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.md index ec1917ebed0..9270c17966e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.md index 729f6c68b5e..16564a49cf8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.md index 101c6bac51f..104cae3fe55 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.md index c9c7905ff87..29d99e3b4a3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.md index fc2e0ba5493..289c8148ad7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.md index 14b55172bd2..013ed5623c9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.md index 8990a75bb23..9d7b75a0499 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.md index a8b3394e7b9..5d9f1afdf50 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.md index 924860e8670..c43bffcbc12 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.md index b78b1c8ba98..0f416fb1f81 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index f493a23c982..657c2eaf4b2 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.md index ff4a37374f8..26e712f47d8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.md index 663d6383679..63b01749667 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.md index 6937b3fc107..5a710fdbab4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.md index 493badc098d..0edc7d5fe4d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index 5acb3a36034..fe533716b26 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.md index d7b830c478e..fed697d4233 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.md index c6f9a807400..361118c50b1 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.md index cd31bab12bf..ba5d70e49d0 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.md index 520dfc545de..98c4fb9e474 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.md index 43fa318a514..a868c4bdba9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.md index 07eef403ff8..692df017e9a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.md index 8b6c5c27435..7b74a425017 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.md index 0af05335f59..e77492cc3a8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.md index a7034b7eb91..4358446ae62 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.md index 3ebf61675db..e4964472425 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.md index a531bd1b466..33f5d0652ee 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.md index b9b5a7aa145..25e02a21a8e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.md index d4b1ca8b495..63c7da727fa 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.md index 48a5ac2948f..a3c798ac103 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.md index 60790f54865..cd438b5d63e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.md index 817840970a5..5e8c7943fd8 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 9160971edff..aa8397ab620 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Operators relevant for quantum applications. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.md index dcfcb2d47f6..154e11912a7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.md index 56a752f289b..b8d7a1deb2f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Pauli Graph. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 6e3362f5b06..54b70f2993e 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") TPB Grouped Weighted Pauli Operator diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 46267d36942..8c7716d5814 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Weighted Pauli Operator diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.md index 8a6fcf48fac..c97c874fb6f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.md index ae2ec0e6793..351a63dea5c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.md index 667679ecec5..bcec2f74aa7 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.md index e16a1ab505f..6d86cba2f32 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.md index 4ef7c8af75a..76e3cec082c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0a46099874e..e15dc17735d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c584f2aa350..ba75a648daf 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.md index eeb9f35ed8b..478c72ab719 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 9867f1076e2..bdeec83e436 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 77fcc50b8ec..d477db9812a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.md index f0bc8604346..0eeaf0a02fd 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.md index e501482d8e1..05487a0a028 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.md index e63b4bae41c..a8dbb043504 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.md index 5ffd220a203..72d5480cbe4 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.md index cf5411c0ae5..fb2b001ed7d 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.md index 296315f2a33..a163f1dd643 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Base class for CircuitFactories diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.25/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.25/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.25/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.md index d1632a4184f..febbb1173ee 100644 --- a/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.25/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py "view source code") Class for Run Configuration. diff --git a/docs/api/qiskit/0.25/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.25/qiskit.assembler.assemble_circuits.md index caa783f499d..6349ddca727 100644 --- a/docs/api/qiskit/0.25/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.25/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.25/qiskit.assembler.assemble_schedules.md index 7c20b810bfd..b7d0e44ee02 100644 --- a/docs/api/qiskit/0.25/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.25/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.25/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.25/qiskit.assembler.disassemble.md index 3ca3fdc354a..bdfe1082bed 100644 --- a/docs/api/qiskit/0.25/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.25/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.md index 5c24fc48425..9940482184e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.md index 747136a0eec..955d0862bf5 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.md index 920d3f7a586..986c8ace0f2 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.md index 94dabc11d23..2a2137f0aa6 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Molecule data class containing driver result. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.md index 748e8648b33..ab262eba395 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.md index 05db7fb4c1d..9e0c20dc5f6 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.md index e4f4159190f..446cd7614f5 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.md index 8bc2599e3d7..379b0ffbda3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.md index 5795becc89a..c7bec35725f 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") A factory to construct a eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index bc7f21a57c3..2485d08dc09 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index 84a7fb46129..e8490042751 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") The excited states calculation interface diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 3dc080851a3..2cba3095bb8 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.md index 81e46c6895c..628441ad2df 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") The ground state calculation interface diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index f5231e126f6..5b0c2212770 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") A factory to construct a minimum eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index 22b0c687db2..121cee11ff7 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index fdf3ea87d60..48578808d21 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 66e029e6e97..0fc89fd5d13 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.md index c740cc0916d..12b6c879030 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.md index 10f5bf790b9..bd4b5beda83 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") QEomEE algorithm (classical) diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.md index 52341c1f288..a8383d988ee 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") QEomVQE algorithm diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.md index 91c095d3e2c..af6f1263af4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 7475c54a220..e49abf6427a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index d889402948f..ef4fb71169c 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 7fb7a8d3d9f..65c259a031a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 3a84c9a2f36..1eb0f3fe5a4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index f4c17027475..d32fc9580fb 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 75ac290d615..3d79c5bf9ba 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a potential energy surface diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index b7e582e3e2e..7c340ea87bc 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index bcd46c5f7bb..8775905ff06 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Implements a 1D Harmonic potential. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 54708eb2f7e..d2535769625 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Implements a 1D Morse potential. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index a73b1fb0456..2d7e114251e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 61194171a49..b9c4941f5be 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 1d859cea127..7c4a0073c60 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index f706abfdc97..3093a133add 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index bcea8622fd5..905c40eb111 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 4e834213def..9d9775ca901 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index cd1181103f9..cc8da4b32b9 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Molecular ground state energy chemistry application diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index c06008cf7d7..945666620d7 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 77719be753e..f98567f64f1 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.md index 76c30edce7f..2d9d0d70387 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.md index f95092a6d16..3054f09ac8d 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.md index f7ce6a53c02..b537bd9de45 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") This trial wavefunction is the Compact Heuristic for Chemistry. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.md index 4b2e49ad24a..e4fe17702d7 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.md index fbb3af3f7cb..5fd446b538f 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.md index 7a04e316abb..0b220e457c2 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Base class for ChemistryOperator. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.md index b5b4bcc999b..185dc931e06 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.md index 472883dd644..86424d40d53 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular chemistry Result diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.md index 5ce2ba01ee9..10c36ed37a4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Excited States Result diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.md index a5758bb9c74..b6ccc3eca49 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Ground State Energy Result. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.md index ce80df72b53..5b8d8a929a3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") QubitMappingType enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.md index 37622039125..fd938f5a0a7 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Transformation Type enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.md index 28c9c724102..9034ca598f4 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.md index 84eba214cee..3824fc7c343 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Basis Type diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.md index c1ff963cf6b..f966e471f6d 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Base class for Qiskit’s chemistry bosonic drivers. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.md index 059fd03f59b..559ab8099a6 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Qiskit chemistry driver reading an FCIDump file. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.md index a2a64dc4b38..e141b6ecbba 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Base class for Qiskit’s chemistry fermionic drivers. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.md index 8569c886245..a7afb167a16 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.md index 12591ef52b8..cf24c4d96aa 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.md index 8b57a5a98dd..d9243ba36f8 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.md index 9326f859b70..8158d55b550 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.md index 3ea0b3e6e71..79a14826c18 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.md index 0edd9b59c50..d62382da59b 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") HFMethodType Enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.md index aacfe0f8d8f..8562017cc21 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Initial Guess Enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.md index c9e14294833..506e0425c5e 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Driver-independent Molecule definition. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.md index de7fcc3f798..fdb29f147d3 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.md index 1011f674456..5e063af7f3a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.md index 5177ea1e968..285a1320513 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.md index a43e813c0a9..db273883a45 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Units Type Enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.md index a84f7153a90..07a6eb9eab5 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") The BOPES Sampler result diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.md index 97fb8c855f1..f865295260a 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") The eigenstate result interface. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.md index d10665d56ca..4d37d454137 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") The electronic structure result. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.md index 41cc19ec851..4d61669b64b 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") The vibronic structure result. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.md index 01afb136d73..f50e6d669d5 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.md index 74da609f5a7..72622b1d608 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.md index b2257adaf1d..e9b62d52d3c 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicTransformationType enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3c79ecddccd..1847365b7c2 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.md index 39a1dcc61fa..a135e2a8287 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.md index 313dfcc0743..5803fed8481 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.md index f2f8e92bd2d..421c80b7baf 100644 --- a/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.25/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Base class for transformation to qubit operators for chemistry problems diff --git a/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.md index b8689446b24..48a58d682f6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.md index de10a32674e..e0290b3d0a0 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement an ancilla register. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.md index d083711c431..def9b25fa8f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") Implement a classical register. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.25/qiskit.circuit.Clbit.md index 464a68392df..74e20979ffc 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") Implement a classical bit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.md index 9c06f2820a3..62c183dd41e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/controlledgate.py "view source code") Controlled unitary gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Delay.md b/docs/api/qiskit/0.25/qiskit.circuit.Delay.md index d5c6ff453d2..aeadce3ce9f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/delay.py "view source code") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.md index a4076c216a1..424d81eb007 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/equivalence.py "view source code") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Gate.md b/docs/api/qiskit/0.25/qiskit.circuit.Gate.md index 87ccf338957..54771e428d4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/gate.py "view source code") Unitary gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.25/qiskit.circuit.Instruction.md index 27c72011ece..32af90da5ea 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instruction.py "view source code") Generic quantum instruction. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.md index 65b771ba972..371785e4377 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instructionset.py "view source code") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Measure.md b/docs/api/qiskit/0.25/qiskit.circuit.Measure.md index fbc388f8ebc..80fd13c3be1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.25/qiskit.circuit.Parameter.md index 96ebbee240a..fad20f5f650 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameter.py "view source code") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.md index ea4fe86a18f..910130a0ce7 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameterexpression.py "view source code") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.md index a1145de5ae0..1f7876fd981 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parametervector.py "view source code") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.md index f888c9d4f90..ff84c360857 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumcircuit.py "view source code") Create a new circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.md index 2a12a9e1d24..bb7934be4ca 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement a quantum register. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.25/qiskit.circuit.Qubit.md index 7e07d881fd0..13ec1c3157d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement a quantum bit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.Reset.md b/docs/api/qiskit/0.25/qiskit.circuit.Reset.md index 6c7b62d0bca..29189a0037f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.md index ca96fbc97a9..ec78258a01f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") The Boolean Expression gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.md index 5493bc601b1..c85fb8bd9e9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 203d8900620..7a4905c5809 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 696bd8c7af5..6405f681e92 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.25/qiskit.circuit.library.AND.md index 100719fa8e5..8da398958cb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.md index 48067f79177..9878d93904b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/barrier.py "view source code") Barrier instruction. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.md index 2c76e5f589c..65ddb03b4b9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.md index c71b31ab9ff..f0ebe618639 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.md index facfe34ef63..0ccf5336925 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.md index 46c58665cfd..8347d7c4be4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.md index 02ea8afc1c6..bb279bd6c4e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.md index bf1f8247edd..c25e44f3564 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.md index de66b1e4fe7..3f965968d07 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") Controlled-RX gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.md index 3ae575796dd..1351553d161 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") Controlled-RY gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.md index 489b596fcc2..d365c733473 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.md index 4458281078f..6918c1a4c71 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") Controlled-√X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.md index d09fbd49b4a..c4106265d44 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.md index 15b7ffe7aae..5d0e0222bb9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.md index 6a87acc41c4..adb8a77ca7e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.md index 4a8f4228748..0808aa5c07b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.md index 5e4bf000bd5..57444db44cc 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.md index b6f9894be80..99adc9969c5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") Controlled-Y gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.md index c5f9f859308..ebeeaf808f3 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") Controlled-Z gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.md index 1184e2363e1..5152b5bec1b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/dcx.py "view source code") Double-CNOT gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.md index 52326cd3d08..5416e8f05a1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Diagonal circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.md index af7c6bd4ee0..9d34fb14c21 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ecr.py "view source code") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.md index 9daf5778e4f..7f2b2860726 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/efficient_su2.py "view source code") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.md index 8807938ee81..356ba994eea 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.md index 272d9d68dc9..393940ee7df 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/fourier_checking.py "view source code") Fourier checking circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.md index 501d69cbe95..b10f27f8c35 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.md index 232405893ad..87aeee6807f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GR.md index 9e696d6765d..d0b4278d7c2 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global R gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.md index 582c6a757b1..e985e281df7 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RX gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.md index 3c7b1da5fe3..41b5ab3f057 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RY gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.md index ff157d3f399..4c38078c31d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RZ gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.md index c5d0ae47f5d..eeee34394ce 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/graph_state.py "view source code") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.md index 1a43549ebd9..fd3b350a9f0 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/grover_operator.py "view source code") The Grover operator. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.md index dd9495a2bf2..1fd884aec7d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.md index 80407f7e040..fcb84e70e76 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/hidden_linear_function.py "view source code") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.md index f09fda86823..eb81b33cc00 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/i.py "view source code") Identity gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.md index 4347d5a7d7a..86968433ddf 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/iqp.py "view source code") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.md index 32ae75b6eec..3bc61bb44f1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") An n\_qubit circuit that computes the inner product of two registers. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.md index 5c8d2206dae..5acc0bc8e4a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Integer Comparator. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.md index 17fe48b56c7..08d138ed108 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.md index 31e2cb190cb..62dfa21c77f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.md index e6388c9f6ad..b00e731b7ee 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.md index 1112166944d..8d1cabf910e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.md index a775885af26..d74038fac5c 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.md index ad365ea6e88..52afb1d2c57 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.md index 25a83e73333..93c004fffd0 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The general, multi-controlled X gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.md index fe84787d890..3e153507f0f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.md index 336eb9cfcc2..67d0a987ceb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using recursion. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.md index cd8600feab1..276cf79c504 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using a V-chain of CX gates. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.md index 314e2adfb3d..b6fb9748276 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ms.py "view source code") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.md index 96884eb1d54..8ea2da31c57 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.md index ad8c5b9b527..deadd4cdccb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/n_local.py "view source code") The n-local circuit class. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.md index b2213fbb2e7..635da6f2cdf 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/normal.py "view source code") A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.25/qiskit.circuit.library.OR.md index b73f0f620f9..4d0c2cd567f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.md index b6671dd8343..f4434ee4819 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.md index 6ac7cd922f5..64eb0e91f5b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.md index 96719c5595d..ca8d567d0c0 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/permutation.py "view source code") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.md index 0c250f5c95c..c7824bb58c1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_estimation.py "view source code") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.md index c90230ba96b..c44ec9d5e11 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.md index 7a22a9261a5..8041530e049 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_oracle.py "view source code") Phase Oracle. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.md index 6355e51f727..645029b1cc9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 62784bd9683..971a82aa5ec 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 324cdac906e..e4d18d85866 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.md index 90ba11282fc..43fc1cfb39a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.md index 04181a24fd3..3d77911cfe6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='qaoa')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='qaoa')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.md index bc4ee09140b..75a1419d483 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/basis_change/qft.py "view source code") Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.md index ae475a0a444..b5ad80d7d59 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Implements a quadratic form on binary variables encoded in qubit registers. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.md index 5455f2da0f0..154cbd1d12b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/quantum_volume.py "view source code") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.md index d828fbbb76a..142218cedb8 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.md index e80e66e23c5..9ad9fec2a21 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.md index 27ae45fddb7..dc4cf3013e3 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/r.py "view source code") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.md index 2c2e1883a75..2e35776bb55 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/rv.py "view source code") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.md index 7ebd43c879a..0aa6996af5e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.md index 2a791ae1a9a..4fcc145ef71 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rxx.py "view source code") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.md index 8b14cb14fa2..5942b88a721 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.md index f1197436491..ef94d257fe9 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ryy.py "view source code") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.md index 8128226e26e..d7c497e3862 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.md index aff25ba90f8..ddf87476d96 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzx.py "view source code") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.md index 177b15c039b..534d21b34d1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzz.py "view source code") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.md index 89ece5699b7..c380abd4801 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.md index 7b7c61b44df..e0c93f1d6cd 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.md index b8a49fa527a..5cd883593b3 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.md index 281cd0ffbcd..7ea3965c035 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.md index 931bd4bac39..09ae9a04916 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.md index cfbddfa9148..02d1d4b0c49 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.md index 40757d25acb..b6d7d3749d4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") The SWAP gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.md index e8f4333227c..01a1c5f7fc5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.md index 8b396c13f5e..8584d33be78 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.md index 33382a0893d..9f643c34167 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/two_local.py "view source code") The two-local circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.md index 029f06a5044..f9266056e27 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.md index 9d178a3df1d..34db0c7f695 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u2.py "view source code") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.md index 55447af66d2..a94db2b64ae 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.md index 7c04d167347..2f0460ec780 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.md index 89c99cb51cc..cc661eb2f01 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/uniform.py "view source code") A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.md index e10b7d9e0bc..e93b1524c76 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.md index fc8bb4d214e..5d3304cdf92 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.md index 06cf3bbe600..6ced6399ec5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.md index bde4bf63e2c..ecafaa289bb 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.md index bb797b3d2d2..85d02bce71f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.md index 944bc5a0ad5..a88d237646f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.md index 1a293658975..a3743375865 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_1.md index dc4faed3a93..e3cbf9e0a18 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_2.md index a1e62d88610..4aec5545ca1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_3.md index 5e6651ff807..b5a1ee51204 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_4.md index bcc219cdc9a..17d112be973 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_3_1.md index 7a2889c3321..36d9f286835 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_1.md index 1181d7dd892..61afa53bbe6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_2.md index b4c80ed2ffe..f384fc66775 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_3.md index 6c47aaef224..c12df5f9403 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_4.md index 1f7012859be..9e237e2a6e7 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_5_1.md index d9164f65b22..1dfff65b466 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_1.md index 3f6bf6db46f..bfda63fd168 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_2.md index c63bb56f2b2..6ea1326ed8f 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_3.md index 65d8bc1dccd..cb8b6edeb14 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_4.md index 7d6f87b894f..a182d0cf7f4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_5.md index 1dc75c07c75..1935ec61892 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_1.md index 0b9445c8ddb..c938578f239 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_2.md index 1bc852517ef..42e229e947e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_3.md index b6aa73ac4e1..fa2a54ecaf7 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.md index 12e5e1dfb5a..fea6d949cf5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/iswap.py "view source code") iSWAP gate. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_cy.md index 7ccb8c60296..e38e4f167f3 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_xz.md index 1651b1a1592..8793a9321a4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_yz.md index 2ec0caab564..b00d3442af5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz1.md index c9003249f9b..d6717d449ac 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz2.md index 67639bdd08f..72af0080570 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz3.md index 52fd7573040..2bbd9d25cf6 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index dec29c85192..d7212cbdf12 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 4a1561de3b7..26d5b88e2f5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 5465418bb16..71359895c17 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 5ff2a8cd00b..32722501373 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index e008e1d3606..d095b00cbcd 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 2bdd91aec8c..d8aafae0082 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 713d02d8971..df95b4a13ca 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 05da7fc345e..ffce1633fa4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 585f829babb..49a9feae969 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index b07096e01d7..ed86a33416a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f3854aace9a..12ee3bc9110 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index e7e409508a5..c244cdf8cba 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index f0f455970f0..e195041a20a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 6aeff1fc0d5..c7c3e32e552 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 281601f57b8..2c61c90f851 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 67130cf48f6..947ea64e535 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 2837dc024b3..e1465477f79 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index a82552427d9..d1ea13ec6bd 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 7c5b7cc15f8..14f8b25b321 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index ff698e57d50..c87f398da5e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7e302ab4a62..b7c55f674be 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index d4849b0ec07..f42f2e937dc 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 0a47443257a..d87bc1a8271 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index a616d285f91..4aa4a6dc94d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 257e60a4624..6f285fff2ca 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index f2c8c9d5682..5262b2bd07b 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index c158da8da0e..1e8fab96a69 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 6c6e6b9df63..33c443f6608 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index f8becbdd978..222d07711b1 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index d0eb88381e8..6a64f319cc4 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 5e55b75867d..2132041a985 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 730fb05f07b..bf9d9da3555 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 68c9b82dd2d..700c51d2c10 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index f00914d9ec3..bfb6fe8239a 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 66bbb71d092..5df1f2a3564 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 77216d8ced2..7f07f840eaf 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index c985bf917ca..17ac239ee84 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 42ca1cfc0da..d75b80d9927 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 8d91854d4e6..a203bba6f61 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index caa4ba6c373..06d9b565371 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index e4ee0f9f628..06ecb552099 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index f3c1feec0df..e06573c24e5 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 108ccc7045f..62b7e05a4a3 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 81ecf210b0b..a94b396f37d 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 953d059611c..da19fdce43e 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index b0e70996835..15925f38779 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index fcf33cb097d..27c6abb91df 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.25/qiskit.circuit.random.random_circuit.md index cf07ddfdf4c..895b8ea9ebd 100644 --- a/docs/api/qiskit/0.25/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.25/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.25/qiskit.compiler.assemble.md b/docs/api/qiskit/0.25/qiskit.compiler.assemble.md index fb20d988d7e..250b0a0f358 100644 --- a/docs/api/qiskit/0.25/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.25/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.25/qiskit.compiler.schedule.md b/docs/api/qiskit/0.25/qiskit.compiler.schedule.md index 90381037ca0..d357f5eb64e 100644 --- a/docs/api/qiskit/0.25/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.25/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.25/qiskit.compiler.sequence.md b/docs/api/qiskit/0.25/qiskit.compiler.sequence.md index 0f2a638fe95..674c495df7e 100644 --- a/docs/api/qiskit/0.25/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.25/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.25/qiskit.compiler.transpile.md b/docs/api/qiskit/0.25/qiskit.compiler.transpile.md index a22cb317ac3..f661128234a 100644 --- a/docs/api/qiskit/0.25/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.25/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.25/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.25/qiskit.converters.ast_to_dag.md index 519b199f43c..22e18dca211 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.25/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dag.md index bf3751905c2..c3fd72e03cf 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dagdependency.md index 67a08de74cb..2ec4738cb4e 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_gate.md index 065af631ccf..9f819ac9b94 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_instruction.md index d7e15cc07a8..67ca9eb42d5 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.25/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.25/qiskit.converters.dag_to_circuit.md index 0d3af46949c..e973c795a9b 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.25/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.25/qiskit.converters.dag_to_dagdependency.md index 5a14894f46d..9cfc2bcf89b 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.25/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_circuit.md index a1808e8bee6..223914d0566 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_dag.md index d7f056bbc86..ecc5d7648e8 100644 --- a/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.25/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.md index 8c6149b55c3..57dd50d7d62 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagcircuit.py "view source code") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.md index 2351592301a..768c8b11811 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.md index d5b7d0f4c42..e6e3ab74d25 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdepnode.py "view source code") Object to represent the information at a node in the DAGDependency(). diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.md index cbd83ac69a9..d8e594c1bcf 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdependency.py "view source code") Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.md index febeaa15a5f..23ad2af142f 100644 --- a/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.25/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagnode.py "view source code") Object to represent the information at a node in the DAGCircuit. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.md index 5837205347e..028996bf970 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.25/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/hamiltonian_gate.py "view source code") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.25/qiskit.extensions.Initialize.md index 8c4d741c96a..949e9b6cb07 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.25/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py "view source code") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.md index 85f85f8745c..f742203c37c 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/simulator/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.md index 33307a0dab7..85e8bbd120d 100644 --- a/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.25/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/unitary.py "view source code") Class for representing unitary gates diff --git a/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.md index ecb17062b1e..ca345b23a89 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.25/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md index 82487c60134..ef69b4836a1 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md @@ -26,7 +26,7 @@ Convert portfolio optimization instances into Pauli list -`get_operator(mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`get_operator(mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") get qubit op @@ -34,7 +34,7 @@ get qubit op -`portfolio_expected_value(x, mu)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_expected_value(x, mu)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio expected value @@ -42,7 +42,7 @@ returns portfolio expected value -`portfolio_value(x, mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_value(x, mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio value @@ -50,7 +50,7 @@ returns portfolio value -`portfolio_variance(x, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_variance(x, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio variance @@ -58,7 +58,7 @@ returns portfolio variance -`random_model(n, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`random_model(n, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") Generate random model (mu, sigma) for portfolio optimization problem. diff --git a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md index f91ddbb89e1..bb47d349453 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md @@ -24,7 +24,7 @@ portfolio diversification -`get_operator(rho, n, q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_operator(rho, n, q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Converts an instance of portfolio optimization into a list of Paulis. @@ -46,7 +46,7 @@ operator for the Hamiltonian -`get_portfoliodiversification_solution(rho, n, q, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_solution(rho, n, q, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. @@ -69,7 +69,7 @@ a vector describing the solution. -`get_portfoliodiversification_value(rho, n, q, x_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_value(rho, n, q, x_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). diff --git a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 9f5809eb8b1..4f464fc2052 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") The European Call Option Delta. diff --git a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index dab41ef195a..1682162de70 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 142aad07547..a502f97f51d 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.25/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.md index d85745d4aec..ff8b9ee0b55 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") The abstract base class for data\_provider modules within Qiskit’s finance module. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.md index 8f945e76f70..963504596fb 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.md index af2b26fb556..d2b478f9069 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Exchange data provider. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.md index b73991b0df4..b19b1d0c3e8 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.md index 105c54a6304..6b382b8766a 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Stock Market enum diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.md index 5556d0d8463..4fcb867c5fb 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Wikipedia data provider. diff --git a/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.md index b2529cd4972..25ccfa057df 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.25/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Yahoo data provider. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.md index ed885e86acb..f893ff8583f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.md index 529402f02ba..98d87705c94 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.md index 3be217cdf55..a5e78ab334d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.md index 02a0e6a865c..78f0982e69f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.md index 94f70611e32..445eb111c8b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.md index dcbb143056c..ac440e27f5c 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.md index 36ce349ad43..35b450c59e8 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Drag Experiment fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.md index d66deee5d0a..e133ca7ec0c 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Rabi Experiment fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.md index 810576dcce7..b2901ae9ccd 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.md index 2d63119331a..4c52b3df4ba 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.md index 639b9cf3e90..c6359b2cbc0 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.md index 98fb9d3ebef..f57659067dc 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") ZZ fitter diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.25/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.md index 86073e22305..472a8f16b42 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Class to read from Ignis log files diff --git a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.md index b0481d5b676..3f80ff9739e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.md index 2d9915510ed..fdaac5a520a 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.md index 6e65d9093b1..8fa8d3e7401 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Implements a filter based on a discriminator that takes level 1 data to level 2 data. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.md index 445d42fea9f..5376260c0bf 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Abstract discriminator that implements the data formatting for IQ level 1 data. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.md index 52c0f8470d5..ee9c25308de 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index c1c3ff698c7..919f54257e6 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.md index a642898bc59..79be0223b34 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 8e15311737a..6c0871b24a0 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index e7b577353ba..3e133e59a91 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.md index 24a8214febc..7d1c769ba6d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 94239cbb31f..20d9c599347 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.md index a66fbc2dc00..7474d28cca9 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 1fc9f995da8..05e6a60eaad 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.md index 2ea8d6aeb6c..fb77a6ff758 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.md index e0ce4027d78..965d40ad123 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index e5868d47162..0569f1eb819 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.md index e351e671e68..10b34c7821b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.md index 5745acc3c58..9fd9d225eb1 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Class for fitters for accreditation diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.md index 8f394ba2eb6..8a6398a21b5 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.md index 29ec35ed014..e3d5eadf067 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 984ccf64b31..5b483d5e83d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.md index c05e3fde8b9..5ffc2e22f3c 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.md index 9ac37c8dbe0..78f122d4e7f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.md index 2586d94a7de..b8b89587dc3 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.md index 76e568f038f..659f420190d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.md index e22e30738b1..d6b9ef1066b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.md index 9484ec90e87..ebdbd4cf482 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitter for purity RB. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.md index aa6434746b3..cd6678b16ff 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.md index 853da1bd407..5c89a7aba32 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.md index 3a16e469600..6abf51cec2e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.md index 1d4c9a2b8ff..c6524de5a29 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.md index 23e8a604805..c3854fe866b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.gates_per_clifford.md index 5569ec53283..46e7edabed6 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.md index 2ee9e3f459e..9d341eced4c 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.25/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") The raw feature vector circuit. diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.25/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.25/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.25/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.25/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.md index 8d94a664800..de0bf7bc9d6 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.md index 58f7a5cd1ca..ca5963e99cd 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.25/qiskit.opflow.anti_commutator.md index 707f53ac858..fb408209fdd 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.commutator.md b/docs/api/qiskit/0.25/qiskit.opflow.commutator.md index d1733a0b85b..d5d40b09107 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.md index 71e83825608..48ebbe7941e 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.md index 0c2082ae486..292d165e0a3 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.md index e24cc84de63..da3c686ca2b 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.md index eb9fa187fa6..c6964a48978 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.md index 877d5687496..4f3064c80af 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.md index 8a6916326d7..425bd278127 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.25/qiskit.opflow.double_commutator.md index 6ad64c090e8..850608b415b 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.md index 0008d1ba281..92b438392fb 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.md index 01965ad18f1..9e7bffdfd39 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.md index f37b64a5fb5..781d328deed 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.md index 0d432c8cff1..b362358f251 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 32d32c2b587..93a4756fe34 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.md index 17ed7374761..52619e0bc91 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.md index 43306334942..669fec7e20b 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.md index bf960e2698f..1988f1f115a 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.md index e8518cef03c..0c652c8734d 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.md index 1a3df80666b..ca66f92fc33 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.md index fdf350c314d..d46f1ee0f2a 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.md index 1f951aeddab..751922cdeec 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.md index 101d3c33823..ebc1296e137 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.md index 44194d5f04f..bf8ea9fd23c 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.md index f95770f1738..20a6c99656d 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.md index f7b5c9b5a29..45462b19951 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.md index dfa76447827..b57a610560e 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.md index abb19f47e5c..1377fe8dc30 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.md index 43d5e281feb..7b3b5bb2ff9 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.md index 9f54fdbdc23..3d65d5d4c53 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.md index 8f41fa3a5f6..55972daa363 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.md index 7ec10d6e24a..bfcede6c7f9 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.md index 157026b9b24..2eacb98e044 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.md index 1ae6e337d8c..13b16a78202 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.md index ef0f9a593c3..ba4227a807b 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.md index 693007f5478..bdfcd6a0a74 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.md index 1f1700876d1..4c0566de079 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.md index dcaff673076..e1a9cab46dc 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.md index e7c1724d624..1eec993539a 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.md index 429e2c35ddd..68f41baa43b 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.md index 481377d1d21..73da1702b17 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.md index 9aae3c6f473..d55ef90b087 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.md index 744b19c7ed4..da79bc56dc6 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.md index ca056f2a6cd..db3f2bdd4d8 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Class for Operators backend by Terra’s `SparsePauliOp` class. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.md index 76c38b6dcad..bf891dd4ad3 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 3a6c2da01dd..20b3eada75d 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.md index 5b9af319b6e..a3f1b4a6f80 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.md index 852c80aef91..54d5ceda6ff 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.md index abbfb1bef17..14fc1084715 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.md index d3b02b27786..8a6c7765394 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.md index af13baec6c4..d910c0c706f 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.md index a10c86c03ad..78933479645 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.md index ac2e50b5ea5..95cac10a5d9 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.md index 2256ab68862..b5f3204ada4 100644 --- a/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.25/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.md index 304150f966a..bd857c9c660 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.md index 674474f35f9..78e99bc2472 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 17af3a09858..1b6166ac65d 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") ADMMOptimization Result. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.md index 5a9e3ff4519..7386da93f22 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.md index 15f3262f99a..4e343ff6377 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.md index 7ee07742d82..362a537c445 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.md index 5ebec509d34..d60a3e2901f 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.md index 30263ad300e..60f4bec0f02 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.md index e8ab32b3942..2e874fdb345 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.md index d2e209d9519..efeac68726a 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.md index ab548ee9a40..e9bb5ad2434 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index fd484fd9968..493aaf92877 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 9a551193b54..9423baa3dfb 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.md index 67ecb8e93b2..e82e9412126 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") An abstract class that implements multi start optimization and should be sub-classed by other optimizers. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 60a45207071..cfa0e08cc4a 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") An abstract class for optimization algorithms in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.md index 29a0d61797e..83b5a934e43 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A base class for optimization results. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.md index 9026c12b26f..5dbb92371d1 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index b3b2bbe8a76..dd89b22cb2f 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index 44f22ffb05d..3941cba02c8 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 0e30e198c16..a188258a27d 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.md index 83328d79f17..e88bae6e104 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.md index 39310570580..670335045ed 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A sample of an optimization solution diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md index c0e4c528922..30654adc846 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md @@ -26,7 +26,7 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_operator(weight_matrix, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Generate Hamiltonian for the clique. @@ -89,7 +89,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`satisfy_or_not(x, w, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`satisfy_or_not(x, w, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md index a80b94865a2..3054279f4fc 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md @@ -27,7 +27,7 @@ common module -`get_gset_result(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`get_gset_result(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Get graph solution in Gset format from binary string. @@ -47,7 +47,7 @@ Dict\[int, int] -`parse_gset_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`parse_gset_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read graph in Gset format from file. @@ -67,7 +67,7 @@ numpy.ndarray -`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate random Erdos-Renyi graph. @@ -92,7 +92,7 @@ numpy.ndarray -`random_number_list(n, weight_range=100, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_number_list(n, weight_range=100, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate a set of positive integers within the given range. @@ -115,7 +115,7 @@ numpy.ndarray -`read_numbers_from_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`read_numbers_from_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read numbers from a file @@ -135,7 +135,7 @@ numpy.ndarray -`sample_most_likely(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`sample_most_likely(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Compute the most likely binary string from state vector. :param state\_vector: state vector or counts. :type state\_vector: numpy.ndarray or dict diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md index 343cc6b736b..d966cb3984e 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md @@ -62,7 +62,7 @@ print('tsp objective:', result['energy'] + offset) -`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") +`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") Generate Ising Hamiltonian from a model of DOcplex. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md index 6eced2620c4..f974ade5491 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md @@ -24,7 +24,7 @@ exact cover -`check_solution_satisfiability(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`check_solution_satisfiability(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") check solution satisfiability @@ -32,7 +32,7 @@ check solution satisfiability -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") Construct the Hamiltonian for the exact solver problem. @@ -62,7 +62,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md index 2d3f7e88296..284fa2483c2 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md @@ -24,7 +24,7 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Generate Hamiltonian for the graph partitioning @@ -74,7 +74,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`objective_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`objective_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md index 6f9306be50f..f84a1081ee4 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md @@ -28,7 +28,7 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We -`get_operator(values, weights, max_weight)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_operator(values, weights, max_weight)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Generate Hamiltonian for the knapsack problem. @@ -67,7 +67,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`get_solution(x, values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_solution(x, values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian @@ -90,7 +90,7 @@ numpy.ndarray -`knapsack_value_weight(solution, values, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`knapsack_value_weight(solution, values, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the total wight and value of the items taken in the knapsack. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md index 0f7cd5d4d0f..4805af75417 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md @@ -24,7 +24,7 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Generate Hamiltonian for the max-cut problem of a graph. @@ -64,7 +64,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`max_cut_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`max_cut_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md index 451c7de04e4..4b11ba268e4 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md @@ -23,7 +23,7 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami -`get_operator(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`get_operator(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Construct the Hamiltonian for a given Partition instance. @@ -45,7 +45,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`partition_value(x, number_list)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`partition_value(x, number_list)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Compute the value of a partition. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md index 6fe5f8562f4..fb73f528287 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md @@ -24,7 +24,7 @@ set packing module -`check_disjoint(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`check_disjoint(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") check disjoint @@ -32,7 +32,7 @@ check disjoint -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") Construct the Hamiltonian for the set packing. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md index 2f6481bbfd8..49ec6bef7c5 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md @@ -24,7 +24,7 @@ Convert stable set instances into Pauli list. We read instances in the Gset form -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_operator(w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Generate Hamiltonian for the maximum stable set in a graph. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`stable_set_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`stable_set_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Compute the value of a stable set, and its feasibility. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md index e5f3da7c799..7cdddb409d5 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md @@ -90,7 +90,7 @@ Alias for field number 3 -`calc_distance(coord, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`calc_distance(coord, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") calculate distance @@ -98,7 +98,7 @@ calculate distance -`get_operator(ins, penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_operator(ins, penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate Hamiltonian for TSP of a graph. @@ -119,7 +119,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_tsp_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_tsp_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Get graph solution from binary string. @@ -145,7 +145,7 @@ Instance data of TSP -`parse_tsplib_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`parse_tsplib_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Read graph in TSPLIB format from file. @@ -165,7 +165,7 @@ instance data. -`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate a random instance for TSP. @@ -190,7 +190,7 @@ instance data. -`tsp_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Check whether a solution is feasible or not. @@ -210,7 +210,7 @@ bool -`tsp_value(z, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_value(z, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Compute the TSP value of a solution. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md index cb9da8e8f25..5f65ba76a71 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md @@ -25,7 +25,7 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela -`get_operator(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_operator(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Converts an instance of a vehicle routing problem into a list of Paulis. @@ -47,7 +47,7 @@ operator for the Hamiltonian. -`get_vehiclerouting_cost(instance, n, K, x_sol)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_cost(instance, n, K, x_sol)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Computes the cost of a solution to an instance of a vehicle routing problem. @@ -70,7 +70,7 @@ objective function value. -`get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_matrices(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Constructs auxiliary matrices from a vehicle routing instance,** @@ -94,7 +94,7 @@ a matrix defining the interactions between variables. a matrix defining the cont -`get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_solution(instance, n, K, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Tries to obtain a feasible solution (in vector form) of an instance** diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md index 5ed46e10885..e7a7f6ca931 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md @@ -24,7 +24,7 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https -`check_full_edge_coverage(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`check_full_edge_coverage(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") **Parameters** @@ -43,7 +43,7 @@ float -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Get graph solution from binary string. @@ -63,7 +63,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. :type weight\_matrix: numpy.ndarray diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.md index f8f704a52fc..29350019ea1 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.md index 2f5c80c1ef7..99f0adf8fe1 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.md index f024d2ee2e8..0dc4616b504 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.md index ab03f35f781..f9a975f909a 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") An abstract class for converters of quadratic programs in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.md index a8104b0ac7b..d4c568df7fa 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a given optimization problem to a new problem that is a QUBO. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.md index 93bc81c16d2..cf06eb77f61 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Abstract Constraint Class. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.md index ea2a6195930..333c6c421ac 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Representation of a linear constraint. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.md index 7d29ca84a02..571ef9bdd64 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.md index a4b05490665..fb524232154 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.md index b3a3d449e0a..98483913d00 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.md index 9b7213f270b..f8bfa4ff1d9 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.md index 37612451790..31d5a1779dd 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.md index e823ffa405e..fa73300a3d2 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.md index 284a7cdc3eb..059a4253795 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Representation of a variable. diff --git a/docs/api/qiskit/0.25/qiskit.providers.Backend.md b/docs/api/qiskit/0.25/qiskit.providers.Backend.md index 27965da709f..26ee0aa9929 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.25/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.md index 6d4a52d2aea..ffca01c35cc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.25/qiskit.providers.BackendV1.md index ec61a6906be..a4c068000dc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.25/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") Abstract class for Backends diff --git a/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.md index 4e9335e8cba..d266197603e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.25/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basebackend.py "view source code") Legacy Base class for backends. diff --git a/docs/api/qiskit/0.25/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.25/qiskit.providers.BaseJob.md index 5beccfe7ce7..cfb4d82c484 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.25/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py "view source code") Legacy Class to handle asynchronous jobs diff --git a/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.md index 06c4152aad1..faa0a818fbd 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.25/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/baseprovider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.25/qiskit.providers.Job.md b/docs/api/qiskit/0.25/qiskit.providers.Job.md index 1c855b5d67e..5b1ca9e7630 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.25/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobError.md b/docs/api/qiskit/0.25/qiskit.providers.JobError.md index f77462fa523..ba986ac2595 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.25/qiskit.providers.JobStatus.md index 656412ee927..fa48efbbb96 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.25/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/jobstatus.py "view source code") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.md index ec482d8a579..0f3c561a96e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.25/qiskit.providers.JobV1.md b/docs/api/qiskit/0.25/qiskit.providers.JobV1.md index 2206017267e..99ddbd07769 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.25/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") Class to handle jobs diff --git a/docs/api/qiskit/0.25/qiskit.providers.Options.md b/docs/api/qiskit/0.25/qiskit.providers.Options.md index 1d72f8e5622..92a63938cf6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.25/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py "view source code") Base options object diff --git a/docs/api/qiskit/0.25/qiskit.providers.Provider.md b/docs/api/qiskit/0.25/qiskit.providers.Provider.md index c8083cac943..3e34ef3b670 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.25/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.md index f18b14a9893..868bdfe5e7a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.md index 2b6f8d2458c..e2fb65a710d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.md index 2ee285ecc30..962f5d96008 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.md index a5f72fae952..7a37fccd21e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") AerJob class. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.md index 6baae661743..9f0aa5ad188 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.md index d4ecef6e1a4..b577121c0d3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.md index aae39c50b40..26038944531 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Pulse schedule simulator backend. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.md index 478eff1c779..6de36e122bd 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.md index 1b8736e1fc7..2bfa769ee7a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.md index 67af4b97c18..f33e13f5717 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.md index 066992c8407..df6a08bd898 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index ffe92423a6e..e569f4a78f6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Snapshot instruction for density matrix method of Qasm simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 7f79bbd276f..f17e67e2cda 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Snapshot instruction for supported methods of Qasm simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.md index ddb9a6d0618..7c7cb7c67a8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Snapshot instruction for all methods of Qasm simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 23fb21d1734..d7abca1d82e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Snapshot instruction for stabilizer method of Qasm simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.md index 6ad06288c23..444d19880c6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Snapshot instruction for statevector snapshot type diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.md index 4249e0b58db..b508cde6e54 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.md index 5145be163fd..3b9e1ac52c3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.md index 58f06adf8c2..28846ba4e0b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save a reduced density matrix. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.md index cc701db53b7..51cb318f0c7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value of an operator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 2c86695c951..708d6699363 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.md index f31dd2f5238..067432b4498 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save matrix product state instruction diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.md index 36e7f8ffb9f..87820b5c042 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.md index aa47a2401a5..9fb5f063512 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.md index 3e23b97c24b..1718829f0a4 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save Stabilizer instruction diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.md index 036e7471bfd..920a51b5ef6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save simulator state diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.md index 8ac28acac38..31c040b6dd2 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.md index 0d8625397cd..9b54b2dd98e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.md index 1777a39b185..5ff8e62cc1c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.md index 75eda5796a5..8b525c47e61 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save Unitary diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.md index ec7f72cca70..5f8532d50fe 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.md index 0a8ae348968..364f17e8962 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.md index ebbe1d257d4..5edbc66cdc7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.md index eac31f48437..a16a58c966e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.md index 4c9e01519d5..3395c79fa14 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set superop state of the simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.md index cba8cb98d92..d78ffe14ce8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes.md index 0b669b04105..c34cc5ee857 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes_squared.md index 79bb40eff0c..fdac25ecd47 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_density_matrix.md index 74cc65ec146..1e650bd5b06 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value.md index 2f0af0f1bc9..7d4ffada7f8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value_variance.md index dd1ed4ef639..b591246f76c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_matrix_product_state.md index e77c2db58c1..4db8d3ff042 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities.md index 606b66af4ea..a2eaecff1b7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities_dict.md index 16ae2c687ca..086ffe552f5 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_stabilizer.md index d01c85e1c12..3e086d79eaf 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_state.md index 07e5c762060..5cd6ad9855d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector.md index 482606c1893..5dc73b693ee 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector_dict.md index a1f1dc7b1e3..367fbad5b48 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_unitary.md index 73d179e5f2e..06fe9ae787d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_density_matrix.md index bee816e1bb8..51fec524b7e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_matrix_product_state.md index 2db259b4d51..6c1f7c0873a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_stabilizer.md index 31c78105b09..e31c686988f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_statevector.md index 63b8fb72b15..166311867bd 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_superop.md index 28725784533..a2acde4da8a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_unitary.md index 3755cd50221..0549bfa7dae 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.md index 8a585149850..e7c214d97fc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Noise model class for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.md index 1fc3e9bcb73..e953bdcab69 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Quantum error class for Qiskit Aer noise model diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.md index fd3891e02af..cc43a7ab1d3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Readout error class for Qiskit Aer noise model. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.amplitude_damping_error.md index 0305f120e20..1fc12ab472e 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.coherent_unitary_error.md index de1107669a4..aa2837fad3b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.depolarizing_error.md index 2505d42afae..a0face8dffa 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index bc242d7510e..b7c298bd8e5 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index c62af1cd229..3821d29c4e8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_error_values.md index 2b1bc8469bf..7b65ff11d8f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_length_values.md index be7ea78eba1..69721d2f87d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_param_values.md index e657b1665df..9c81011bd27 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.readout_error_values.md index 97d13adc45c..18730236d34 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index dd116379a5f..18946d6a22b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.kraus_error.md index a35fecba148..4585336fd09 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.mixed_unitary_error.md index 0669b855ab3..69625c92fe6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.pauli_error.md index c92b7ceed49..cdec5fd9b84 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index b76a0b6f054..9d1fedfdf22 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_damping_error.md index 29082f182c5..571f69680b8 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.reset_error.md index d44921cd510..c9c5a2c0aa1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.thermal_relaxation_error.md index 09ab8cb4351..5625c43ea4d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.md index a229bde8f91..625add9df89 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Physical model object for pulse simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.duffing_system_model.md index c880b5f09ee..11af83e0ecf 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.md index de7ab8ff080..974c0f09a10 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transforms one quantum channel to another based on a specified criteria. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_noise_model.md index 2f5e3d6397b..014084327f7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_quantum_error.md index 621da3e103e..6182b1978a7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.insert_noise.md index f907d1624eb..ba98e295c3c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.remap_noise_model.md index 02927d984ec..1ac257dc970 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.25/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.md index 26dc5dfdbfe..cd3623b8d65 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.md index 900892fec4d..d272271dfb7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerjob.py "view source code") BasicAerJob class. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.md index 9699d9c1257..3550986bee5 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerprovider.py "view source code") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.md index b2b8eeca532..76b892ef2a4 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/qasm_simulator.py "view source code") Python implementation of a qasm simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 07fef07a999..f4072c4562b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/statevector_simulator.py "view source code") Python statevector simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.md index 2d92a797b2c..a90d1e8bdd0 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.25/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/unitary_simulator.py "view source code") Python implementation of a unitary simulator. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.md index a04775c0097..1c6df64dfe3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/accountprovider.py "view source code") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.md index 17c6d3f2e30..588a61efdc4 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/backendjoblimit.py "view source code") Job limit for a backend. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index 49faa677c46..1bd89d7c4bd 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 8c0dce08dc8..4c195969f40 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index e61c61cdcd5..64e35bece90 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 080e922be38..f2d634472a2 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.md index b01062c8e6e..011996d2d01 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index e31ca8b9f78..51e6196247b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md index 6c7f191ac51..12a05030325 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackend.py "view source code") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.md index 5600e2b7e29..515a3565062 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index b321334c06d..0391fd48f94 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.md index cb8a8a0de8d..0abd3b14b80 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.md index c480cde2903..4d935ff9ed2 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.md index 7877b9c78ec..d2595e3060a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.md index 438ff53a9a7..3cc42b9934b 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.md index 979464c5f3b..f9402aea199 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/ibmqfactory.py "view source code") Factory and account manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.md index 5675ec9f6e5..2cc2ee2d376 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.md index 992e192e661..32a3876e300 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/credentials.py "view source code") IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.md index cfad2abe49a..4f03362642d 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 5006e7230b1..24dc9b57bb1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index b5b1a1d2dfd..9266efc8e30 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.md index fcddf43ac48..4f39cbe4833 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.AnalysisResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult -`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") +`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") Class representing an analysis result for an experiment. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.md index 6e62c8b74b7..d2f46d650cc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.Experiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment -`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experiment.py "view source code") +`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experiment.py "view source code") Class representing an experiment. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.md index 9f726818870..bd36b230e07 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.experiment.ExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService -`ExperimentService(provider, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") +`ExperimentService(provider, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") Provides experiment related services. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.md index ec9549fa80f..16739afc2e9 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.md index 6a0718280b0..00909120a3f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.md index d0a1d46168d..bddb709ef65 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 50e01b72385..b0006c97968 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 95f0b729ab1..965587eaf4c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index b4c914bda75..00794d6cdec 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.md index 5ab9b90486a..fbd2551d1f3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.job_monitor.md index 674e29b6c2d..80184657c69 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.least_busy.md index 3940867fbc3..d2d66ae64dc 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.md index 2145afbf1fa..c88cf135cd1 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index b2f5f0063ca..9cecb8409dd 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index dd02685a90d..d9594e76965 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index d4f6db06d8b..d4690e791ec 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 0f78915a05e..2cb0baf7879 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 4a6b7044e2c..bc64ea526c9 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 81edbe307c9..d0abb5fd3ee 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.md index a79e7a49d97..74fe17632d7 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjob.py "view source code") Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.md index 61007450cbd..2cd0487f713 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedjobset.py "view source code") A set of managed jobs. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.md index 24e375f0f55..15f8e712454 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/managed/managedresults.py "view source code") Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.md index f2dd36c3278..4a9e10efe1a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.md index e98cdbc3550..322c3c3c412 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.md index 39061357bff..86874d05f52 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider, access_token)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider, access_token)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.seconds_to_duration.md index e9505ebaaf3..e9f1efdc273 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.to_python_identifier.md index d728302cfe5..e53cce69ecf 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.update_qobj_config.md index 7cdb88728b6..8fb69649e3c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.utc_to_local.md index 46737a1c8ee..95340232376 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.validate_job_tags.md index 26526c0ebb2..ce1bb4e4128 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.12/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.md index ea62d3e3e9f..ae999514881 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Backwards compat shim representing an abstract backend configuration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.md index 394373d8a47..3fd560ff7ed 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendproperties.py "view source code") Class representing backend properties diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.md index d85c5bfb269..0162db0c57f 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendstatus.py "view source code") Class representing Backend Status. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.Command.md b/docs/api/qiskit/0.25/qiskit.providers.models.Command.md index 46b89d29b8f..a8bfdc69fd6 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") Class representing a Command. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.md index 28f63b0af7f..de21daf0e6c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Gate Configuration diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.md index 2d6c9ffb6eb..aceea0dcb19 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/jobstatus.py "view source code") Model for JobStatus. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md index cf2ea888aa3..17d320ba57c 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.md index 146cc3cfce6..d418bf7c7ee 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.md index a70a0a1e70d..7ac17865809 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Qasm Backend Configuration. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.md index d0d3331c6ba..4d99722c34a 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a U Channel LO diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md index 72f12354374..39b4110e664 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md index 7104f339ff5..bf6db5b03f0 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Call.md b/docs/api/qiskit/0.25/qiskit.pulse.Call.md index bdb134c5aec..9b1a7864064 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Constant.md b/docs/api/qiskit/0.25/qiskit.pulse.Constant.md index 7474845609c..8b8c72b4d5f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md index 5dea4fbfbd8..3583ff4c728 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Delay.md b/docs/api/qiskit/0.25/qiskit.pulse.Delay.md index a6331b59ac3..fbb8e8a4d5c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Drag.md b/docs/api/qiskit/0.25/qiskit.pulse.Drag.md index fa3d4820342..0b527cd4eb5 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md index 6e0feba01f1..abf5ca2fecb 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.md index 12ff45af77e..cc6646f4c59 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.md index b1db30256f6..1dbc14c0087 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md index 2c84e0a3425..f2fa53f4979 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.md index 8bd186075b4..b7dee2415fb 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instruction_schedule_map.py "view source code") Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md index 9d661b317d8..04b0993759d 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md index 0ef342e2e8e..23dfdad04f2 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Play.md b/docs/api/qiskit/0.25/qiskit.pulse.Play.md index 8291004209c..915c362b404 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.25/qiskit.pulse.PulseError.md index 963cd6c9685..12d2af8c9ee 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md index 7a8e1fca2fa..e72deb06365 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md index 9b92cfab1ab..174f2546abf 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md index 5164eaef864..8be0481bc9d 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md index 3df4a86fda5..64c589e200c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md index 1aceeec1749..d1cbc30559f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md index 33c38b6d65b..5c16a6d85a7 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md index 8cb59125556..df8548a4aed 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md index a94951dbe72..f969c52c4ce 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.25/qiskit.pulse.Waveform.md index 8914ca0321b..4c1416c3b75 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md index ba6fd3cb433..9df544b6074 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md index d5543331cb8..7426c83d45b 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.active_backend.md index 6e7d992cf44..cda31c0584e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 7514aade0a3..da3c358f83c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.active_transpiler_settings.md index a930c6dfa06..4aaa72f577a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_equispaced.md index 34c48217481..cf617ddaba8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_func.md index 7f3ab0f6707..bc6b3bf7536 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_left.md index 9dc6b03b3a0..688e95bcae9 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_right.md index 11f05cb8223..e9af2d88da4 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_sequential.md index 92e6a3b4a8c..b4e78bb7c96 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md index 3a7c88ca5df..5e1b78eb817 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.build.md index e79e8c0c309..25cae57b603 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.call.md index 23123ce373d..e687ce5a30a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.circuit_scheduler_settings.md index fbd0dd14a3f..adc1d755097 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md index fbe9d517782..c061c8919a0 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.cx.md index 28d0ac24d19..123b1a5d4f0 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md index 4f61e2869d0..cd38cd2c003 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.delay_qubits.md index 5260733e787..62e6cf4c68f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md index 830b1f50e7a..c432b1674a9 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md index d3f825feb9f..ba4b6d3dd2d 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.inline.md index 9eee0def1cc..f4cdbd312e3 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md index d172ff13c74..83a017ffcbe 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md index 1d3bf31c2ad..0bf66b239fb 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md index 3d2b1732509..c4f1a134858 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.num_qubits.md index 08e12f8e9a3..abc9f880d25 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md index 1a6ad5573bb..a0ba75ce432 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md index 772a71d232c..d194283075b 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md index a842a673bc8..449b66114d2 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md index 5ca23c2585a..f4e82589b57 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.samples_to_seconds.md index 6070f10a697..3ae963be5fd 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.seconds_to_samples.md index 3a60cdecbb1..e39c80647b2 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md index 87e5b588b7b..1252859cc60 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md index c85e44c392f..ff27ecbcb98 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md index 58142ca9fbb..f542a55226f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md index 96eb4a67d7d..fa83897b4d9 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.snapshot.md index 2a3d4b14013..a867310092e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.transpiler_settings.md index 96faf4f5d07..4fd275e4e61 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.u1.md index baad5b5652b..c64da80352a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.u2.md index f6b6308a9b5..cd42c6c18ea 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.u3.md index a0f420f64ef..ffb35a051b5 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.x.md index e745b3380e7..fed0e3109b2 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.channels.md b/docs/api/qiskit/0.25/qiskit.pulse.channels.md index e5222160a22..fc5f8e4afb5 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.channels.md @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. @@ -119,7 +119,7 @@ Parameters which determine the channel index. -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -216,7 +216,7 @@ A shorthand string prefix for characterizing the channel type. -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. @@ -301,7 +301,7 @@ Parameters which determine the channel index. -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. @@ -386,7 +386,7 @@ Parameters which determine the channel index. -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. @@ -471,7 +471,7 @@ Parameters which determine the channel index. -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. @@ -556,7 +556,7 @@ Parameters which determine the channel index. -`PulseChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`PulseChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Base class of transmit Channels. Pulses can be played on these channels. @@ -641,7 +641,7 @@ Parameters which determine the channel index. -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). @@ -726,7 +726,7 @@ Parameters which determine the channel index. -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md index 11fdb9167e5..e79404c2bf8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md index 44d242dbb6f..f0eccf9901a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md index dabc5660778..50cee606ea0 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md index 7cb7777c5d9..b990ff42a5e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md index dd53254d1da..67b13fa4fd4 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md index fe562941083..405372f8265 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md index 5a9fdb8ecc8..6aa92c81c51 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md index c1068485c86..8d21abe1d02 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md index b45bb0b93df..09c027cddd2 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md index 12fd63f17a1..31c52025356 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.md index c88f8591e55..d87aed08138 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.md index 54baca7dfd0..9b8e763699f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.md index 05fcfbf83ff..ec2c1e64472 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.md index d58bb1f5857..e514a61950e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.md index 13e95d0301a..4809ac760d3 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md index 0303f3540ad..e6f31ac8220 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md @@ -36,7 +36,7 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -60,7 +60,7 @@ $$ -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -86,7 +86,7 @@ $$ -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -121,7 +121,7 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -159,7 +159,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -186,7 +186,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -226,7 +226,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -274,7 +274,7 @@ plt.plot(range(duration), sawtooth_wave) -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -310,7 +310,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -337,7 +337,7 @@ i.e. the derivative of $\text{sech}$. -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -363,7 +363,7 @@ $$ -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -391,7 +391,7 @@ with the convention $\text{sign}(0) = 1$. -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -439,7 +439,7 @@ plt.plot(range(duration), triangle_wave) -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). diff --git a/docs/api/qiskit/0.25/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.25/qiskit.pulse.transforms.add_implicit_acquires.md index 4497fef18a6..eafa3ed254f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.25/qiskit.pulse.transforms.align_measures.md index 04563d745b3..4b364642e68 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md index c895d5da79f..b2b9d649213 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/alignments.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/alignments.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.md index 577e304c4c6..1a949167785 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.25/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.25/qiskit.qasm.Qasm.md index e92aff70902..a3054466f17 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.25/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.25/qiskit.qasm.QasmError.md index cac8b1467d8..eb8dbe90a96 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.25/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.md index d72e1a35777..ac3afb48e54 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.25/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.md index f10c4d80efe..90c2e68a134 100644 --- a/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.25/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.md index e642e5e4f4d..680063fad15 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.md index 4699723760b..7b93a15eac9 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") An item in a pulse library. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.md index b031efa6af3..be6c7177d15 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.md index 95c4a83c154..18ca521f7b3 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A configuration for a Pulse Qobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.md index 4f4c90e8843..58045890a6e 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj Experiment. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.md index 37f59007662..f91ee4d1e56 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A config for a single Pulse experiment in the qobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.md index ded4d145766..15cd2341326 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A class representing a single instruction in an PulseQobj Experiment. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.md index 80ec0d1289c..4165f68b66a 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.md index 052bb4cfc8d..7290308a586 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.md index 342dc1b709f..d48dbd8d6e3 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A configuration for a QASM Qobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.md index 297965a8b59..553f6b6c3ce 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj Experiment. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.md index a74860268c0..e089a77c448 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") Configuration for a single QASM experiment in the qobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.md index 72c03b88672..ac64386d7ed 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A class representing a single instruction in an QasmQobj Experiment. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.25/qiskit.qobj.Qobj.md index ea560eb0bb9..b39646c58d9 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/__init__.py "view source code") A backwards compat alias for QasmQobj. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.md index 1169160923b..f4fb4e7db1c 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") A class representing a header dictionary for a Qobj Experiment. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.md index 923edaf5803..99480072acf 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") A class used to represent a dictionary header in Qobj objects. diff --git a/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.md index 47546c0bc50..caf01b74ce2 100644 --- a/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.25/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") An individual measurement option. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.md index 21ee5413aa0..7a09e6144e2 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.md index 3cfbe75f58e..73a64eb2745 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/chi.py "view source code") Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.md index ace84d19b8f..7491103a135 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/choi.py "view source code") Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.md index 50a0f218b26..762bb0793a2 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") An N-qubit unitary operator from the Clifford group. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.md index dbfa795c218..0356f840ec8 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/densitymatrix.py "view source code") DensityMatrix class diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.md index 37e0ffcc6b8..67d26ec0284 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/kraus.py "view source code") Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.md index 8b94c23432e..05260b2d294 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.md index f3da2c57373..70fabbff5c6 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/operator.py "view source code") Matrix operator class diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.md index f2a553262a6..18dc0fea2a0 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/ptm.py "view source code") Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.md index 83c2e430dd0..3964c9d3d2f 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") N-qubit Pauli operator. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.md index 6b5156e11fe..3c59cb1cd8e 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Symplectic representation of a list Pauli matrices. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.md index 9d2734306fd..0f5f3c4e182 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/quaternion.py "view source code") A class representing a Quaternion. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.md index 6baec9a8335..44a3fc8cd1f 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/scalar_op.py "view source code") Scalar identity operator class. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.md index 78e6e5b8fcc..ad2b9bd9b6b 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sparse N-qubit operator in a Pauli basis representation. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.md index 6fa564b9044..2baf6105773 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Symplectic representation of a list Stabilizer matrices. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.md index 7f28b42d06f..0225c1ce651 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/statevector.py "view source code") Statevector class diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.md index 2472ecd971c..68c7f943c83 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.md index 6a0e4908b36..c3166c4c81e 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/superop.py "view source code") Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.md index fb4377a4923..4c4295fe82c 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.25/qiskit.quantum_info.average_gate_fidelity.md index 6d802aa7e1d..56e7e824816 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.25/qiskit.quantum_info.concurrence.md index 0765a817535..b426d9b3af1 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.25/qiskit.quantum_info.decompose_clifford.md index c8804c3188a..0bf0adb7d41 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.25/qiskit.quantum_info.diamond_norm.md index 183c70efb46..4b84c406c65 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.25/qiskit.quantum_info.entanglement_of_formation.md index 5d163f29f8a..451f890c196 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.25/qiskit.quantum_info.entropy.md index 7b0d105badb..938ad61e35c 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.25/qiskit.quantum_info.gate_error.md index 99d1a977ccc..e3c8fe2af31 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_distance.md index a337c6e0b7b..3fb0288ea24 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_fidelity.md index 0f6e442e588..95e4cb20422 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.25/qiskit.quantum_info.mutual_information.md index 1caa0026154..72278bad311 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.25/qiskit.quantum_info.partial_trace.md index 1de7483f21b..8e3f1cf72dc 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_basis.md index 4aec52700e1..4794a2f838f 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_group.md index 34f566a176a..662a1d1bf90 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.25/qiskit.quantum_info.process_fidelity.md index 6be1eea06f7..ed367d74b3a 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.25/qiskit.quantum_info.purity.md index b67ea5ceaaf..d2407bd278e 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_clifford.md index 183e81f082c..c72131715a0 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_cnotdihedral.md index 0800959cdfb..8efd92543e1 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_density_matrix.md index c0bb5d0fe00..e684fa5f943 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_hermitian.md index 85f3e768c34..6d129ca5e65 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli.md index 3f22c443a65..194e2c8b8a5 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli_table.md index d5749747b63..2f0e987fcab 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_quantum_channel.md index 6638cdb0369..8807c0758cc 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_stabilizer_table.md index 314ab85ee58..a1a255afefa 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_statevector.md index 594a72133b6..c32e5e40c69 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.25/qiskit.quantum_info.random_unitary.md index a12d83dd53b..cdd50970c44 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.25/qiskit.quantum_info.shannon_entropy.md index d56cdea5872..0e2496c4305 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.25/qiskit.quantum_info.state_fidelity.md index 2075c83b415..92873e95470 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.25/qiskit.result.Counts.md b/docs/api/qiskit/0.25/qiskit.result.Counts.md index e914d0778f8..f8bf252ec42 100644 --- a/docs/api/qiskit/0.25/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.25/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/counts.py "view source code") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.25/qiskit.result.Result.md b/docs/api/qiskit/0.25/qiskit.result.Result.md index a628eba78cd..ae800b31d55 100644 --- a/docs/api/qiskit/0.25/qiskit.result.Result.md +++ b/docs/api/qiskit/0.25/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/result.py "view source code") Model for Results. diff --git a/docs/api/qiskit/0.25/qiskit.result.ResultError.md b/docs/api/qiskit/0.25/qiskit.result.ResultError.md index 2fcba4e322e..70502831c76 100644 --- a/docs/api/qiskit/0.25/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.25/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.25/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.25/qiskit.result.marginal_counts.md index 37c3ed5dd6d..953bed88628 100644 --- a/docs/api/qiskit/0.25/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.25/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.md index 96d2e2cb083..932b7c25a7e 100644 --- a/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.25/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md index 27cd8d0ce83..b370a2d7fbf 100644 --- a/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md @@ -23,7 +23,7 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat -`as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") +`as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. @@ -48,7 +48,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as late as -`as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") +`as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. diff --git a/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md index 1b7bc625d39..b811d97cb7c 100644 --- a/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md @@ -22,7 +22,7 @@ QuantumCircuit to Pulse scheduler. -`schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/schedule_circuit.py "view source code") +`schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. diff --git a/docs/api/qiskit/0.25/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.25/qiskit.tools.backend_monitor.md index d8413988e30..e153df4e07c 100644 --- a/docs/api/qiskit/0.25/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.25/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.25/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.25/qiskit.tools.backend_overview.md index e8c072870e2..5d4e4bf27aa 100644 --- a/docs/api/qiskit/0.25/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.25/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.25/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.25/qiskit.tools.job_monitor.md index 53be7b012a3..ec20a90e14b 100644 --- a/docs/api/qiskit/0.25/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.25/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.25/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.25/qiskit.tools.parallel_map.md index 8362d37af51..de590d737ce 100644 --- a/docs/api/qiskit/0.25/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.25/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.md index 5ba9f81b695..05f8ef60db6 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") An analysis pass: change property set, not DAG. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.md index dcd406965db..380659e6ca3 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/coupling.py "view source code") Directed graph specifying fixed coupling. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.md index e0db537efff..00c4c506e69 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.md index 420c65e728b..8b1c6bbbb87 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.md index 97ba461b0cc..87315fa24f0 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/runningpassmanager.py "view source code") Base class for multiple types of working list. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.md index 7b1de2f94d1..fc12c6d4463 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/instruction_durations.py "view source code") Helper class to provide durations of instructions for scheduling. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.25/qiskit.transpiler.Layout.md index 849af2cfa5b..a6a7062cfea 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/layout.py "view source code") Two-ways dict to represent a Layout. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.md index 086f6fa3ee3..b8825c5f152 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager.py "view source code") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.md index b54a78bd521..1439f488321 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager_config.py "view source code") Pass Manager Configuration. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.md index 748e5bc3f42..d4b58c29788 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/propertyset.py "view source code") A default dictionary-like object diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.md index e7cd7afeacc..76b475b5aed 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") A transformation pass: change DAG, not property set. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.md index 5fe8c1c6b20..6d321be3562 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.md index f6851bc33f9..98ed4cf78f8 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.md index 57c2ca55996..863c90d0d02 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/alap.py "view source code") ALAP Scheduling. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.md index 8adfcf17a68..2673143baf5 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/asap.py "view source code") ASAP Scheduling. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.md index 66453a91d79..0164a2c6389 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 2589a9b19ff..242ea824c24 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.md index eab63ae6252..7a107f1916b 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.md index 97a705f523e..aba0e636db1 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.md index aae7f08e35f..d896b32f826 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py "view source code") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.md index 88bf08911a1..513e93c2cc1 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.md index 1f31a15142e..a3691654e3a 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.md index d7e48675c31..987b6162d2d 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.md index 259a53186b0..4815eb08c0d 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.md index 2aa05b12680..c4c3e29b36c 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_map.py "view source code") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.md index 4366ab0460f..1f92d4d239d 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.md index 21036dccbf0..69dd13326a7 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.md index 87309fe9123..affe7e85d1f 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.md index d66525efafa..babd5857bbd 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.md index fd077e9b630..9e4f3d33ce0 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.md index d908982a246..cdde9254b01 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 565d067b9e3..920f77263db 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.md index a08754653c1..e8651bfb5d8 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.md index 64e90906592..505acb020ee 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.md index 2ae375b2461..32e27f7a467 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/decompose.py "view source code") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.md index 3cb1aba1946..75b09f55813 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.md index 5b716a41e99..6f7705b43d5 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/depth.py "view source code") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.md index 087cd389943..356a0b70e61 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.md index c73c3af2ab6..5445accb222 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.md index 91cb7ff4408..4605c389f53 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Allocate all idle nodes from the coupling map as ancilla on the layout. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.md index 65b936f52a4..295d98c78b9 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.md index bf9afe6a941..d8da88518cd 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.md index 245f35f2f60..462bab7d5ab 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 17add1c0022..34dfe1667e2 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index a7779eda46b..c5e6cc8b8da 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.md index 495ddf5b8a9..a1d055f3d1e 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.md index a057a25a2b0..6882e338c56 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index de374af8d9a..9efb0f64c49 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.md index cb32e7ff424..c24cbe73038 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 67aba62b64b..87e0b4a5da1 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.md index e5e1b76caa6..9603449047c 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.md index b89d8b46fbe..e838547475c 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.md index 0f2e08b8fef..252299e05ee 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.md index 18c9a91e65a..c05329fb42a 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.md index 00d8827a66a..7d4a23d7fe8 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/set_layout.py "view source code") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.md index 4b368cc7029..5e26cc4e89b 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/size.py "view source code") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.md index b7c38858bc0..f747a700531 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.md index b7cda6673ba..45d9f76c88e 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.md index c52dfd598b4..8c2df4eefe3 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.md index 4b0e2a3342f..7a35a7886a2 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.md index e186403129e..fd98b3af5ea 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.md index bf95016280b..577b967e57e 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.md index 9daf803930e..6b9b00b0f15 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroller.py "view source code") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.md index c359f02ff34..a9d5d40c28c 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/width.py "view source code") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index f1c559abbb1..4704fd2a77d 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 7c6a854c908..f316da9448f 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 73e3c35178e..d474d9db6a3 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index c4f7ea3a027..d0d211473c7 100644 --- a/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.25/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.md index 8bda33ba7ad..1eaf1e27566 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.25/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.25/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.25/qiskit.utils.apply_prefix.md index e1a21283e3c..a2e0412392a 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.25/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.25/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.25/qiskit.utils.deprecate_arguments.md index beef229b5e7..946438f30b3 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.25/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.25/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.25/qiskit.utils.deprecate_function.md index 3d4cd31040b..25307ea72d3 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.25/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.25/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.25/qiskit.utils.get_entangler_map.md index 5955ba2b9db..79f19231eac 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.25/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.25/qiskit.utils.has_aer.md b/docs/api/qiskit/0.25/qiskit.utils.has_aer.md index cc0af41aebd..ef60c5839f9 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.25/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.25/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.25/qiskit.utils.has_ibmq.md index 79af8d8f31a..a1c46b7b40b 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.25/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.25/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.25/qiskit.utils.is_main_process.md index 7f1b0a64d19..b25c5a29882 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.25/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.25/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.25/qiskit.utils.local_hardware_info.md index b07303b2156..d6c47db28aa 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.25/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.25/qiskit.utils.name_args.md b/docs/api/qiskit/0.25/qiskit.utils.name_args.md index a3c5cb59400..6fbf128f4a8 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.25/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.25/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.25/qiskit.utils.summarize_circuits.md index 8cd4d5b973f..03b31d82a19 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.25/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.25/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.25/qiskit.utils.validate_entangler_map.md index de6cf9bce13..a4bd4f0a6e0 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.25/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.md index ef32933e75b..dfbedd852a0 100644 --- a/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.25/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.25/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.25/qiskit.validation.jsonschema.validate_json_against_schema.md index 9433c912dd0..9aad9cfb8d7 100644 --- a/docs/api/qiskit/0.25/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.25/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.md index 78e1a473a49..f3611d669bf 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.25/qiskit.visualization.array_to_latex.md index 5550e0ceec0..ded76053b0b 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.25/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.25/qiskit.visualization.circuit_drawer.md index 55f458b718e..85db34f2c55 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.25/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.25/qiskit.visualization.dag_drawer.md index deace79512f..f83bcdbc4dc 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.25/qiskit.visualization.pass_manager_drawer.md index c8695d1bd56..4174720f188 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_multivector.md index 7ca5a17b6d4..66077d3c683 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_vector.md index 437a96f2b9d..0d45717c156 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_circuit_layout.md index 75bef7c2bd0..1014208593b 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_error_map.md index a28dd8e4e0d..0e93316f6aa 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_gate_map.md index 9c2ee206066..a5bafc0f06b 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_histogram.md index 7bf8054a8e1..57fb09b4c34 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_city.md index 378d7d1bfcf..9f3aafa4392 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_hinton.md index 60379fcf6dd..005cb139838 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_paulivec.md index 545b0243cd1..1b214210f7e 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_qsphere.md index b5b3a4946a6..863a155adda 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.md index bd30d0b8511..fcf7d067917 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.md index 366c64f3f18..c5d1f49e6d8 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.md index 57ab433773b..5e11e2c50f1 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md index 540c247eafb..e727cb6a9d9 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.md index 92419a554ef..b6c1487a8e2 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/qcstyle.py "view source code") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.25/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.25/qiskit.visualization.timeline.draw.md index cf8e99c2a73..efbc67cf29a 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.25/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.25/qiskit.visualization.visualize_transition.md index cfaf5429544..a1f06a92596 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 52017fe8b743b81645aa1d29848aea5f317a8dc0 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:14:10 +0100 Subject: [PATCH 07/41] Regenerate qiskit 0.26.2 --- docs/api/qiskit/0.26/execute.md | 2 +- docs/api/qiskit/0.26/logging.md | 2 +- .../0.26/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.26/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.26/qiskit.algorithms.Grover.md | 2 +- .../0.26/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.26/qiskit.algorithms.HHL.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- .../0.26/qiskit.algorithms.LinearSolver.md | 2 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.algorithms.NumPyLinearSolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.26/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.26/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.26/qiskit.algorithms.Shor.md | 2 +- .../0.26/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.26/qiskit.algorithms.VQE.md | 2 +- .../0.26/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.26/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.26/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.26/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.26/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.26/qiskit.algorithms.optimizers.GSLS.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.26/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.26/qiskit.algorithms.optimizers.SPSA.md | 2 +- .../0.26/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.26/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.26/qiskit.aqua.QuantumInstance.md | 2 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 2 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 2 +- ...ua.algorithms.AmplitudeEstimationResult.md | 2 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 2 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 2 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 2 +- .../qiskit/0.26/qiskit.aqua.algorithms.EOH.md | 2 +- .../qiskit.aqua.algorithms.Eigensolver.md | 2 +- ...iskit.aqua.algorithms.EigensolverResult.md | 2 +- .../0.26/qiskit.aqua.algorithms.Grover.md | 2 +- .../qiskit.aqua.algorithms.GroverResult.md | 2 +- .../qiskit/0.26/qiskit.aqua.algorithms.HHL.md | 2 +- .../0.26/qiskit.aqua.algorithms.HHLResult.md | 2 +- .../0.26/qiskit.aqua.algorithms.IQPE.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.LinearsolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 2 +- ...qua.algorithms.MinimumEigensolverResult.md | 2 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 2 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.26/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.26/qiskit.aqua.algorithms.QGAN.md | 2 +- .../qiskit/0.26/qiskit.aqua.algorithms.QPE.md | 2 +- .../0.26/qiskit.aqua.algorithms.QSVM.md | 2 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 2 +- .../0.26/qiskit.aqua.algorithms.Shor.md | 2 +- .../0.26/qiskit.aqua.algorithms.Simon.md | 2 +- .../0.26/qiskit.aqua.algorithms.SklearnSVM.md | 2 +- .../qiskit/0.26/qiskit.aqua.algorithms.VQC.md | 2 +- .../qiskit/0.26/qiskit.aqua.algorithms.VQE.md | 2 +- .../qiskit/0.26/qiskit.aqua.circuits.CNF.md | 2 +- .../qiskit/0.26/qiskit.aqua.circuits.DNF.md | 2 +- .../qiskit/0.26/qiskit.aqua.circuits.ESOP.md | 2 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 2 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 2 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 2 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 2 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 2 +- ...aqua.components.feature_maps.FeatureMap.md | 2 +- ...omponents.feature_maps.RawFeatureVector.md | 2 +- ...t.aqua.components.initial_states.Custom.md | 2 +- ....components.initial_states.InitialState.md | 2 +- ....components.initial_states.VarFormBased.md | 2 +- ...kit.aqua.components.initial_states.Zero.md | 2 +- ...mponents.multiclass_extensions.AllPairs.md | 2 +- ...lticlass_extensions.ErrorCorrectingCode.md | 2 +- ...lticlass_extensions.MulticlassExtension.md | 2 +- ...ts.multiclass_extensions.OneAgainstRest.md | 2 +- ...s.neural_networks.DiscriminativeNetwork.md | 2 +- ...nents.neural_networks.GenerativeNetwork.md | 2 +- ...ents.neural_networks.NumPyDiscriminator.md | 2 +- ...ts.neural_networks.PyTorchDiscriminator.md | 2 +- ...onents.neural_networks.QuantumGenerator.md | 2 +- .../qiskit.aqua.components.optimizers.ADAM.md | 2 +- .../qiskit.aqua.components.optimizers.AQGD.md | 2 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 2 +- .../qiskit.aqua.components.optimizers.CG.md | 2 +- ...iskit.aqua.components.optimizers.COBYLA.md | 2 +- .../qiskit.aqua.components.optimizers.CRS.md | 2 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 2 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 2 +- .../qiskit.aqua.components.optimizers.ESCH.md | 2 +- .../qiskit.aqua.components.optimizers.GSLS.md | 2 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 2 +- ...qiskit.aqua.components.optimizers.ISRES.md | 2 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 2 +- ....aqua.components.optimizers.NELDER_MEAD.md | 2 +- .../qiskit.aqua.components.optimizers.NFT.md | 2 +- ...it.aqua.components.optimizers.Optimizer.md | 2 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 2 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 2 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 2 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 2 +- .../qiskit.aqua.components.optimizers.SPSA.md | 2 +- .../qiskit.aqua.components.optimizers.TNC.md | 2 +- ....components.oracles.CustomCircuitOracle.md | 2 +- ...ponents.oracles.LogicalExpressionOracle.md | 2 +- .../qiskit.aqua.components.oracles.Oracle.md | 2 +- ...qua.components.oracles.TruthTableOracle.md | 2 +- ...qua.components.reciprocals.LongDivision.md | 2 +- ...a.components.reciprocals.LookupRotation.md | 2 +- ....aqua.components.reciprocals.Reciprocal.md | 2 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 2 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 2 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 2 +- ...els.MultivariateVariationalDistribution.md | 2 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 2 +- ....uncertainty_models.UniformDistribution.md | 2 +- ...certainty_models.UnivariateDistribution.md | 2 +- ...odels.UnivariateVariationalDistribution.md | 2 +- ...ncertainty_problems.MultivariateProblem.md | 2 +- ...uncertainty_problems.UncertaintyProblem.md | 2 +- ...lems.UnivariatePiecewiseLinearObjective.md | 2 +- ....uncertainty_problems.UnivariateProblem.md | 2 +- ...nents.variational_forms.VariationalForm.md | 2 +- .../qiskit.aqua.operators.OperatorBase.md | 2 +- ...qua.operators.converters.AbelianGrouper.md | 2 +- ...qua.operators.converters.CircuitSampler.md | 2 +- ...aqua.operators.converters.ConverterBase.md | 2 +- ...a.operators.converters.DictToCircuitSum.md | 2 +- ...a.operators.converters.PauliBasisChange.md | 2 +- ...aqua.operators.evolutions.EvolutionBase.md | 2 +- ...a.operators.evolutions.EvolutionFactory.md | 2 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 2 +- ...ua.operators.evolutions.MatrixEvolution.md | 2 +- ...rators.evolutions.PauliTrotterEvolution.md | 2 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 2 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 2 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 2 +- ...rators.evolutions.TrotterizationFactory.md | 2 +- ...rators.expectations.AerPauliExpectation.md | 2 +- ....operators.expectations.CVaRExpectation.md | 2 +- ....operators.expectations.ExpectationBase.md | 2 +- ...erators.expectations.ExpectationFactory.md | 2 +- ...perators.expectations.MatrixExpectation.md | 2 +- ...operators.expectations.PauliExpectation.md | 2 +- ...qua.operators.gradients.CircuitGradient.md | 2 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 2 +- ...aqua.operators.gradients.DerivativeBase.md | 2 +- ...iskit.aqua.operators.gradients.Gradient.md | 2 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 2 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 2 +- .../qiskit.aqua.operators.gradients.QFI.md | 2 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 2 +- ...it.aqua.operators.legacy.MatrixOperator.md | 2 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 2 +- ....operators.legacy.WeightedPauliOperator.md | 2 +- ...skit.aqua.operators.legacy.Z2Symmetries.md | 2 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 2 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 2 +- ...qiskit.aqua.operators.list_ops.SummedOp.md | 2 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 2 +- ....aqua.operators.primitive_ops.CircuitOp.md | 2 +- ...t.aqua.operators.primitive_ops.MatrixOp.md | 2 +- ...it.aqua.operators.primitive_ops.PauliOp.md | 2 +- ...qua.operators.primitive_ops.PrimitiveOp.md | 2 +- ...qua.operators.state_fns.CVaRMeasurement.md | 2 +- ...aqua.operators.state_fns.CircuitStateFn.md | 2 +- ...it.aqua.operators.state_fns.DictStateFn.md | 2 +- ...qua.operators.state_fns.OperatorStateFn.md | 2 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 2 +- ....aqua.operators.state_fns.VectorStateFn.md | 2 +- .../0.26/qiskit.aqua.utils.CircuitFactory.md | 2 +- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.26/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.26/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.26/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.26/qiskit.aqua.utils.name_args.md | 2 +- .../0.26/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.26/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.26/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.26/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.26/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.26/qiskit.assembler.RunConfig.md | 2 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.26/qiskit.assembler.disassemble.md | 2 +- .../0.26/qiskit.chemistry.BosonicOperator.md | 2 +- .../qiskit.chemistry.FermionicOperator.md | 2 +- .../qiskit/0.26/qiskit.chemistry.MP2Info.md | 2 +- .../qiskit/0.26/qiskit.chemistry.QMolecule.md | 2 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 2 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 2 +- ...chemistry.algorithms.EigensolverFactory.md | 2 +- ...try.algorithms.ExcitedStatesEigensolver.md | 2 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 2 +- ...istry.algorithms.GroundStateEigensolver.md | 2 +- ....chemistry.algorithms.GroundStateSolver.md | 2 +- ...ry.algorithms.MinimumEigensolverFactory.md | 2 +- ...stry.algorithms.NumPyEigensolverFactory.md | 2 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 2 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 2 +- .../0.26/qiskit.chemistry.algorithms.QEOM.md | 2 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 2 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 2 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 2 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 2 +- ...s.pes_samplers.DifferentialExtrapolator.md | 2 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 2 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 2 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 2 +- ...gorithms.pes_samplers.HarmonicPotential.md | 2 +- ....algorithms.pes_samplers.MorsePotential.md | 2 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 2 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 2 +- ...y.algorithms.pes_samplers.PotentialBase.md | 2 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 2 +- ...thms.pes_samplers.VibronicStructureBase.md | 2 +- ...orithms.pes_samplers.WindowExtrapolator.md | 2 +- ...applications.MolecularGroundStateEnergy.md | 2 +- ...y.components.bosonic_bases.BosonicBasis.md | 2 +- ....components.bosonic_bases.HarmonicBasis.md | 2 +- ...y.components.initial_states.HartreeFock.md | 2 +- ...hemistry.components.initial_states.VSCF.md | 2 +- ...mistry.components.variational_forms.CHC.md | 2 +- ...stry.components.variational_forms.UCCSD.md | 2 +- ...istry.components.variational_forms.UVCC.md | 2 +- ...qiskit.chemistry.core.ChemistryOperator.md | 2 +- .../0.26/qiskit.chemistry.core.Hamiltonian.md | 2 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 2 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 2 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 2 +- ...iskit.chemistry.drivers.FermionicDriver.md | 2 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 2 +- ....chemistry.drivers.GaussianForcesDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogResult.md | 2 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 2 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.26/qiskit.chemistry.drivers.Molecule.md | 2 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 2 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 2 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 2 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 2 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 2 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 2 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 2 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 2 +- .../0.26/qiskit.circuit.AncillaQubit.md | 2 +- .../0.26/qiskit.circuit.AncillaRegister.md | 2 +- .../0.26/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.26/qiskit.circuit.Clbit.md | 2 +- .../0.26/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.26/qiskit.circuit.Delay.md | 2 +- .../0.26/qiskit.circuit.EquivalenceLibrary.md | 2 +- docs/api/qiskit/0.26/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.26/qiskit.circuit.Instruction.md | 2 +- .../0.26/qiskit.circuit.InstructionSet.md | 2 +- .../api/qiskit/0.26/qiskit.circuit.Measure.md | 2 +- .../qiskit/0.26/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.26/qiskit.circuit.ParameterVector.md | 2 +- .../0.26/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.26/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.26/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.26/qiskit.circuit.Reset.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.AND.md | 2 +- .../0.26/qiskit.circuit.library.Barrier.md | 2 +- .../0.26/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.26/qiskit.circuit.library.C3XGate.md | 2 +- .../0.26/qiskit.circuit.library.C4XGate.md | 2 +- .../0.26/qiskit.circuit.library.CCXGate.md | 2 +- .../0.26/qiskit.circuit.library.CHGate.md | 2 +- .../0.26/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.26/qiskit.circuit.library.CRXGate.md | 2 +- .../0.26/qiskit.circuit.library.CRYGate.md | 2 +- .../0.26/qiskit.circuit.library.CRZGate.md | 2 +- .../0.26/qiskit.circuit.library.CSXGate.md | 2 +- .../0.26/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.26/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.26/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.26/qiskit.circuit.library.CUGate.md | 2 +- .../0.26/qiskit.circuit.library.CXGate.md | 2 +- .../0.26/qiskit.circuit.library.CYGate.md | 2 +- .../0.26/qiskit.circuit.library.CZGate.md | 2 +- .../0.26/qiskit.circuit.library.DCXGate.md | 2 +- .../0.26/qiskit.circuit.library.Diagonal.md | 2 +- .../0.26/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.GRZ.md | 2 +- .../0.26/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.26/qiskit.circuit.library.HGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.26/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.26/qiskit.circuit.library.MCMT.md | 2 +- .../0.26/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.26/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.26/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.26/qiskit.circuit.library.MSGate.md | 2 +- .../0.26/qiskit.circuit.library.Measure.md | 2 +- .../0.26/qiskit.circuit.library.NLocal.md | 2 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.26/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.26/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.26/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.26/qiskit.circuit.library.RCCXGate.md | 2 +- .../0.26/qiskit.circuit.library.RGate.md | 2 +- .../0.26/qiskit.circuit.library.RVGate.md | 2 +- .../0.26/qiskit.circuit.library.RXGate.md | 2 +- .../0.26/qiskit.circuit.library.RXXGate.md | 2 +- .../0.26/qiskit.circuit.library.RYGate.md | 2 +- .../0.26/qiskit.circuit.library.RYYGate.md | 2 +- .../0.26/qiskit.circuit.library.RZGate.md | 2 +- .../0.26/qiskit.circuit.library.RZXGate.md | 2 +- .../0.26/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.26/qiskit.circuit.library.Reset.md | 2 +- .../0.26/qiskit.circuit.library.SGate.md | 2 +- .../0.26/qiskit.circuit.library.SXGate.md | 2 +- .../0.26/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.26/qiskit.circuit.library.SdgGate.md | 2 +- .../0.26/qiskit.circuit.library.SwapGate.md | 2 +- .../0.26/qiskit.circuit.library.TGate.md | 2 +- .../0.26/qiskit.circuit.library.TdgGate.md | 2 +- .../0.26/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.26/qiskit.circuit.library.U1Gate.md | 2 +- .../0.26/qiskit.circuit.library.U2Gate.md | 2 +- .../0.26/qiskit.circuit.library.U3Gate.md | 2 +- .../0.26/qiskit.circuit.library.UGate.md | 2 +- ...kit.circuit.library.UniformDistribution.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.26/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.26/qiskit.circuit.library.XOR.md | 2 +- .../0.26/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.26/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.26/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.26/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.26/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.26/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.26/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.26/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.26/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.26/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.26/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.26/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.26/qiskit.compiler.transpile.md | 2 +- .../0.26/qiskit.converters.ast_to_dag.md | 2 +- .../0.26/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.26/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.26/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.26/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.26/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.26/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.26/qiskit.dagcircuit.DAGDependency.md | 2 +- .../qiskit/0.26/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.26/qiskit.extensions.HamiltonianGate.md | 2 +- .../0.26/qiskit.extensions.Initialize.md | 2 +- .../qiskit/0.26/qiskit.extensions.Snapshot.md | 2 +- .../0.26/qiskit.extensions.UnitaryGate.md | 2 +- .../0.26/qiskit.finance.QiskitFinanceError.md | 2 +- ...it.finance.applications.ising.portfolio.md | 10 +++---- ...cations.ising.portfolio_diversification.md | 6 ++--- ....uncertainty_problems.EuropeanCallDelta.md | 2 +- ...inty_problems.EuropeanCallExpectedValue.md | 2 +- ...ainty_problems.FixedIncomeExpectedValue.md | 2 +- ...finance.data_providers.BaseDataProvider.md | 2 +- ...nce.data_providers.DataOnDemandProvider.md | 2 +- ...nce.data_providers.ExchangeDataProvider.md | 2 +- ...nance.data_providers.RandomDataProvider.md | 2 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 2 +- ...inance.data_providers.YahooDataProvider.md | 2 +- ...t.ignis.characterization.AmpCalCXFitter.md | 2 +- ...kit.ignis.characterization.AmpCalFitter.md | 2 +- ...ignis.characterization.AngleCalCXFitter.md | 2 +- ...t.ignis.characterization.AngleCalFitter.md | 2 +- ...is.characterization.BaseCoherenceFitter.md | 2 +- ...t.ignis.characterization.BaseGateFitter.md | 2 +- ...iskit.ignis.characterization.DragFitter.md | 2 +- ...iskit.ignis.characterization.RabiFitter.md | 2 +- .../qiskit.ignis.characterization.T1Fitter.md | 2 +- .../qiskit.ignis.characterization.T2Fitter.md | 2 +- ...kit.ignis.characterization.T2StarFitter.md | 2 +- .../qiskit.ignis.characterization.ZZFitter.md | 2 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 2 +- .../0.26/qiskit.ignis.logging.IgnisLogger.md | 2 +- .../0.26/qiskit.ignis.logging.IgnisLogging.md | 2 +- ....ignis.measurement.DiscriminationFilter.md | 2 +- ...gnis.measurement.IQDiscriminationFitter.md | 2 +- ...ignis.measurement.LinearIQDiscriminator.md | 2 +- ...is.measurement.QuadraticIQDiscriminator.md | 2 +- ...gnis.measurement.SklearnIQDiscriminator.md | 2 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 2 +- ....mitigation.CompleteExpvalMeasMitigator.md | 2 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 2 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 2 +- ...skit.ignis.mitigation.MeasurementFilter.md | 2 +- ....mitigation.TensoredExpvalMeasMitigator.md | 2 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 2 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 2 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 2 +- ....ignis.verification.AccreditationFitter.md | 2 +- .../0.26/qiskit.ignis.verification.BConfig.md | 2 +- .../qiskit.ignis.verification.CNOTDihedral.md | 2 +- ...ignis.verification.CNOTDihedralRBFitter.md | 2 +- ...is.verification.GatesetTomographyFitter.md | 2 +- .../qiskit.ignis.verification.GraphDecoder.md | 2 +- ....ignis.verification.InterleavedRBFitter.md | 2 +- .../0.26/qiskit.ignis.verification.Plotter.md | 2 +- ...is.verification.ProcessTomographyFitter.md | 2 +- ...iskit.ignis.verification.PurityRBFitter.md | 2 +- .../0.26/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 2 +- .../qiskit.ignis.verification.RBFitter.md | 2 +- ...iskit.ignis.verification.RepetitionCode.md | 2 +- ...gnis.verification.StateTomographyFitter.md | 2 +- ...kit.ignis.verification.TomographyFitter.md | 2 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 2 +- .../0.26/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.26/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.26/qiskit.ml.datasets.digits.md | 2 +- .../0.26/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.26/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.26/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.26/qiskit.opflow.OperatorBase.md | 2 +- .../qiskit/0.26/qiskit.opflow.OpflowError.md | 2 +- .../0.26/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.26/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../0.26/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.26/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.26/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.26/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.26/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.26/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.26/qiskit.opflow.gradients.QFI.md | 2 +- .../0.26/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.26/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.26/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.26/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.26/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.26/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 2 +- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 2 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 2 +- ....optimization.algorithms.CplexOptimizer.md | 2 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 2 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 2 +- ...zation.algorithms.MinimumEigenOptimizer.md | 2 +- ...mization.algorithms.MultiStartOptimizer.md | 2 +- ...zation.algorithms.OptimizationAlgorithm.md | 2 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 2 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 2 +- ....optimization.algorithms.SolutionSample.md | 2 +- ....optimization.applications.ising.clique.md | 6 ++--- ....optimization.applications.ising.common.md | 12 ++++----- ...optimization.applications.ising.docplex.md | 2 +- ...mization.applications.ising.exact_cover.md | 6 ++--- ...tion.applications.ising.graph_partition.md | 6 ++--- ...ptimization.applications.ising.knapsack.md | 6 ++--- ...optimization.applications.ising.max_cut.md | 6 ++--- ...timization.applications.ising.partition.md | 4 +-- ...mization.applications.ising.set_packing.md | 6 ++--- ...imization.applications.ising.stable_set.md | 6 ++--- ...kit.optimization.applications.ising.tsp.md | 14 +++++----- ...tion.applications.ising.vehicle_routing.md | 8 +++--- ...ization.applications.ising.vertex_cover.md | 6 ++--- ...ization.converters.InequalityToEquality.md | 2 +- ...optimization.converters.IntegerToBinary.md | 2 +- ...tion.converters.LinearEqualityToPenalty.md | 2 +- ...on.converters.QuadraticProgramConverter.md | 2 +- ...ation.converters.QuadraticProgramToQubo.md | 2 +- ...qiskit.optimization.problems.Constraint.md | 2 +- ....optimization.problems.LinearConstraint.md | 2 +- ....optimization.problems.LinearExpression.md | 2 +- ...timization.problems.QuadraticConstraint.md | 2 +- ...timization.problems.QuadraticExpression.md | 2 +- ...ptimization.problems.QuadraticObjective.md | 2 +- ....optimization.problems.QuadraticProgram.md | 2 +- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 2 +- .../qiskit/0.26/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.26/qiskit.providers.BackendV1.md | 2 +- .../0.26/qiskit.providers.BaseBackend.md | 2 +- .../qiskit/0.26/qiskit.providers.BaseJob.md | 2 +- .../0.26/qiskit.providers.BaseProvider.md | 2 +- docs/api/qiskit/0.26/qiskit.providers.Job.md | 2 +- .../qiskit/0.26/qiskit.providers.JobError.md | 2 +- .../qiskit/0.26/qiskit.providers.JobStatus.md | 2 +- .../0.26/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.26/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.26/qiskit.providers.Options.md | 2 +- .../qiskit/0.26/qiskit.providers.Provider.md | 2 +- .../0.26/qiskit.providers.ProviderV1.md | 2 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.26/qiskit.providers.aer.AerError.md | 2 +- .../0.26/qiskit.providers.aer.AerJob.md | 2 +- .../0.26/qiskit.providers.aer.AerProvider.md | 2 +- .../0.26/qiskit.providers.aer.AerSimulator.md | 2 +- .../qiskit.providers.aer.PulseSimulator.md | 2 +- .../qiskit.providers.aer.QasmSimulator.md | 2 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 2 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 2 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 2 +- ...qiskit.providers.aer.noise.QuantumError.md | 2 +- ...qiskit.providers.aer.noise.ReadoutError.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 2 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 2 +- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 2 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.26/qiskit.providers.ibmq.IBMQBackend.md | 2 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 2 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.26/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.26/qiskit.providers.ibmq.IBMQFactory.md | 2 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 2 +- ....providers.ibmq.credentials.Credentials.md | 2 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...roviders.ibmq.experiment.AnalysisResult.md | 2 +- ...it.providers.ibmq.experiment.Experiment.md | 2 +- ...iders.ibmq.experiment.ExperimentService.md | 2 +- .../0.26/qiskit.providers.ibmq.job.IBMQJob.md | 2 +- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 2 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.26/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 2 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 2 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 2 +- ...t.providers.ibmq.managed.ManagedResults.md | 2 +- ...skit.providers.ibmq.random.CQCExtractor.md | 2 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 2 +- ...providers.ibmq.random.IBMQRandomService.md | 2 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 2 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 2 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 2 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 2 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 2 +- ...it.providers.ibmq.runtime.UserMessenger.md | 2 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.26/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../0.26/qiskit.providers.models.JobStatus.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Acquire.md | 2 +- .../0.26/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Call.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Constant.md | 2 +- .../0.26/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Delay.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Drag.md | 2 +- .../qiskit/0.26/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Gaussian.md | 2 +- .../0.26/qiskit.pulse.GaussianSquare.md | 2 +- .../qiskit/0.26/qiskit.pulse.Instruction.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- .../0.26/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.26/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Play.md | 2 +- .../qiskit/0.26/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.26/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.26/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit/0.26/qiskit.pulse.SetFrequency.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md | 2 +- .../0.26/qiskit.pulse.ShiftFrequency.md | 2 +- .../qiskit/0.26/qiskit.pulse.ShiftPhase.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.Waveform.md | 2 +- .../0.26/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.26/qiskit.pulse.builder.align_func.md | 2 +- .../0.26/qiskit.pulse.builder.align_left.md | 2 +- .../0.26/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.26/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.delay.md | 2 +- .../0.26/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.26/qiskit.pulse.builder.inline.md | 2 +- .../0.26/qiskit.pulse.builder.measure.md | 2 +- .../0.26/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.26/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.pad.md | 2 +- .../0.26/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.26/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.26/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.26/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.26/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.26/qiskit.pulse.builder.x.md | 2 +- docs/api/qiskit/0.26/qiskit.pulse.channels.md | 18 ++++++------- .../0.26/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.26/qiskit.pulse.instructions.Call.md | 2 +- .../0.26/qiskit.pulse.instructions.Delay.md | 2 +- .../qiskit.pulse.instructions.Instruction.md | 2 +- .../0.26/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../0.26/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.26/qiskit.pulse.library.Drag.md | 2 +- .../0.26/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../0.26/qiskit.pulse.library.Waveform.md | 2 +- .../0.26/qiskit.pulse.library.discrete.md | 26 +++++++++---------- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.26/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.26/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.26/qiskit.qasm.Qasm.md | 2 +- docs/api/qiskit/0.26/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.26/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.26/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.26/qiskit.qobj.GateCalibration.md | 2 +- .../0.26/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.md | 2 +- .../0.26/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.26/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.26/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.26/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.26/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.26/qiskit.qobj.QasmQobjInstruction.md | 2 +- docs/api/qiskit/0.26/qiskit.qobj.Qobj.md | 2 +- .../0.26/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.26/qiskit.qobj.QobjHeader.md | 2 +- .../0.26/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.26/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.26/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.26/qiskit.quantum_info.Choi.md | 2 +- .../0.26/qiskit.quantum_info.Clifford.md | 2 +- .../0.26/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.26/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.26/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.26/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.26/qiskit.quantum_info.Pauli.md | 2 +- .../0.26/qiskit.quantum_info.PauliTable.md | 2 +- .../0.26/qiskit.quantum_info.Quaternion.md | 2 +- .../0.26/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.26/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerTable.md | 2 +- .../0.26/qiskit.quantum_info.Statevector.md | 2 +- .../0.26/qiskit.quantum_info.Stinespring.md | 2 +- .../0.26/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.26/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.26/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.26/qiskit.quantum_info.entropy.md | 2 +- .../0.26/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.26/qiskit.quantum_info.partial_trace.md | 2 +- .../0.26/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.26/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.26/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.26/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.26/qiskit.result.Counts.md | 2 +- .../0.26/qiskit.result.ProbDistribution.md | 2 +- .../0.26/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/0.26/qiskit.result.Result.md | 2 +- .../qiskit/0.26/qiskit.result.ResultError.md | 2 +- .../0.26/qiskit.result.marginal_counts.md | 2 +- .../0.26/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.26/qiskit.scheduler.methods.basic.md | 4 +-- .../0.26/qiskit.scheduler.schedule_circuit.md | 2 +- .../0.26/qiskit.tools.backend_monitor.md | 2 +- .../0.26/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.26/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.26/qiskit.tools.parallel_map.md | 2 +- .../0.26/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.26/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.26/qiskit.transpiler.FlowController.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- .../qiskit/0.26/qiskit.transpiler.Layout.md | 2 +- .../0.26/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.26/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.26/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.26/qiskit.transpiler.passes.CheckMap.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- .../0.26/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.26/qiskit.transpiler.passes.Depth.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.26/qiskit.transpiler.passes.Size.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- .../0.26/qiskit.transpiler.passes.Unroller.md | 2 +- .../0.26/qiskit.transpiler.passes.Width.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.26/qiskit.utils.QuantumInstance.md | 2 +- .../qiskit/0.26/qiskit.utils.apply_prefix.md | 2 +- .../0.26/qiskit.utils.deprecate_arguments.md | 2 +- .../0.26/qiskit.utils.deprecate_function.md | 2 +- .../0.26/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.26/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.26/qiskit.utils.has_ibmq.md | 2 +- .../0.26/qiskit.utils.is_main_process.md | 2 +- .../0.26/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.26/qiskit.utils.name_args.md | 2 +- .../0.26/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.26/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1208 files changed, 1266 insertions(+), 1266 deletions(-) diff --git a/docs/api/qiskit/0.26/execute.md b/docs/api/qiskit/0.26/execute.md index f8e620f7153..396c542b693 100644 --- a/docs/api/qiskit/0.26/execute.md +++ b/docs/api/qiskit/0.26/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.26/logging.md b/docs/api/qiskit/0.26/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.26/logging.md +++ b/docs/api/qiskit/0.26/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.md index 2d896f3128d..399182a81fc 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.md index f799eec0eae..0c5c3774a63 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.md index 759cbb1f65e..c2836cd23a1 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.md index f5e0c2f1458..eefb858540c 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.md index b556964d697..e80e0ad124c 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The Amplitude Estimation interface. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.md index e2bf527b243..bce7fdcd886 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.md index d76e5f2dbcc..f1ba5b78959 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.md index f3bea317eb5..406952446e9 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.md index 956caa9f16a..c733f091a7f 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.md index c27702c06ad..55005595d01 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 802aefeae6e..1321c3b62aa 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.26/qiskit.algorithms.Grover.md index 652e7d89fd4..81439018082 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.md index 45b3bf0cb95..d2a41d6a70b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.26/qiskit.algorithms.HHL.md index d52ce666225..ca6f2d14556 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/hhl.py "view source code") Systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4c5df5656a4..d35103f35ad 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 6542136e76a..37bb09ff020 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.md index 2e53f8abb25..703f520771a 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 16aea5c0c06..4ff530ca25f 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.md index 90f59f74936..99f9df925a3 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") An abstract class for linear system solvers in Qiskit. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.md index ace4ff0075a..195d6ae7a97 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") A base class for linear systems results. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 5d435e06011..828071085f8 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 346339eac91..43eca5da3b7 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.md index 2be2ffe8d92..dab4dfd4f10 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.md index 49cf01feaae..b7784de4cbc 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.md index 29ff1e70f59..8016ad1d832 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.md index 5d558a83797..308ddf79339 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.md index e15f655a13c..155b6730e86 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.md index 80985c59f79..6b95a4d11ab 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.md index 2a9caa1e2bc..dd79745f27b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.md index d9b6f50ade3..58dd8c1c7cc 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.md index c9ee200f03d..297b227f82c 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.26/qiskit.algorithms.Shor.md index 43d9d239c44..bf44ef3032f 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.md index 29429c230ab..8666044bbc3 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") Shor Result. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.26/qiskit.algorithms.VQE.md index 974e34a1d63..a71f7763e19 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.md index 8667004cd86..c0088011ce9 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.md index 043c72235c4..3cfde2deeb7 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.md index 282299ccc49..c685e6e6cd1 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.md index a2eb42c003d..f689ce5137a 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.md index 8cc769b8779..4535e33a34e 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.md index 320a2da2045..c8fa927308a 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.md index c33a9198de8..cd14867f526 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5db2468fec2..c7642b708ef 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.md index 4b08da729f7..1f575ddcfec 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.md index e4e32268446..3d16d6e192b 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.md index 20df721fd7a..038a472e106 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.md index b7361c2bd7b..9d09d71d01a 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.md index 4e29aec7286..edd2a901880 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.md index e288e1ce8e6..d988f51f278 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.md index 75acbf82ce6..ec21a1922f6 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.md index 2ef52d30202..655c1f1bee4 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 0856e50bf5b..fc5ebf7953c 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.md index 0a8cefe3e5d..fc196284bd8 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.md index 5eb307d6470..32e64af2d05 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.md index 0ed226faf24..e07787c2b9a 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.md index 0ee40c914bf..ec70d18b8fd 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.md index 0a31ffb9b99..a0ec22f3126 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.md index b9628dad7d8..4a27afbfd5f 100644 --- a/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.26/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.26/qiskit.aqua.AquaError.md index 72bdd21c8cf..b0bbe2c81ef 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.md index a2705fb67ae..eef98fffca2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.md index 9ee4dad3049..0d8d6fc9477 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.md index c82a3f32b92..630926f0093 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 1f4556654dd..055cccfe474 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") AmplitudeEstimationAlgorithm Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 0450944cb6f..6382e73321e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") AmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.md index c782a8d61a8..33fd16d3b8f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 2c7ef4f8ac5..bbbc746c26d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.md index 39823865eaa..a67ca03ffc4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.md index 8ea64d5fad0..d3f8f9d731e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.md index 60113e9584c..e4598fd3333 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.md index f65a77574de..5d0835978d2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.md index 31d6a1c92f5..d1dc9805d11 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.md index 21f87ab7b5f..716729919ab 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.md index 40e4e5b30c0..c20a7413d27 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.md index ade87bb3d36..deeafde8261 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") The HHL algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.md index 711bc422e46..fe9eef0961f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") HHL Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.md index 3f5ba5aa9ab..b0a14448851 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") The Iterative Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index 8f2f88b7644..31a0777eceb 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index ca43e5778c6..79f7e665c21 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") IterativeAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.md index b2f1bbffc4f..ecfc7c0798e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Linear solver Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 24fc5dce30d..8a298d586b7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5c5d5e9ba73..148f0f90794 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") MaximumLikelihoodAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.md index b2572553aed..9f3296c218d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.md index 7f00556e724..bbb0f773d64 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.md index b6ce362fe1f..5ffd928f1e5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.md index be768fecf96..13f5d645b9b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 3bfdd481080..f97e6f296e7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Numpy LinearSystem Result. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index c424f9e0e3e..d4a62ade0f5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.md index a6e445c0c3a..075785e6fdb 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.md index 1c9433e0d0c..e49adddc4c4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.md index bf43630fd78..e2f4eba9f96 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") The Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.md index 4b11c7633ba..b3deb6dbdd5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Quantum SVM algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.md index e6dd5b1eaca..ce3d74260e7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.md index 56b4c11512f..2e3a4acafad 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.md index 8c76ae0bbda..4c781638b97 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") The Simon algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.md index 138ef590f05..a49fe1e2bf2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.md index de10c7051e1..d94d46d0847 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.md index 6889911df56..15795469c33 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.md index 433ff83adf1..8fbf05eac12 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.md index e309a95bd69..2385738c43c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.md index 99920079c46..73bd8cdd705 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 567d5d259dd..6df044e0ba4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.md index 2d4db79e802..9bc47428835 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.md index 345d2660260..2522a4854c2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds q^T \* w to separate register for non-negative integer weights w. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.md index 65c6382293c..9806b883b54 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Base class for eigenvalue estimation. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.md index f1abaff3330..bc20afe9d56 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.md index d09393cf480..e9f7b7b57f3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Base class for FeatureMap. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 9a188d126e0..8ea631c0a78 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Raw Feature Vector feature map. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.md index b1d1f7b7271..5a1982c7ace 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") The custom initial state. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.md index 4bed6eca882..ca765509ba7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Base class for InitialState. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.md index 446d360c9bb..6eb58020d6b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") The variational form based initial state. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.md index b9a66f9d084..86296612375 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.md index c97d45b3cf4..34bae3465dc 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 4b2eb2401d1..33d47cdb258 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 2eb6d3936db..e5ddf888858 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Base class for multiclass extension. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99d97264a8a..2ef53d7a23d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index cd60657c2a6..96ff7c3a0d4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Base class for discriminative Quantum or Classical Neural Networks. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 9724d541106..00fd1c50839 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Base class for generative Quantum and Classical Neural Networks. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 258ba48db93..cbede1b9f11 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Discriminator based on NumPy diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index dd11fb4be31..b3a32c57436 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 4cd9e258717..fdbc49aae48 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Quantum Generator. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.md index c20e5fb3db1..95d989bc92b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.md index 954ee20efcb..5823c34e847 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.md index 6f1df370dec..05c8a097e53 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.md index 4fdf15efc24..99abed6409e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.md index 67750b21b4d..58775337bc4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.md index 69f36fe5624..183be12c4e2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.md index f56e5ea574b..b14e7f6c251 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index cccef7e7320..72a9933e1f2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.md index 0906f993280..279ce0fb387 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.md index f88b865421e..636612e97c7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.md index 7387deb4d94..f7995f0a52d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.md index 555b00309b0..3cd707eaf29 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.md index 63dc681d75d..79558fd2d4d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.md index 34a97f3e91f..171aa2b67d9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.md index dae5ca40b91..c04ac766d9b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.md index 116295f4b6a..69dca758b6d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index d0e669bb1a7..37309e501f9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.md index 9c92991e2f7..56344c968b7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.md index 942baa7df9f..64596f96b46 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.md index c8ae54d9375..f4088801997 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.md index f883074badd..716c298f629 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.md index 211bbe75eb9..9d62ecb9d94 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.md index 52d1edcfb01..8575b1a8289 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 1efaf9e160d..6e6feb2e2c1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index 65747fac0be..3f4147f11aa 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.md index 29b17616d91..04bc2a4d417 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Base class for oracles. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.md index c8e8073d3e4..154378c14ca 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.md index 733b94065b9..8a122be5cc1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.md index 9b6aa75d977..e35cb5fddb6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.md index 29c83c2fd62..86c1b50d8a7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Base class for reciprocal calculation. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 945b9184909..e3e1dff27f1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") The Univariate Bernoulli Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 3715f75da1b..eea2bf371e7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") The Gaussian Conditional Independence Model for Credit Risk. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index ad68dffadeb..f04631bb7f6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") The Univariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 5ea01becec1..3622ff695a2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index e6038a59507..f2abd17b3d9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") The Multivariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 94b689e8499..702881b3beb 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") The Multivariate Normal Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index 7b2d17d5126..8c73d966e65 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") The Multivariate Uniform Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index a55a92a56e6..3406fdf8517 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") The Multivariate Variational Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index ad8841dd922..b3e399cf438 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") The Univariate Normal Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 082f187b3b9..b9a129ad8b4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") The abstract Uncertainty Model diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 089a4e41e48..54b2b6b2020 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") The Univariate Uniform Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index 8cc2bde0c8b..336f9e61c25 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 61ddd07d327..3eee9c45c7a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") The Univariate Variational Distribution. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 0f147dad700..32b5cf95140 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 4efc7c450e2..1570c4b049e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") The abstract Uncertainty Problem component. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 00398280d6c..4455c3fde38 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index c03f18d2b15..3763244e48e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.md index 7f77cc6a568..ae54370571e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Base class for VariationalForms. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.md index ec1917ebed0..9270c17966e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.md index 729f6c68b5e..16564a49cf8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.md index 101c6bac51f..104cae3fe55 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.md index c9c7905ff87..29d99e3b4a3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.md index fc2e0ba5493..289c8148ad7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.md index 14b55172bd2..013ed5623c9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.md index 8990a75bb23..9d7b75a0499 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.md index a8b3394e7b9..5d9f1afdf50 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.md index 924860e8670..c43bffcbc12 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.md index b78b1c8ba98..0f416fb1f81 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index f493a23c982..657c2eaf4b2 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.md index ff4a37374f8..26e712f47d8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.md index 663d6383679..63b01749667 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.md index 6937b3fc107..5a710fdbab4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.md index 493badc098d..0edc7d5fe4d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index 5acb3a36034..fe533716b26 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.md index d7b830c478e..fed697d4233 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.md index c6f9a807400..361118c50b1 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.md index cd31bab12bf..ba5d70e49d0 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.md index 520dfc545de..98c4fb9e474 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.md index 43fa318a514..a868c4bdba9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.md index 07eef403ff8..692df017e9a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.md index 8b6c5c27435..7b74a425017 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.md index 0af05335f59..e77492cc3a8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.md index a7034b7eb91..4358446ae62 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.md index 3ebf61675db..e4964472425 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.md index a531bd1b466..33f5d0652ee 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.md index b9b5a7aa145..25e02a21a8e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.md index d4b1ca8b495..63c7da727fa 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.md index 48a5ac2948f..a3c798ac103 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.md index 60790f54865..cd438b5d63e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.md index 817840970a5..5e8c7943fd8 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 9160971edff..aa8397ab620 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Operators relevant for quantum applications. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.md index dcfcb2d47f6..154e11912a7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.md index 56a752f289b..b8d7a1deb2f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Pauli Graph. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 6e3362f5b06..54b70f2993e 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") TPB Grouped Weighted Pauli Operator diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 46267d36942..8c7716d5814 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Weighted Pauli Operator diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.md index 8a6fcf48fac..c97c874fb6f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.md index ae2ec0e6793..351a63dea5c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.md index 667679ecec5..bcec2f74aa7 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.md index e16a1ab505f..6d86cba2f32 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.md index 4ef7c8af75a..76e3cec082c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0a46099874e..e15dc17735d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c584f2aa350..ba75a648daf 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.md index eeb9f35ed8b..478c72ab719 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 9867f1076e2..bdeec83e436 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 77fcc50b8ec..d477db9812a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.md index f0bc8604346..0eeaf0a02fd 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.md index e501482d8e1..05487a0a028 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.md index e63b4bae41c..a8dbb043504 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.md index 5ffd220a203..72d5480cbe4 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.md index cf5411c0ae5..fb2b001ed7d 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.md index 296315f2a33..a163f1dd643 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Base class for CircuitFactories diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.26/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.26/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.26/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.md index d1632a4184f..febbb1173ee 100644 --- a/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.26/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py "view source code") Class for Run Configuration. diff --git a/docs/api/qiskit/0.26/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.26/qiskit.assembler.assemble_circuits.md index caa783f499d..6349ddca727 100644 --- a/docs/api/qiskit/0.26/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.26/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.26/qiskit.assembler.assemble_schedules.md index 7c20b810bfd..b7d0e44ee02 100644 --- a/docs/api/qiskit/0.26/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.26/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.26/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.26/qiskit.assembler.disassemble.md index 3ca3fdc354a..bdfe1082bed 100644 --- a/docs/api/qiskit/0.26/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.26/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.md index 5c24fc48425..9940482184e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.md index 747136a0eec..955d0862bf5 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.md index 920d3f7a586..986c8ace0f2 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.md index 94dabc11d23..2a2137f0aa6 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Molecule data class containing driver result. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.md index 748e8648b33..ab262eba395 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.md index 05db7fb4c1d..9e0c20dc5f6 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.md index e4f4159190f..446cd7614f5 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.md index 8bc2599e3d7..379b0ffbda3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.md index 5795becc89a..c7bec35725f 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") A factory to construct a eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index bc7f21a57c3..2485d08dc09 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index 84a7fb46129..e8490042751 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") The excited states calculation interface diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 3dc080851a3..2cba3095bb8 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.md index 81e46c6895c..628441ad2df 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") The ground state calculation interface diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index f5231e126f6..5b0c2212770 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") A factory to construct a minimum eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index 22b0c687db2..121cee11ff7 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index fdf3ea87d60..48578808d21 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 66e029e6e97..0fc89fd5d13 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.md index c740cc0916d..12b6c879030 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.md index 10f5bf790b9..bd4b5beda83 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") QEomEE algorithm (classical) diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.md index 52341c1f288..a8383d988ee 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") QEomVQE algorithm diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.md index 91c095d3e2c..af6f1263af4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 7475c54a220..e49abf6427a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index d889402948f..ef4fb71169c 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 7fb7a8d3d9f..65c259a031a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 3a84c9a2f36..1eb0f3fe5a4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index f4c17027475..d32fc9580fb 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 75ac290d615..3d79c5bf9ba 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a potential energy surface diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index b7e582e3e2e..7c340ea87bc 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index bcd46c5f7bb..8775905ff06 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Implements a 1D Harmonic potential. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 54708eb2f7e..d2535769625 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Implements a 1D Morse potential. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index a73b1fb0456..2d7e114251e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 61194171a49..b9c4941f5be 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 1d859cea127..7c4a0073c60 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index f706abfdc97..3093a133add 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index bcea8622fd5..905c40eb111 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 4e834213def..9d9775ca901 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index cd1181103f9..cc8da4b32b9 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Molecular ground state energy chemistry application diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index c06008cf7d7..945666620d7 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 77719be753e..f98567f64f1 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.md index 76c30edce7f..2d9d0d70387 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.md index f95092a6d16..3054f09ac8d 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.md index f7ce6a53c02..b537bd9de45 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") This trial wavefunction is the Compact Heuristic for Chemistry. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.md index 4b2e49ad24a..e4fe17702d7 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.md index fbb3af3f7cb..5fd446b538f 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.md index 7a04e316abb..0b220e457c2 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Base class for ChemistryOperator. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.md index b5b4bcc999b..185dc931e06 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.md index 472883dd644..86424d40d53 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular chemistry Result diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.md index 5ce2ba01ee9..10c36ed37a4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Excited States Result diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.md index a5758bb9c74..b6ccc3eca49 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Ground State Energy Result. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.md index ce80df72b53..5b8d8a929a3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") QubitMappingType enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.md index 37622039125..fd938f5a0a7 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Transformation Type enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.md index 28c9c724102..9034ca598f4 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.md index 84eba214cee..3824fc7c343 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Basis Type diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.md index c1ff963cf6b..f966e471f6d 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Base class for Qiskit’s chemistry bosonic drivers. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.md index 059fd03f59b..559ab8099a6 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Qiskit chemistry driver reading an FCIDump file. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.md index a2a64dc4b38..e141b6ecbba 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Base class for Qiskit’s chemistry fermionic drivers. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.md index 8569c886245..a7afb167a16 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.md index 12591ef52b8..cf24c4d96aa 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.md index 8b57a5a98dd..d9243ba36f8 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.md index 9326f859b70..8158d55b550 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.md index 3ea0b3e6e71..79a14826c18 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.md index 0edd9b59c50..d62382da59b 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") HFMethodType Enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.md index aacfe0f8d8f..8562017cc21 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Initial Guess Enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.md index c9e14294833..506e0425c5e 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Driver-independent Molecule definition. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.md index de7fcc3f798..fdb29f147d3 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.md index 1011f674456..5e063af7f3a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.md index 5177ea1e968..285a1320513 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.md index a43e813c0a9..db273883a45 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Units Type Enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.md index a84f7153a90..07a6eb9eab5 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") The BOPES Sampler result diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.md index 97fb8c855f1..f865295260a 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") The eigenstate result interface. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.md index d10665d56ca..4d37d454137 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") The electronic structure result. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.md index 41cc19ec851..4d61669b64b 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") The vibronic structure result. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.md index 01afb136d73..f50e6d669d5 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.md index 74da609f5a7..72622b1d608 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.md index b2257adaf1d..e9b62d52d3c 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicTransformationType enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3c79ecddccd..1847365b7c2 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.md index 39a1dcc61fa..a135e2a8287 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.md index 313dfcc0743..5803fed8481 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.md index f2f8e92bd2d..421c80b7baf 100644 --- a/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.26/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Base class for transformation to qubit operators for chemistry problems diff --git a/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.md index b8689446b24..48a58d682f6 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.md index de10a32674e..e0290b3d0a0 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement an ancilla register. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.md index d083711c431..def9b25fa8f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") Implement a classical register. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.26/qiskit.circuit.Clbit.md index 464a68392df..74e20979ffc 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") Implement a classical bit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.md index 9c06f2820a3..62c183dd41e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/controlledgate.py "view source code") Controlled unitary gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Delay.md b/docs/api/qiskit/0.26/qiskit.circuit.Delay.md index d5c6ff453d2..aeadce3ce9f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/delay.py "view source code") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.md index a4076c216a1..424d81eb007 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/equivalence.py "view source code") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Gate.md b/docs/api/qiskit/0.26/qiskit.circuit.Gate.md index 87ccf338957..54771e428d4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/gate.py "view source code") Unitary gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.26/qiskit.circuit.Instruction.md index 27c72011ece..32af90da5ea 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instruction.py "view source code") Generic quantum instruction. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.md index 65b771ba972..371785e4377 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instructionset.py "view source code") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Measure.md b/docs/api/qiskit/0.26/qiskit.circuit.Measure.md index fbc388f8ebc..80fd13c3be1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.26/qiskit.circuit.Parameter.md index 96ebbee240a..fad20f5f650 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameter.py "view source code") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.md index ea4fe86a18f..910130a0ce7 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameterexpression.py "view source code") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.md index a1145de5ae0..1f7876fd981 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parametervector.py "view source code") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.md index 1ca8b35f3bd..ac4ecd74e0a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumcircuit.py "view source code") Create a new circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.md index 2a12a9e1d24..bb7934be4ca 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement a quantum register. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.26/qiskit.circuit.Qubit.md index 7e07d881fd0..13ec1c3157d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement a quantum bit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.Reset.md b/docs/api/qiskit/0.26/qiskit.circuit.Reset.md index 6c7b62d0bca..29189a0037f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.md index ca96fbc97a9..ec78258a01f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") The Boolean Expression gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.md index 5493bc601b1..c85fb8bd9e9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 203d8900620..7a4905c5809 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 696bd8c7af5..6405f681e92 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.26/qiskit.circuit.library.AND.md index 4dc13e4b3ba..93e391da31c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.md index 48067f79177..9878d93904b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/barrier.py "view source code") Barrier instruction. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.md index 2c76e5f589c..65ddb03b4b9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.md index c71b31ab9ff..f0ebe618639 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.md index facfe34ef63..0ccf5336925 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.md index 46c58665cfd..8347d7c4be4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.md index 02ea8afc1c6..bb279bd6c4e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.md index bf1f8247edd..c25e44f3564 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.md index de66b1e4fe7..3f965968d07 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") Controlled-RX gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.md index 3ae575796dd..1351553d161 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") Controlled-RY gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.md index 489b596fcc2..d365c733473 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.md index 4458281078f..6918c1a4c71 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") Controlled-√X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.md index d09fbd49b4a..c4106265d44 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.md index 15b7ffe7aae..5d0e0222bb9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.md index 6a87acc41c4..adb8a77ca7e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.md index 4a8f4228748..0808aa5c07b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.md index 5e4bf000bd5..57444db44cc 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.md index b6f9894be80..99adc9969c5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") Controlled-Y gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.md index c5f9f859308..ebeeaf808f3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") Controlled-Z gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.md index 1184e2363e1..5152b5bec1b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/dcx.py "view source code") Double-CNOT gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.md index 04c12e201cd..5762f94f124 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Diagonal circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.md index af7c6bd4ee0..9d34fb14c21 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ecr.py "view source code") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.md index def5bdaaa06..429b2344b2b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/efficient_su2.py "view source code") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.md index 8b69856ca5f..f87ac4dd41c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.md index 76cc001ceb9..7aeae122958 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/fourier_checking.py "view source code") Fourier checking circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.md index cfd7ee249c2..f0017194484 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.md index d99c4efa317..8f786473305 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GR.md index 12664d60107..3b097946ff3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global R gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.md index bfb70baf662..d42db8f6b4e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RX gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.md index e6b1d9a6f07..4dda4d72e48 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RY gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.md index 1c022fdf29d..cdb750d5515 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RZ gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.md index 1a3e6014739..7a61f10a5f0 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/graph_state.py "view source code") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.md index 8cdce8cf53f..9f1cc88287b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/grover_operator.py "view source code") The Grover operator. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.md index dd9495a2bf2..1fd884aec7d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.md index 242c7051ef3..7fde137be66 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/hidden_linear_function.py "view source code") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.md index f09fda86823..eb81b33cc00 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/i.py "view source code") Identity gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.md index a7e99350c2f..c5c9bbb2e15 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/iqp.py "view source code") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.md index d75686d3091..6a988223afe 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") An n\_qubit circuit that computes the inner product of two registers. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.md index 52636a720db..0b2a1ccc881 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Integer Comparator. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.md index b89d5a7c239..e3527392c9f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.md index bf58db548f8..2d776d21ada 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.md index 96a869c1c0a..3ce7bc59689 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.md index b2f26542fa2..667818d7fd5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.md index 5aed7b1dd51..313ff54696b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.md index ad365ea6e88..52afb1d2c57 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.md index 25a83e73333..93c004fffd0 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The general, multi-controlled X gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.md index fe84787d890..3e153507f0f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.md index 336eb9cfcc2..67d0a987ceb 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using recursion. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.md index cd8600feab1..276cf79c504 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using a V-chain of CX gates. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.md index 314e2adfb3d..b6fb9748276 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ms.py "view source code") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.md index 96884eb1d54..8ea2da31c57 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.md index 94466e4439a..869b234ef9c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/n_local.py "view source code") The n-local circuit class. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.md index 3295e2d4526..bfdc44ac66d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/normal.py "view source code") A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.26/qiskit.circuit.library.OR.md index 56051fbbf78..f247786ed7b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.md index a847751f401..bcd02d59033 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.md index 395b01a7d2d..44a5d10239e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.md index f415ac6647f..df26ba1313d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/permutation.py "view source code") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.md index 3f4d9f4c321..b362ee958f0 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_estimation.py "view source code") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.md index c90230ba96b..c44ec9d5e11 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.md index 4b2aa2d59d2..1251bdda4e1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_oracle.py "view source code") Phase Oracle. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.md index 5c04d6c22b4..ee05379d965 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index fa78e81129c..3229af9f938 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index cc41ca62da0..1ba82b0e89c 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.md index 6e22b262e55..36a8c019928 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.md index c620c12c3d7..19f03026622 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='qaoa')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='qaoa')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.md index 32e5964dd9c..3eebe1880e2 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/basis_change/qft.py "view source code") Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.md index 19ad6083516..a4c40ec68bb 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Implements a quadratic form on binary variables encoded in qubit registers. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.md index 2abbcaa2ab5..4857ced0759 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/quantum_volume.py "view source code") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.md index d828fbbb76a..142218cedb8 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.md index e80e66e23c5..9ad9fec2a21 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.md index 27ae45fddb7..dc4cf3013e3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/r.py "view source code") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.md index 2c2e1883a75..2e35776bb55 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/rv.py "view source code") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.md index 7ebd43c879a..0aa6996af5e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.md index 2a791ae1a9a..4fcc145ef71 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rxx.py "view source code") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.md index 8b14cb14fa2..5942b88a721 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.md index f1197436491..ef94d257fe9 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ryy.py "view source code") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.md index 8128226e26e..d7c497e3862 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.md index aff25ba90f8..ddf87476d96 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzx.py "view source code") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.md index 177b15c039b..534d21b34d1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzz.py "view source code") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.md index 2714bfa9bfd..923b6b507c1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.md index 7b7c61b44df..e0c93f1d6cd 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.md index b8a49fa527a..5cd883593b3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.md index 281cd0ffbcd..7ea3965c035 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.md index 931bd4bac39..09ae9a04916 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.md index cfbddfa9148..02d1d4b0c49 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.md index 40757d25acb..b6d7d3749d4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") The SWAP gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.md index e8f4333227c..01a1c5f7fc5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.md index 8b396c13f5e..8584d33be78 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.md index a7b7447e6d4..0e7e6977d0a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/two_local.py "view source code") The two-local circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.md index 029f06a5044..f9266056e27 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.md index 9d178a3df1d..34db0c7f695 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u2.py "view source code") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.md index 55447af66d2..a94db2b64ae 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.md index 7c04d167347..2f0460ec780 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.md index b1ab854f318..f94e1f50d92 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/uniform.py "view source code") A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.md index 1c4c6daf593..7056fc22e4a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.md index fc8bb4d214e..5d3304cdf92 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.md index c717a765509..b71c4ac5898 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.md index bde4bf63e2c..ecafaa289bb 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.md index 683b4d41972..7e90a871117 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.md index 944bc5a0ad5..a88d237646f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.md index 3b2e0b5c63a..b56ed065a2b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_1.md index dc4faed3a93..e3cbf9e0a18 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_2.md index a1e62d88610..4aec5545ca1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_3.md index 5e6651ff807..b5a1ee51204 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_4.md index bcc219cdc9a..17d112be973 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_3_1.md index 7a2889c3321..36d9f286835 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_1.md index 1181d7dd892..61afa53bbe6 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_2.md index b4c80ed2ffe..f384fc66775 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_3.md index 6c47aaef224..c12df5f9403 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_4.md index 1f7012859be..9e237e2a6e7 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_5_1.md index d9164f65b22..1dfff65b466 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_1.md index 3f6bf6db46f..bfda63fd168 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_2.md index c63bb56f2b2..6ea1326ed8f 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_3.md index 65d8bc1dccd..cb8b6edeb14 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_4.md index 7d6f87b894f..a182d0cf7f4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_5.md index 1dc75c07c75..1935ec61892 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_1.md index 0b9445c8ddb..c938578f239 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_2.md index 1bc852517ef..42e229e947e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_3.md index b6aa73ac4e1..fa2a54ecaf7 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.md index 12e5e1dfb5a..fea6d949cf5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/iswap.py "view source code") iSWAP gate. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_cy.md index 7ccb8c60296..e38e4f167f3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_xz.md index 1651b1a1592..8793a9321a4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_yz.md index 2ec0caab564..b00d3442af5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz1.md index c9003249f9b..d6717d449ac 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz2.md index 67639bdd08f..72af0080570 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz3.md index 52fd7573040..2bbd9d25cf6 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index dec29c85192..d7212cbdf12 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 4a1561de3b7..26d5b88e2f5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 5465418bb16..71359895c17 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 5ff2a8cd00b..32722501373 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index e008e1d3606..d095b00cbcd 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 2bdd91aec8c..d8aafae0082 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 713d02d8971..df95b4a13ca 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 05da7fc345e..ffce1633fa4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 585f829babb..49a9feae969 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index b07096e01d7..ed86a33416a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f3854aace9a..12ee3bc9110 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index e7e409508a5..c244cdf8cba 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index f0f455970f0..e195041a20a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 6aeff1fc0d5..c7c3e32e552 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 281601f57b8..2c61c90f851 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 67130cf48f6..947ea64e535 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 2837dc024b3..e1465477f79 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index a82552427d9..d1ea13ec6bd 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 7c5b7cc15f8..14f8b25b321 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index ff698e57d50..c87f398da5e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7e302ab4a62..b7c55f674be 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index d4849b0ec07..f42f2e937dc 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 0a47443257a..d87bc1a8271 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index a616d285f91..4aa4a6dc94d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 257e60a4624..6f285fff2ca 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index f2c8c9d5682..5262b2bd07b 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index c158da8da0e..1e8fab96a69 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 6c6e6b9df63..33c443f6608 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index f8becbdd978..222d07711b1 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index d0eb88381e8..6a64f319cc4 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 5e55b75867d..2132041a985 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 730fb05f07b..bf9d9da3555 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 68c9b82dd2d..700c51d2c10 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index f00914d9ec3..bfb6fe8239a 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 66bbb71d092..5df1f2a3564 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 77216d8ced2..7f07f840eaf 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index c985bf917ca..17ac239ee84 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 42ca1cfc0da..d75b80d9927 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 8d91854d4e6..a203bba6f61 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index caa4ba6c373..06d9b565371 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index e4ee0f9f628..06ecb552099 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index f3c1feec0df..e06573c24e5 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 108ccc7045f..62b7e05a4a3 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 81ecf210b0b..a94b396f37d 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 953d059611c..da19fdce43e 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index b0e70996835..15925f38779 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index fcf33cb097d..27c6abb91df 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.26/qiskit.circuit.random.random_circuit.md index 6849b627e1d..df4ca4eb9d7 100644 --- a/docs/api/qiskit/0.26/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.26/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.26/qiskit.compiler.assemble.md b/docs/api/qiskit/0.26/qiskit.compiler.assemble.md index fb20d988d7e..250b0a0f358 100644 --- a/docs/api/qiskit/0.26/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.26/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.26/qiskit.compiler.schedule.md b/docs/api/qiskit/0.26/qiskit.compiler.schedule.md index 90381037ca0..d357f5eb64e 100644 --- a/docs/api/qiskit/0.26/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.26/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.26/qiskit.compiler.sequence.md b/docs/api/qiskit/0.26/qiskit.compiler.sequence.md index 0f2a638fe95..674c495df7e 100644 --- a/docs/api/qiskit/0.26/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.26/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.26/qiskit.compiler.transpile.md b/docs/api/qiskit/0.26/qiskit.compiler.transpile.md index a22cb317ac3..f661128234a 100644 --- a/docs/api/qiskit/0.26/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.26/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.26/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.26/qiskit.converters.ast_to_dag.md index a9683e681f7..f26e28fd4f8 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.26/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dag.md index 27959ab4354..b63fd52fabf 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dagdependency.md index 67a08de74cb..2ec4738cb4e 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_gate.md index 065af631ccf..9f819ac9b94 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_instruction.md index 34016390926..d16fc688c5a 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.26/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.26/qiskit.converters.dag_to_circuit.md index 0d3af46949c..e973c795a9b 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.26/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.26/qiskit.converters.dag_to_dagdependency.md index 5a14894f46d..9cfc2bcf89b 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.26/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_circuit.md index a1808e8bee6..223914d0566 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_dag.md index d7f056bbc86..ecc5d7648e8 100644 --- a/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.26/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.md index 8c6149b55c3..57dd50d7d62 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagcircuit.py "view source code") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.md index 2351592301a..768c8b11811 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.md index d5b7d0f4c42..e6e3ab74d25 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdepnode.py "view source code") Object to represent the information at a node in the DAGDependency(). diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.md index cbd83ac69a9..d8e594c1bcf 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdependency.py "view source code") Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.md index febeaa15a5f..23ad2af142f 100644 --- a/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.26/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagnode.py "view source code") Object to represent the information at a node in the DAGCircuit. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.md index 5837205347e..028996bf970 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.26/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/hamiltonian_gate.py "view source code") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.26/qiskit.extensions.Initialize.md index 8c4d741c96a..949e9b6cb07 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.26/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py "view source code") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.md index 85f85f8745c..f742203c37c 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/simulator/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.md index 33307a0dab7..85e8bbd120d 100644 --- a/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.26/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/unitary.py "view source code") Class for representing unitary gates diff --git a/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.md index ecb17062b1e..ca345b23a89 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.26/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md index 82487c60134..ef69b4836a1 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md @@ -26,7 +26,7 @@ Convert portfolio optimization instances into Pauli list -`get_operator(mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`get_operator(mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") get qubit op @@ -34,7 +34,7 @@ get qubit op -`portfolio_expected_value(x, mu)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_expected_value(x, mu)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio expected value @@ -42,7 +42,7 @@ returns portfolio expected value -`portfolio_value(x, mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_value(x, mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio value @@ -50,7 +50,7 @@ returns portfolio value -`portfolio_variance(x, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_variance(x, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio variance @@ -58,7 +58,7 @@ returns portfolio variance -`random_model(n, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`random_model(n, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") Generate random model (mu, sigma) for portfolio optimization problem. diff --git a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md index f91ddbb89e1..bb47d349453 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md @@ -24,7 +24,7 @@ portfolio diversification -`get_operator(rho, n, q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_operator(rho, n, q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Converts an instance of portfolio optimization into a list of Paulis. @@ -46,7 +46,7 @@ operator for the Hamiltonian -`get_portfoliodiversification_solution(rho, n, q, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_solution(rho, n, q, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. @@ -69,7 +69,7 @@ a vector describing the solution. -`get_portfoliodiversification_value(rho, n, q, x_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_value(rho, n, q, x_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). diff --git a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 9f5809eb8b1..4f464fc2052 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") The European Call Option Delta. diff --git a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index dab41ef195a..1682162de70 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 142aad07547..a502f97f51d 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.26/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.md index d85745d4aec..ff8b9ee0b55 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") The abstract base class for data\_provider modules within Qiskit’s finance module. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.md index 8f945e76f70..963504596fb 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.md index af2b26fb556..d2b478f9069 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Exchange data provider. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.md index b73991b0df4..b19b1d0c3e8 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.md index 105c54a6304..6b382b8766a 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Stock Market enum diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.md index 5556d0d8463..4fcb867c5fb 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Wikipedia data provider. diff --git a/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.md index b2529cd4972..25ccfa057df 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.26/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Yahoo data provider. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.md index ed885e86acb..f893ff8583f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.md index 529402f02ba..98d87705c94 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.md index 3be217cdf55..a5e78ab334d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.md index 02a0e6a865c..78f0982e69f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.md index 94f70611e32..445eb111c8b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.md index dcbb143056c..ac440e27f5c 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.md index 36ce349ad43..35b450c59e8 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Drag Experiment fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.md index d66deee5d0a..e133ca7ec0c 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Rabi Experiment fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.md index 810576dcce7..b2901ae9ccd 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.md index 2d63119331a..4c52b3df4ba 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.md index 639b9cf3e90..c6359b2cbc0 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.md index 98fb9d3ebef..f57659067dc 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") ZZ fitter diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.26/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.md index 86073e22305..472a8f16b42 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Class to read from Ignis log files diff --git a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.md index b0481d5b676..3f80ff9739e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.md index 2d9915510ed..fdaac5a520a 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.md index 6e65d9093b1..8fa8d3e7401 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Implements a filter based on a discriminator that takes level 1 data to level 2 data. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.md index 445d42fea9f..5376260c0bf 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Abstract discriminator that implements the data formatting for IQ level 1 data. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.md index 52c0f8470d5..ee9c25308de 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index c1c3ff698c7..919f54257e6 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.md index a642898bc59..79be0223b34 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 8e15311737a..6c0871b24a0 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index e7b577353ba..3e133e59a91 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.md index 24a8214febc..7d1c769ba6d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 94239cbb31f..20d9c599347 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.md index a66fbc2dc00..7474d28cca9 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 1fc9f995da8..05e6a60eaad 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.md index 2ea8d6aeb6c..fb77a6ff758 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.md index e0ce4027d78..965d40ad123 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index b25e41fc47d..a85a1d440c3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.md index e351e671e68..10b34c7821b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.md index 5745acc3c58..9fd9d225eb1 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Class for fitters for accreditation diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.md index 8f394ba2eb6..8a6398a21b5 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.md index 29ec35ed014..e3d5eadf067 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 984ccf64b31..5b483d5e83d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.md index c05e3fde8b9..5ffc2e22f3c 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.md index 9ac37c8dbe0..78f122d4e7f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.md index 2586d94a7de..b8b89587dc3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.md index 76e568f038f..659f420190d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.md index e22e30738b1..d6b9ef1066b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.md index 9484ec90e87..ebdbd4cf482 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitter for purity RB. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.md index aa6434746b3..cd6678b16ff 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.md index 853da1bd407..5c89a7aba32 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.md index 3a16e469600..6abf51cec2e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.md index 1d4c9a2b8ff..c6524de5a29 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.md index 23e8a604805..c3854fe866b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.gates_per_clifford.md index 778be69e2fc..5a37973eac1 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.md index 323480f6288..2da016d1292 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.26/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") The raw feature vector circuit. diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.26/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.26/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.26/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.26/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.md index 8d94a664800..de0bf7bc9d6 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.md index 58f7a5cd1ca..ca5963e99cd 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.26/qiskit.opflow.anti_commutator.md index 707f53ac858..fb408209fdd 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.commutator.md b/docs/api/qiskit/0.26/qiskit.opflow.commutator.md index d1733a0b85b..d5d40b09107 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.md index 71e83825608..48ebbe7941e 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.md index 0c2082ae486..292d165e0a3 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.md index e24cc84de63..da3c686ca2b 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.md index eb9fa187fa6..c6964a48978 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.md index 877d5687496..4f3064c80af 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.md index 8a6916326d7..425bd278127 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.26/qiskit.opflow.double_commutator.md index 6ad64c090e8..850608b415b 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.md index 0008d1ba281..92b438392fb 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.md index 01965ad18f1..9e7bffdfd39 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.md index f37b64a5fb5..781d328deed 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.md index 0d432c8cff1..b362358f251 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 32d32c2b587..93a4756fe34 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.md index 17ed7374761..52619e0bc91 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.md index 43306334942..669fec7e20b 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.md index bf960e2698f..1988f1f115a 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.md index e8518cef03c..0c652c8734d 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.md index 1a3df80666b..ca66f92fc33 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.md index fdf350c314d..d46f1ee0f2a 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.md index 1f951aeddab..751922cdeec 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.md index 101d3c33823..ebc1296e137 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.md index 44194d5f04f..bf8ea9fd23c 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.md index f95770f1738..20a6c99656d 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.md index f7b5c9b5a29..45462b19951 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.md index dfa76447827..b57a610560e 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.md index abb19f47e5c..1377fe8dc30 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.md index 43d5e281feb..7b3b5bb2ff9 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.md index 9f54fdbdc23..3d65d5d4c53 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.md index 8f41fa3a5f6..55972daa363 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.md index 7ec10d6e24a..bfcede6c7f9 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.md index 157026b9b24..2eacb98e044 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.md index 1ae6e337d8c..13b16a78202 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.md index ef0f9a593c3..ba4227a807b 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.md index 693007f5478..bdfcd6a0a74 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.md index 1f1700876d1..4c0566de079 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.md index dcaff673076..e1a9cab46dc 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.md index e7c1724d624..1eec993539a 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.md index 429e2c35ddd..68f41baa43b 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.md index 481377d1d21..73da1702b17 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.md index 9aae3c6f473..d55ef90b087 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.md index 744b19c7ed4..da79bc56dc6 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.md index ca056f2a6cd..db3f2bdd4d8 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Class for Operators backend by Terra’s `SparsePauliOp` class. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.md index 76c38b6dcad..bf891dd4ad3 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 3a6c2da01dd..20b3eada75d 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.md index 5b9af319b6e..a3f1b4a6f80 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.md index 852c80aef91..54d5ceda6ff 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.md index abbfb1bef17..14fc1084715 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.md index d3b02b27786..8a6c7765394 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.md index af13baec6c4..d910c0c706f 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.md index a10c86c03ad..78933479645 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.md index ac2e50b5ea5..95cac10a5d9 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.md index 2256ab68862..b5f3204ada4 100644 --- a/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.26/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.md index 304150f966a..bd857c9c660 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.md index 674474f35f9..78e99bc2472 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 17af3a09858..1b6166ac65d 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") ADMMOptimization Result. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.md index 5a9e3ff4519..7386da93f22 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.md index 15f3262f99a..4e343ff6377 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.md index 7ee07742d82..362a537c445 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.md index 5ebec509d34..d60a3e2901f 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.md index 30263ad300e..60f4bec0f02 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.md index e8ab32b3942..2e874fdb345 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.md index d2e209d9519..efeac68726a 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.md index ab548ee9a40..e9bb5ad2434 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index fd484fd9968..493aaf92877 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 9a551193b54..9423baa3dfb 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.md index 67ecb8e93b2..e82e9412126 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") An abstract class that implements multi start optimization and should be sub-classed by other optimizers. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 60a45207071..cfa0e08cc4a 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") An abstract class for optimization algorithms in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.md index 29a0d61797e..83b5a934e43 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A base class for optimization results. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.md index 9026c12b26f..5dbb92371d1 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index b3b2bbe8a76..dd89b22cb2f 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index 44f22ffb05d..3941cba02c8 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 0e30e198c16..a188258a27d 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.md index 83328d79f17..e88bae6e104 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.md index 39310570580..670335045ed 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A sample of an optimization solution diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md index c0e4c528922..30654adc846 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md @@ -26,7 +26,7 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_operator(weight_matrix, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Generate Hamiltonian for the clique. @@ -89,7 +89,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`satisfy_or_not(x, w, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`satisfy_or_not(x, w, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md index a80b94865a2..3054279f4fc 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md @@ -27,7 +27,7 @@ common module -`get_gset_result(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`get_gset_result(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Get graph solution in Gset format from binary string. @@ -47,7 +47,7 @@ Dict\[int, int] -`parse_gset_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`parse_gset_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read graph in Gset format from file. @@ -67,7 +67,7 @@ numpy.ndarray -`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate random Erdos-Renyi graph. @@ -92,7 +92,7 @@ numpy.ndarray -`random_number_list(n, weight_range=100, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_number_list(n, weight_range=100, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate a set of positive integers within the given range. @@ -115,7 +115,7 @@ numpy.ndarray -`read_numbers_from_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`read_numbers_from_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read numbers from a file @@ -135,7 +135,7 @@ numpy.ndarray -`sample_most_likely(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`sample_most_likely(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Compute the most likely binary string from state vector. :param state\_vector: state vector or counts. :type state\_vector: numpy.ndarray or dict diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md index 343cc6b736b..d966cb3984e 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md @@ -62,7 +62,7 @@ print('tsp objective:', result['energy'] + offset) -`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") +`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") Generate Ising Hamiltonian from a model of DOcplex. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md index 6eced2620c4..f974ade5491 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md @@ -24,7 +24,7 @@ exact cover -`check_solution_satisfiability(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`check_solution_satisfiability(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") check solution satisfiability @@ -32,7 +32,7 @@ check solution satisfiability -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") Construct the Hamiltonian for the exact solver problem. @@ -62,7 +62,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md index 2d3f7e88296..284fa2483c2 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md @@ -24,7 +24,7 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Generate Hamiltonian for the graph partitioning @@ -74,7 +74,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`objective_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`objective_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md index 6f9306be50f..f84a1081ee4 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md @@ -28,7 +28,7 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We -`get_operator(values, weights, max_weight)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_operator(values, weights, max_weight)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Generate Hamiltonian for the knapsack problem. @@ -67,7 +67,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`get_solution(x, values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_solution(x, values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian @@ -90,7 +90,7 @@ numpy.ndarray -`knapsack_value_weight(solution, values, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`knapsack_value_weight(solution, values, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the total wight and value of the items taken in the knapsack. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md index 0f7cd5d4d0f..4805af75417 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md @@ -24,7 +24,7 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Generate Hamiltonian for the max-cut problem of a graph. @@ -64,7 +64,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`max_cut_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`max_cut_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md index 451c7de04e4..4b11ba268e4 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md @@ -23,7 +23,7 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami -`get_operator(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`get_operator(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Construct the Hamiltonian for a given Partition instance. @@ -45,7 +45,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`partition_value(x, number_list)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`partition_value(x, number_list)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Compute the value of a partition. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md index 6fe5f8562f4..fb73f528287 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md @@ -24,7 +24,7 @@ set packing module -`check_disjoint(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`check_disjoint(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") check disjoint @@ -32,7 +32,7 @@ check disjoint -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") Construct the Hamiltonian for the set packing. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md index 2f6481bbfd8..49ec6bef7c5 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md @@ -24,7 +24,7 @@ Convert stable set instances into Pauli list. We read instances in the Gset form -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_operator(w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Generate Hamiltonian for the maximum stable set in a graph. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`stable_set_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`stable_set_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Compute the value of a stable set, and its feasibility. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md index e5f3da7c799..7cdddb409d5 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md @@ -90,7 +90,7 @@ Alias for field number 3 -`calc_distance(coord, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`calc_distance(coord, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") calculate distance @@ -98,7 +98,7 @@ calculate distance -`get_operator(ins, penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_operator(ins, penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate Hamiltonian for TSP of a graph. @@ -119,7 +119,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_tsp_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_tsp_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Get graph solution from binary string. @@ -145,7 +145,7 @@ Instance data of TSP -`parse_tsplib_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`parse_tsplib_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Read graph in TSPLIB format from file. @@ -165,7 +165,7 @@ instance data. -`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate a random instance for TSP. @@ -190,7 +190,7 @@ instance data. -`tsp_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Check whether a solution is feasible or not. @@ -210,7 +210,7 @@ bool -`tsp_value(z, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_value(z, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Compute the TSP value of a solution. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md index cb9da8e8f25..5f65ba76a71 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md @@ -25,7 +25,7 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela -`get_operator(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_operator(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Converts an instance of a vehicle routing problem into a list of Paulis. @@ -47,7 +47,7 @@ operator for the Hamiltonian. -`get_vehiclerouting_cost(instance, n, K, x_sol)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_cost(instance, n, K, x_sol)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Computes the cost of a solution to an instance of a vehicle routing problem. @@ -70,7 +70,7 @@ objective function value. -`get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_matrices(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Constructs auxiliary matrices from a vehicle routing instance,** @@ -94,7 +94,7 @@ a matrix defining the interactions between variables. a matrix defining the cont -`get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_solution(instance, n, K, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Tries to obtain a feasible solution (in vector form) of an instance** diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md index 5ed46e10885..e7a7f6ca931 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md @@ -24,7 +24,7 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https -`check_full_edge_coverage(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`check_full_edge_coverage(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") **Parameters** @@ -43,7 +43,7 @@ float -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Get graph solution from binary string. @@ -63,7 +63,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. :type weight\_matrix: numpy.ndarray diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.md index f8f704a52fc..29350019ea1 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.md index 2f5c80c1ef7..99f0adf8fe1 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.md index f024d2ee2e8..0dc4616b504 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.md index ab03f35f781..f9a975f909a 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") An abstract class for converters of quadratic programs in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.md index a8104b0ac7b..d4c568df7fa 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a given optimization problem to a new problem that is a QUBO. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.md index 93bc81c16d2..cf06eb77f61 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Abstract Constraint Class. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.md index ea2a6195930..333c6c421ac 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Representation of a linear constraint. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.md index 7d29ca84a02..571ef9bdd64 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.md index a4b05490665..fb524232154 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.md index b3a3d449e0a..98483913d00 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.md index 9b7213f270b..f8bfa4ff1d9 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.md index 37612451790..31d5a1779dd 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.md index e823ffa405e..fa73300a3d2 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.md index 284a7cdc3eb..059a4253795 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Representation of a variable. diff --git a/docs/api/qiskit/0.26/qiskit.providers.Backend.md b/docs/api/qiskit/0.26/qiskit.providers.Backend.md index 27965da709f..26ee0aa9929 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.26/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.md index 6d4a52d2aea..ffca01c35cc 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.26/qiskit.providers.BackendV1.md index ec61a6906be..a4c068000dc 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.26/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") Abstract class for Backends diff --git a/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.md index 4e9335e8cba..d266197603e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.26/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basebackend.py "view source code") Legacy Base class for backends. diff --git a/docs/api/qiskit/0.26/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.26/qiskit.providers.BaseJob.md index 5beccfe7ce7..cfb4d82c484 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py "view source code") Legacy Class to handle asynchronous jobs diff --git a/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.md index 06c4152aad1..faa0a818fbd 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.26/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/baseprovider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.26/qiskit.providers.Job.md b/docs/api/qiskit/0.26/qiskit.providers.Job.md index 1c855b5d67e..5b1ca9e7630 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.26/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobError.md b/docs/api/qiskit/0.26/qiskit.providers.JobError.md index f77462fa523..ba986ac2595 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.26/qiskit.providers.JobStatus.md index 656412ee927..fa48efbbb96 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.26/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/jobstatus.py "view source code") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.md index ec482d8a579..0f3c561a96e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.26/qiskit.providers.JobV1.md b/docs/api/qiskit/0.26/qiskit.providers.JobV1.md index 2206017267e..99ddbd07769 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.26/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") Class to handle jobs diff --git a/docs/api/qiskit/0.26/qiskit.providers.Options.md b/docs/api/qiskit/0.26/qiskit.providers.Options.md index 1d72f8e5622..92a63938cf6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.26/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py "view source code") Base options object diff --git a/docs/api/qiskit/0.26/qiskit.providers.Provider.md b/docs/api/qiskit/0.26/qiskit.providers.Provider.md index c8083cac943..3e34ef3b670 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.26/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.md index f18b14a9893..868bdfe5e7a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.md index 2b6f8d2458c..e2fb65a710d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.md index 2ee285ecc30..962f5d96008 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.md index a5f72fae952..7a37fccd21e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") AerJob class. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.md index 6baae661743..9f0aa5ad188 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.md index d4ecef6e1a4..b577121c0d3 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.md index aae39c50b40..26038944531 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Pulse schedule simulator backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.md index 478eff1c779..6de36e122bd 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.md index 1b8736e1fc7..2bfa769ee7a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.md index 67af4b97c18..f33e13f5717 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.md index 066992c8407..df6a08bd898 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index ffe92423a6e..e569f4a78f6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Snapshot instruction for density matrix method of Qasm simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 7f79bbd276f..f17e67e2cda 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Snapshot instruction for supported methods of Qasm simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.md index ddb9a6d0618..7c7cb7c67a8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Snapshot instruction for all methods of Qasm simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 23fb21d1734..d7abca1d82e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Snapshot instruction for stabilizer method of Qasm simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.md index 6ad06288c23..444d19880c6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Snapshot instruction for statevector snapshot type diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.md index 4249e0b58db..b508cde6e54 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.md index 5145be163fd..3b9e1ac52c3 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.md index 58f06adf8c2..28846ba4e0b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save a reduced density matrix. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.md index cc701db53b7..51cb318f0c7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value of an operator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 2c86695c951..708d6699363 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.md index f31dd2f5238..067432b4498 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save matrix product state instruction diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.md index 36e7f8ffb9f..87820b5c042 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.md index aa47a2401a5..9fb5f063512 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.md index 3e23b97c24b..1718829f0a4 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save Stabilizer instruction diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.md index 036e7471bfd..920a51b5ef6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save simulator state diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.md index 8ac28acac38..31c040b6dd2 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.md index 0d8625397cd..9b54b2dd98e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.md index 1777a39b185..5ff8e62cc1c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.md index 75eda5796a5..8b525c47e61 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save Unitary diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.md index ec7f72cca70..5f8532d50fe 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.md index 0a8ae348968..364f17e8962 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.md index ebbe1d257d4..5edbc66cdc7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.md index eac31f48437..a16a58c966e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.md index 4c9e01519d5..3395c79fa14 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set superop state of the simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.md index cba8cb98d92..d78ffe14ce8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes.md index 0b669b04105..c34cc5ee857 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes_squared.md index 79bb40eff0c..fdac25ecd47 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_density_matrix.md index 74cc65ec146..1e650bd5b06 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value.md index 2f0af0f1bc9..7d4ffada7f8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value_variance.md index dd1ed4ef639..b591246f76c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_matrix_product_state.md index e77c2db58c1..4db8d3ff042 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities.md index 606b66af4ea..a2eaecff1b7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities_dict.md index 16ae2c687ca..086ffe552f5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_stabilizer.md index d01c85e1c12..3e086d79eaf 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_state.md index 07e5c762060..5cd6ad9855d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector.md index 482606c1893..5dc73b693ee 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector_dict.md index a1f1dc7b1e3..367fbad5b48 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_unitary.md index 73d179e5f2e..06fe9ae787d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_density_matrix.md index bee816e1bb8..51fec524b7e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_matrix_product_state.md index 2db259b4d51..6c1f7c0873a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_stabilizer.md index 31c78105b09..e31c686988f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_statevector.md index 63b8fb72b15..166311867bd 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_superop.md index 28725784533..a2acde4da8a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_unitary.md index 3755cd50221..0549bfa7dae 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.md index 8a585149850..e7c214d97fc 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Noise model class for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.md index 1fc3e9bcb73..e953bdcab69 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Quantum error class for Qiskit Aer noise model diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.md index fd3891e02af..cc43a7ab1d3 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Readout error class for Qiskit Aer noise model. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.amplitude_damping_error.md index 0305f120e20..1fc12ab472e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.coherent_unitary_error.md index de1107669a4..aa2837fad3b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.depolarizing_error.md index 2505d42afae..a0face8dffa 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index bc242d7510e..b7c298bd8e5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index c62af1cd229..3821d29c4e8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_error_values.md index 2b1bc8469bf..7b65ff11d8f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_length_values.md index be7ea78eba1..69721d2f87d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_param_values.md index e657b1665df..9c81011bd27 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.readout_error_values.md index 97d13adc45c..18730236d34 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index dd116379a5f..18946d6a22b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.kraus_error.md index a35fecba148..4585336fd09 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.mixed_unitary_error.md index 0669b855ab3..69625c92fe6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.pauli_error.md index c92b7ceed49..cdec5fd9b84 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index b76a0b6f054..9d1fedfdf22 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_damping_error.md index 29082f182c5..571f69680b8 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.reset_error.md index d44921cd510..c9c5a2c0aa1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.thermal_relaxation_error.md index 09ab8cb4351..5625c43ea4d 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.md index a229bde8f91..625add9df89 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Physical model object for pulse simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.duffing_system_model.md index c880b5f09ee..11af83e0ecf 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.md index de7ab8ff080..974c0f09a10 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transforms one quantum channel to another based on a specified criteria. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_noise_model.md index 2f5e3d6397b..014084327f7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_quantum_error.md index 621da3e103e..6182b1978a7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.insert_noise.md index f907d1624eb..ba98e295c3c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.remap_noise_model.md index 02927d984ec..1ac257dc970 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.26/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.md index 26dc5dfdbfe..cd3623b8d65 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.md index 900892fec4d..d272271dfb7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerjob.py "view source code") BasicAerJob class. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.md index 9699d9c1257..3550986bee5 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerprovider.py "view source code") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.md index b2b8eeca532..76b892ef2a4 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/qasm_simulator.py "view source code") Python implementation of a qasm simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 07fef07a999..f4072c4562b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/statevector_simulator.py "view source code") Python statevector simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.md index 2d92a797b2c..a90d1e8bdd0 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.26/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/unitary_simulator.py "view source code") Python implementation of a unitary simulator. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.md index 89c52e4d394..5c1920852b9 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/accountprovider.py "view source code") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.md index b32aeb14d3b..069e96a94e9 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/backendjoblimit.py "view source code") Job limit for a backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index 370dad4fb46..d29d5599981 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index b77884dc10e..ccbcba11845 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 6ffe79690ab..be76bd81025 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 4f178b97f9b..572f5f9fccc 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.md index 662a82b3b18..bce6909d373 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 6a5d5433ea3..b36de5ed73f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md index 67be68ad63a..129950a0e69 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/ibmqbackend.py "view source code") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.md index 6109c7100a0..237d772e236 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 0c629e25767..6035e694d65 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.md index 806b3888cf3..2b704eec80f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.md index c12d5273bff..316aa4954af 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.md index 1d90cb6d6d1..511246e7fe1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.md index 55199fafab3..7f9b1ed6819 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.md index 61a436a897e..aacf166c30a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/ibmqfactory.py "view source code") Factory and account manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.md index 037af53d0af..c6ab08b50be 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.md index 565be883049..981de6fcf25 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runner_result.py "view source code") Result class for Qiskit Runtime program circuit-runner. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.md index 14046270d6d..6a0036d8a93 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/credentials.py "view source code") IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.md index c450daa2442..99c80a142e4 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 86c04ce3f11..54a5ed1f697 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 0b65864b9d0..d7dc4bdc1bd 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.md index 6d4ae92c0f0..f7cb48d3951 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.AnalysisResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult -`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None, verified=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") +`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None, verified=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") Class representing an analysis result for an experiment. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.md index 88783ce9429..303bce27ee7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.Experiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment -`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None, notes=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/experiment/experiment.py "view source code") +`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None, notes=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/experiment/experiment.py "view source code") Class representing an experiment. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.md index 76529366055..b792562a1c6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.experiment.ExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService -`ExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") +`ExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") Provides experiment related services. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.md index 0ca306a5e55..24050f2d188 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.md index 75519a5f263..f3733313f1e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.md index 875d35ea0a5..47adc460caa 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 65b20a1f585..107194237c1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index e6a9a86e852..354cda765f1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 5803b1a191b..db153f961b2 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.md index 0954dc13038..c192c4a2669 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.job_monitor.md index 4a6bee42aa3..cf2f4925e5b 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.least_busy.md index 17fae659fb1..a6c6188c0cb 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.md index 02ec05008c5..4a8e23ed976 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index bd00e6dfd64..f49ffffc237 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index c106282ddeb..a1508937139 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index c0a70251b96..16d88b622f7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index cba53a92042..e3539b0b8b6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 6d365ad4271..cf791706ccd 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index fdd9e627035..f87f4020f30 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.md index a4873bb8b3f..2637ccd5a12 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/managedjob.py "view source code") Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.md index 285599affe7..f053e318782 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/managedjobset.py "view source code") A set of managed jobs. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.md index 20605d248e2..b4eeffee71c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/managed/managedresults.py "view source code") Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.md index 72f5d53d6f3..f4c15327273 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.md index b81c02cfe13..5a904ef928f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.md index adcc62dbc0c..96fa44f2cff 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 7d71100b9b6..97e0946eb6e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.md index b9df1d3c7e2..f340d1a0a43 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Base class for a program backend. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.md index e68bc98ce79..22b712bb69c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Runtime job result decoder. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.md index 8ec938a35fd..d20e700793f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, ws_client, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, ws_client, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 641d55d85af..a5522e32daf 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Class representing program metadata. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.md index 0f5f0ec5f53..427f88271a7 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.seconds_to_duration.md index e2eaf3e95d5..ef4205fe89f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.to_python_identifier.md index a0be117e2f1..e6743a20ce1 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.update_qobj_config.md index ba1d3e15fc8..ab710da2925 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.utc_to_local.md index eeb21cfbaa6..872f9cd8c4e 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.validate_job_tags.md index d85df06a790..0571ba2b6ad 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.13/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.md index ea62d3e3e9f..ae999514881 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Backwards compat shim representing an abstract backend configuration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.md index 394373d8a47..3fd560ff7ed 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendproperties.py "view source code") Class representing backend properties diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.md index d85c5bfb269..0162db0c57f 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendstatus.py "view source code") Class representing Backend Status. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.Command.md b/docs/api/qiskit/0.26/qiskit.providers.models.Command.md index 46b89d29b8f..a8bfdc69fd6 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") Class representing a Command. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.md index 28f63b0af7f..de21daf0e6c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Gate Configuration diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.md index 2d6c9ffb6eb..aceea0dcb19 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/jobstatus.py "view source code") Model for JobStatus. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md index cf2ea888aa3..17d320ba57c 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.md index 146cc3cfce6..d418bf7c7ee 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.md index a70a0a1e70d..7ac17865809 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Qasm Backend Configuration. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.md index d0d3331c6ba..4d99722c34a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a U Channel LO diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md index 72f12354374..39b4110e664 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md index 7104f339ff5..bf6db5b03f0 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Call.md b/docs/api/qiskit/0.26/qiskit.pulse.Call.md index bdb134c5aec..9b1a7864064 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Constant.md b/docs/api/qiskit/0.26/qiskit.pulse.Constant.md index 7474845609c..8b8c72b4d5f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md index 5dea4fbfbd8..3583ff4c728 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Delay.md b/docs/api/qiskit/0.26/qiskit.pulse.Delay.md index a6331b59ac3..fbb8e8a4d5c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Drag.md b/docs/api/qiskit/0.26/qiskit.pulse.Drag.md index fa3d4820342..0b527cd4eb5 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md index 6e0feba01f1..abf5ca2fecb 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.md index 12ff45af77e..cc6646f4c59 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.md index b1db30256f6..1dbc14c0087 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md index 2c84e0a3425..f2fa53f4979 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.md index 8bd186075b4..b7dee2415fb 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instruction_schedule_map.py "view source code") Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md index 9d661b317d8..04b0993759d 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md index 0ef342e2e8e..23dfdad04f2 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Play.md b/docs/api/qiskit/0.26/qiskit.pulse.Play.md index 8291004209c..915c362b404 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.26/qiskit.pulse.PulseError.md index 963cd6c9685..12d2af8c9ee 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md index 7a8e1fca2fa..e72deb06365 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md index 9b92cfab1ab..174f2546abf 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md index 5164eaef864..8be0481bc9d 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md index 3df4a86fda5..64c589e200c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md index 1aceeec1749..d1cbc30559f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md index 33c38b6d65b..5c16a6d85a7 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md index 8cb59125556..df8548a4aed 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md index a94951dbe72..f969c52c4ce 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.26/qiskit.pulse.Waveform.md index 8914ca0321b..4c1416c3b75 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md index ba6fd3cb433..9df544b6074 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md index d5543331cb8..7426c83d45b 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.active_backend.md index 6e7d992cf44..cda31c0584e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 7514aade0a3..da3c358f83c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.active_transpiler_settings.md index a930c6dfa06..4aaa72f577a 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_equispaced.md index af779391006..cee23310d21 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_func.md index c8d267ff857..fadb32b2fac 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_left.md index 9dc6b03b3a0..688e95bcae9 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_right.md index 11f05cb8223..e9af2d88da4 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_sequential.md index 92e6a3b4a8c..b4e78bb7c96 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md index 3a7c88ca5df..5e1b78eb817 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.build.md index e79e8c0c309..25cae57b603 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.call.md index 23123ce373d..e687ce5a30a 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.circuit_scheduler_settings.md index fbd0dd14a3f..adc1d755097 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md index fbe9d517782..c061c8919a0 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.cx.md index 28d0ac24d19..123b1a5d4f0 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md index 4f61e2869d0..cd38cd2c003 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.delay_qubits.md index 5260733e787..62e6cf4c68f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md index 830b1f50e7a..c432b1674a9 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md index d3f825feb9f..ba4b6d3dd2d 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.inline.md index 9eee0def1cc..f4cdbd312e3 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md index d172ff13c74..83a017ffcbe 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md index 1d3bf31c2ad..0bf66b239fb 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md index 3d2b1732509..c4f1a134858 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.num_qubits.md index 08e12f8e9a3..abc9f880d25 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md index 1a6ad5573bb..a0ba75ce432 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md index 772a71d232c..d194283075b 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md index a842a673bc8..449b66114d2 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md index f996b975818..2d1d3bc941f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.samples_to_seconds.md index 6070f10a697..3ae963be5fd 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.seconds_to_samples.md index 3a60cdecbb1..e39c80647b2 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md index 87e5b588b7b..1252859cc60 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md index c85e44c392f..ff27ecbcb98 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md index 58142ca9fbb..f542a55226f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md index 96eb4a67d7d..fa83897b4d9 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.snapshot.md index 2a3d4b14013..a867310092e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.transpiler_settings.md index 96faf4f5d07..4fd275e4e61 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.u1.md index baad5b5652b..c64da80352a 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.u2.md index f6b6308a9b5..cd42c6c18ea 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.u3.md index a0f420f64ef..ffb35a051b5 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.x.md index e745b3380e7..fed0e3109b2 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.channels.md b/docs/api/qiskit/0.26/qiskit.pulse.channels.md index e5222160a22..fc5f8e4afb5 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.channels.md @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. @@ -119,7 +119,7 @@ Parameters which determine the channel index. -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -216,7 +216,7 @@ A shorthand string prefix for characterizing the channel type. -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. @@ -301,7 +301,7 @@ Parameters which determine the channel index. -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. @@ -386,7 +386,7 @@ Parameters which determine the channel index. -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. @@ -471,7 +471,7 @@ Parameters which determine the channel index. -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. @@ -556,7 +556,7 @@ Parameters which determine the channel index. -`PulseChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`PulseChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Base class of transmit Channels. Pulses can be played on these channels. @@ -641,7 +641,7 @@ Parameters which determine the channel index. -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). @@ -726,7 +726,7 @@ Parameters which determine the channel index. -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md index 11fdb9167e5..e79404c2bf8 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md index 44d242dbb6f..f0eccf9901a 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md index dabc5660778..50cee606ea0 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md index 7cb7777c5d9..b990ff42a5e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md index dd53254d1da..67b13fa4fd4 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md index fe562941083..405372f8265 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md index 5a9fdb8ecc8..6aa92c81c51 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md index c1068485c86..8d21abe1d02 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md index b45bb0b93df..09c027cddd2 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md index 12fd63f17a1..31c52025356 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.md index c88f8591e55..d87aed08138 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.md index 54baca7dfd0..9b8e763699f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.md index 05fcfbf83ff..ec2c1e64472 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.md index d58bb1f5857..e514a61950e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.md index 13e95d0301a..4809ac760d3 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md index 4d8938de123..cdfa7c0f073 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md @@ -36,7 +36,7 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -60,7 +60,7 @@ $$ -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -86,7 +86,7 @@ $$ -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -121,7 +121,7 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -159,7 +159,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -186,7 +186,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -226,7 +226,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -274,7 +274,7 @@ plt.plot(range(duration), sawtooth_wave) -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -310,7 +310,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -337,7 +337,7 @@ i.e. the derivative of $\text{sech}$. -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -363,7 +363,7 @@ $$ -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -391,7 +391,7 @@ with the convention $\text{sign}(0) = 1$. -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -439,7 +439,7 @@ plt.plot(range(duration), triangle_wave) -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). diff --git a/docs/api/qiskit/0.26/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.26/qiskit.pulse.transforms.add_implicit_acquires.md index 4497fef18a6..eafa3ed254f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.26/qiskit.pulse.transforms.align_measures.md index 04563d745b3..4b364642e68 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md index c895d5da79f..b2b9d649213 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/alignments.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/alignments.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.md index 577e304c4c6..1a949167785 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.26/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.26/qiskit.qasm.Qasm.md index e92aff70902..a3054466f17 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.26/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.26/qiskit.qasm.QasmError.md index cac8b1467d8..eb8dbe90a96 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.26/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.md index d72e1a35777..ac3afb48e54 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.26/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.md index f10c4d80efe..90c2e68a134 100644 --- a/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.26/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.md index e642e5e4f4d..680063fad15 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.md index 4699723760b..7b93a15eac9 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") An item in a pulse library. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.md index b031efa6af3..be6c7177d15 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.md index 95c4a83c154..18ca521f7b3 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A configuration for a Pulse Qobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.md index 4f4c90e8843..58045890a6e 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj Experiment. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.md index 37f59007662..f91ee4d1e56 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A config for a single Pulse experiment in the qobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.md index ded4d145766..15cd2341326 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A class representing a single instruction in an PulseQobj Experiment. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.md index 80ec0d1289c..4165f68b66a 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.md index 052bb4cfc8d..7290308a586 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.md index 342dc1b709f..d48dbd8d6e3 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A configuration for a QASM Qobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.md index 297965a8b59..553f6b6c3ce 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj Experiment. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.md index a74860268c0..e089a77c448 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") Configuration for a single QASM experiment in the qobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.md index 72c03b88672..ac64386d7ed 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A class representing a single instruction in an QasmQobj Experiment. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.26/qiskit.qobj.Qobj.md index ea560eb0bb9..b39646c58d9 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/__init__.py "view source code") A backwards compat alias for QasmQobj. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.md index 1169160923b..f4fb4e7db1c 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") A class representing a header dictionary for a Qobj Experiment. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.md index 923edaf5803..99480072acf 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") A class used to represent a dictionary header in Qobj objects. diff --git a/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.md index 47546c0bc50..caf01b74ce2 100644 --- a/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.26/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") An individual measurement option. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.md index 21ee5413aa0..7a09e6144e2 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.md index 3cfbe75f58e..73a64eb2745 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/chi.py "view source code") Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.md index ace84d19b8f..7491103a135 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/choi.py "view source code") Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.md index 50a0f218b26..762bb0793a2 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") An N-qubit unitary operator from the Clifford group. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.md index dbfa795c218..0356f840ec8 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/densitymatrix.py "view source code") DensityMatrix class diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.md index 37e0ffcc6b8..67d26ec0284 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/kraus.py "view source code") Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.md index 8b94c23432e..05260b2d294 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.md index f3da2c57373..70fabbff5c6 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/operator.py "view source code") Matrix operator class diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.md index f2a553262a6..18dc0fea2a0 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/ptm.py "view source code") Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.md index 83c2e430dd0..3964c9d3d2f 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") N-qubit Pauli operator. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.md index 0ba73e53c35..acee8940dab 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Symplectic representation of a list Pauli matrices. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.md index 9d2734306fd..0f5f3c4e182 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/quaternion.py "view source code") A class representing a Quaternion. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.md index 6baec9a8335..44a3fc8cd1f 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/scalar_op.py "view source code") Scalar identity operator class. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.md index 78e6e5b8fcc..ad2b9bd9b6b 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sparse N-qubit operator in a Pauli basis representation. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.md index e0aabcfaceb..1b1a03ffe82 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Symplectic representation of a list Stabilizer matrices. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.md index 7f28b42d06f..0225c1ce651 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/statevector.py "view source code") Statevector class diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.md index 2472ecd971c..68c7f943c83 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.md index 6a0e4908b36..c3166c4c81e 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/superop.py "view source code") Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.md index fb4377a4923..4c4295fe82c 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.26/qiskit.quantum_info.average_gate_fidelity.md index 6d802aa7e1d..56e7e824816 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.26/qiskit.quantum_info.concurrence.md index 0765a817535..b426d9b3af1 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.26/qiskit.quantum_info.decompose_clifford.md index c8804c3188a..0bf0adb7d41 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.26/qiskit.quantum_info.diamond_norm.md index 183c70efb46..4b84c406c65 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.26/qiskit.quantum_info.entanglement_of_formation.md index 5d163f29f8a..451f890c196 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.26/qiskit.quantum_info.entropy.md index 7b0d105badb..938ad61e35c 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.26/qiskit.quantum_info.gate_error.md index 99d1a977ccc..e3c8fe2af31 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_distance.md index a337c6e0b7b..3fb0288ea24 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_fidelity.md index 7d32bfd9a21..bd6add15b9c 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.26/qiskit.quantum_info.mutual_information.md index 1caa0026154..72278bad311 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.26/qiskit.quantum_info.partial_trace.md index 1de7483f21b..8e3f1cf72dc 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_basis.md index 4aec52700e1..4794a2f838f 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_group.md index 34f566a176a..662a1d1bf90 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.26/qiskit.quantum_info.process_fidelity.md index 6be1eea06f7..ed367d74b3a 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.26/qiskit.quantum_info.purity.md index b67ea5ceaaf..d2407bd278e 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_clifford.md index 183e81f082c..c72131715a0 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_cnotdihedral.md index 0800959cdfb..8efd92543e1 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_density_matrix.md index c0bb5d0fe00..e684fa5f943 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_hermitian.md index 85f3e768c34..6d129ca5e65 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli.md index 3f22c443a65..194e2c8b8a5 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli_table.md index d5749747b63..2f0e987fcab 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_quantum_channel.md index 6638cdb0369..8807c0758cc 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_stabilizer_table.md index 314ab85ee58..a1a255afefa 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_statevector.md index 594a72133b6..c32e5e40c69 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.26/qiskit.quantum_info.random_unitary.md index a12d83dd53b..cdd50970c44 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.26/qiskit.quantum_info.shannon_entropy.md index d56cdea5872..0e2496c4305 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.26/qiskit.quantum_info.state_fidelity.md index 2075c83b415..92873e95470 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.26/qiskit.result.Counts.md b/docs/api/qiskit/0.26/qiskit.result.Counts.md index e914d0778f8..f8bf252ec42 100644 --- a/docs/api/qiskit/0.26/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.26/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/counts.py "view source code") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.md index 4dcba914422..fa446f5369d 100644 --- a/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/probability.py "view source code") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.md index c847bd95c4a..b8cd78d2509 100644 --- a/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.26/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/quasi.py "view source code") A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.26/qiskit.result.Result.md b/docs/api/qiskit/0.26/qiskit.result.Result.md index a628eba78cd..ae800b31d55 100644 --- a/docs/api/qiskit/0.26/qiskit.result.Result.md +++ b/docs/api/qiskit/0.26/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/result.py "view source code") Model for Results. diff --git a/docs/api/qiskit/0.26/qiskit.result.ResultError.md b/docs/api/qiskit/0.26/qiskit.result.ResultError.md index 2fcba4e322e..70502831c76 100644 --- a/docs/api/qiskit/0.26/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.26/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.26/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.26/qiskit.result.marginal_counts.md index 37c3ed5dd6d..953bed88628 100644 --- a/docs/api/qiskit/0.26/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.26/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.md index 96d2e2cb083..932b7c25a7e 100644 --- a/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.26/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md index 27cd8d0ce83..b370a2d7fbf 100644 --- a/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md @@ -23,7 +23,7 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat -`as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") +`as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. @@ -48,7 +48,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as late as -`as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") +`as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. diff --git a/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md index 1b7bc625d39..b811d97cb7c 100644 --- a/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md @@ -22,7 +22,7 @@ QuantumCircuit to Pulse scheduler. -`schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/schedule_circuit.py "view source code") +`schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. diff --git a/docs/api/qiskit/0.26/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.26/qiskit.tools.backend_monitor.md index d8413988e30..e153df4e07c 100644 --- a/docs/api/qiskit/0.26/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.26/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.26/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.26/qiskit.tools.backend_overview.md index e8c072870e2..5d4e4bf27aa 100644 --- a/docs/api/qiskit/0.26/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.26/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.26/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.26/qiskit.tools.job_monitor.md index 53be7b012a3..ec20a90e14b 100644 --- a/docs/api/qiskit/0.26/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.26/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.26/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.26/qiskit.tools.parallel_map.md index 8362d37af51..de590d737ce 100644 --- a/docs/api/qiskit/0.26/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.26/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.md index 5ba9f81b695..05f8ef60db6 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") An analysis pass: change property set, not DAG. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.md index dcd406965db..380659e6ca3 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/coupling.py "view source code") Directed graph specifying fixed coupling. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.md index e0db537efff..00c4c506e69 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.md index 420c65e728b..8b1c6bbbb87 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.md index 97ba461b0cc..87315fa24f0 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/runningpassmanager.py "view source code") Base class for multiple types of working list. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.md index 7b1de2f94d1..fc12c6d4463 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/instruction_durations.py "view source code") Helper class to provide durations of instructions for scheduling. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.26/qiskit.transpiler.Layout.md index 849af2cfa5b..a6a7062cfea 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/layout.py "view source code") Two-ways dict to represent a Layout. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.md index 086f6fa3ee3..b8825c5f152 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager.py "view source code") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.md index b54a78bd521..1439f488321 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager_config.py "view source code") Pass Manager Configuration. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.md index 748e5bc3f42..d4b58c29788 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/propertyset.py "view source code") A default dictionary-like object diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.md index e7cd7afeacc..76b475b5aed 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") A transformation pass: change DAG, not property set. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.md index 5fe8c1c6b20..6d321be3562 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.md index f6851bc33f9..98ed4cf78f8 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.md index 57c2ca55996..863c90d0d02 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/alap.py "view source code") ALAP Scheduling. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.md index 8adfcf17a68..2673143baf5 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/asap.py "view source code") ASAP Scheduling. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.md index 66453a91d79..0164a2c6389 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 2589a9b19ff..242ea824c24 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.md index eab63ae6252..7a107f1916b 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.md index 97a705f523e..aba0e636db1 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.md index aae7f08e35f..d896b32f826 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py "view source code") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.md index 88bf08911a1..513e93c2cc1 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.md index 1f31a15142e..a3691654e3a 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.md index d7e48675c31..987b6162d2d 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.md index 259a53186b0..4815eb08c0d 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.md index 2aa05b12680..c4c3e29b36c 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_map.py "view source code") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.md index 4366ab0460f..1f92d4d239d 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.md index 21036dccbf0..69dd13326a7 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.md index 87309fe9123..affe7e85d1f 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.md index d66525efafa..babd5857bbd 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.md index fd077e9b630..9e4f3d33ce0 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.md index d908982a246..cdde9254b01 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 565d067b9e3..920f77263db 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.md index a08754653c1..e8651bfb5d8 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.md index 64e90906592..505acb020ee 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.md index 2ae375b2461..32e27f7a467 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/decompose.py "view source code") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.md index 3cb1aba1946..75b09f55813 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.md index 5b716a41e99..6f7705b43d5 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/depth.py "view source code") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.md index 087cd389943..356a0b70e61 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.md index c73c3af2ab6..5445accb222 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.md index 91cb7ff4408..4605c389f53 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Allocate all idle nodes from the coupling map as ancilla on the layout. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.md index 65b936f52a4..295d98c78b9 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.md index bf9afe6a941..d8da88518cd 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.md index 245f35f2f60..462bab7d5ab 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 17add1c0022..34dfe1667e2 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index a7779eda46b..c5e6cc8b8da 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.md index 495ddf5b8a9..a1d055f3d1e 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.md index a057a25a2b0..6882e338c56 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index de374af8d9a..9efb0f64c49 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.md index cb32e7ff424..c24cbe73038 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 67aba62b64b..87e0b4a5da1 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.md index e5e1b76caa6..9603449047c 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.md index b89d8b46fbe..e838547475c 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.md index 0f2e08b8fef..252299e05ee 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.md index 18c9a91e65a..c05329fb42a 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.md index 00d8827a66a..7d4a23d7fe8 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/set_layout.py "view source code") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.md index 4b368cc7029..5e26cc4e89b 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/size.py "view source code") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.md index b7c38858bc0..f747a700531 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.md index b7cda6673ba..45d9f76c88e 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.md index c52dfd598b4..8c2df4eefe3 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.md index 4b0e2a3342f..7a35a7886a2 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.md index e186403129e..fd98b3af5ea 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.md index bf95016280b..577b967e57e 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.md index 9daf803930e..6b9b00b0f15 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroller.py "view source code") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.md index c359f02ff34..a9d5d40c28c 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/width.py "view source code") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index f1c559abbb1..4704fd2a77d 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 7c6a854c908..f316da9448f 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 73e3c35178e..d474d9db6a3 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index c4f7ea3a027..d0d211473c7 100644 --- a/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.26/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.md index 8bda33ba7ad..1eaf1e27566 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.26/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.26/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.26/qiskit.utils.apply_prefix.md index e1a21283e3c..a2e0412392a 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.26/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.26/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.26/qiskit.utils.deprecate_arguments.md index beef229b5e7..946438f30b3 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.26/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.26/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.26/qiskit.utils.deprecate_function.md index 3d4cd31040b..25307ea72d3 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.26/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.26/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.26/qiskit.utils.get_entangler_map.md index 5955ba2b9db..79f19231eac 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.26/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.26/qiskit.utils.has_aer.md b/docs/api/qiskit/0.26/qiskit.utils.has_aer.md index cc0af41aebd..ef60c5839f9 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.26/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.26/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.26/qiskit.utils.has_ibmq.md index 79af8d8f31a..a1c46b7b40b 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.26/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.26/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.26/qiskit.utils.is_main_process.md index 7f1b0a64d19..b25c5a29882 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.26/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.26/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.26/qiskit.utils.local_hardware_info.md index b07303b2156..d6c47db28aa 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.26/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.26/qiskit.utils.name_args.md b/docs/api/qiskit/0.26/qiskit.utils.name_args.md index a3c5cb59400..6fbf128f4a8 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.26/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.26/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.26/qiskit.utils.summarize_circuits.md index 8cd4d5b973f..03b31d82a19 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.26/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.26/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.26/qiskit.utils.validate_entangler_map.md index de6cf9bce13..a4bd4f0a6e0 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.26/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.md index ef32933e75b..dfbedd852a0 100644 --- a/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.26/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.26/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.26/qiskit.validation.jsonschema.validate_json_against_schema.md index 9433c912dd0..9aad9cfb8d7 100644 --- a/docs/api/qiskit/0.26/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.26/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.md index 78e1a473a49..f3611d669bf 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.26/qiskit.visualization.array_to_latex.md index 5550e0ceec0..ded76053b0b 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.26/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.26/qiskit.visualization.circuit_drawer.md index 71a1d5e6416..11666ef91db 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.26/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.26/qiskit.visualization.dag_drawer.md index 091a0b36491..89b8bdc40e9 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.26/qiskit.visualization.pass_manager_drawer.md index c8695d1bd56..4174720f188 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_multivector.md index 55255d99ebf..0a23a95d4aa 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_vector.md index 45d8f0e3090..28c4a368785 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_circuit_layout.md index 7d0a45885d5..1940c9497ca 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_error_map.md index a2ef9bd1d71..23068784f6c 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_gate_map.md index c7a5f8d9689..25e195a0948 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_histogram.md index be6e0345a81..d2ec95d88a6 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_city.md index 38a44cce086..749c9fb778b 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_hinton.md index 5fa35cf63ef..af039e96a44 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_paulivec.md index e060f57cae3..9b586d8d24c 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_qsphere.md index 5a1ae6c49ef..c886f7d44ec 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.md index bd30d0b8511..fcf7d067917 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.md index 366c64f3f18..c5d1f49e6d8 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.md index 57ab433773b..5e11e2c50f1 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md index b4e9777903d..74317ed7cfb 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.md index 92419a554ef..b6c1487a8e2 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/qcstyle.py "view source code") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.26/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.26/qiskit.visualization.timeline.draw.md index 62cd7a5840f..2c00f9c14f0 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.26/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.26/qiskit.visualization.visualize_transition.md index cfaf5429544..a1f06a92596 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 86f3c59ad04dddfbcac55fd340bab3a72a9c273e Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:19:08 +0100 Subject: [PATCH 08/41] Regenerate qiskit 0.27.0 --- docs/api/qiskit/0.27/execute.md | 2 +- docs/api/qiskit/0.27/logging.md | 2 +- .../0.27/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.27/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.27/qiskit.algorithms.Grover.md | 2 +- .../0.27/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.27/qiskit.algorithms.HHL.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- .../0.27/qiskit.algorithms.LinearSolver.md | 2 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.algorithms.NumPyLinearSolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.27/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.27/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.27/qiskit.algorithms.Shor.md | 2 +- .../0.27/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.27/qiskit.algorithms.VQE.md | 2 +- .../0.27/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.27/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.27/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.27/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.27/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.27/qiskit.algorithms.optimizers.GSLS.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.27/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.27/qiskit.algorithms.optimizers.SPSA.md | 2 +- .../0.27/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.27/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.27/qiskit.aqua.QuantumInstance.md | 2 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 2 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 2 +- ...ua.algorithms.AmplitudeEstimationResult.md | 2 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 2 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 2 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 2 +- .../qiskit/0.27/qiskit.aqua.algorithms.EOH.md | 2 +- .../qiskit.aqua.algorithms.Eigensolver.md | 2 +- ...iskit.aqua.algorithms.EigensolverResult.md | 2 +- .../0.27/qiskit.aqua.algorithms.Grover.md | 2 +- .../qiskit.aqua.algorithms.GroverResult.md | 2 +- .../qiskit/0.27/qiskit.aqua.algorithms.HHL.md | 2 +- .../0.27/qiskit.aqua.algorithms.HHLResult.md | 2 +- .../0.27/qiskit.aqua.algorithms.IQPE.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.LinearsolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 2 +- ...qua.algorithms.MinimumEigensolverResult.md | 2 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 2 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.27/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.27/qiskit.aqua.algorithms.QGAN.md | 2 +- .../qiskit/0.27/qiskit.aqua.algorithms.QPE.md | 2 +- .../0.27/qiskit.aqua.algorithms.QSVM.md | 2 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 2 +- .../0.27/qiskit.aqua.algorithms.Shor.md | 2 +- .../0.27/qiskit.aqua.algorithms.Simon.md | 2 +- .../0.27/qiskit.aqua.algorithms.SklearnSVM.md | 2 +- .../qiskit/0.27/qiskit.aqua.algorithms.VQC.md | 2 +- .../qiskit/0.27/qiskit.aqua.algorithms.VQE.md | 2 +- .../qiskit/0.27/qiskit.aqua.circuits.CNF.md | 2 +- .../qiskit/0.27/qiskit.aqua.circuits.DNF.md | 2 +- .../qiskit/0.27/qiskit.aqua.circuits.ESOP.md | 2 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 2 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 2 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 2 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 2 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 2 +- ...aqua.components.feature_maps.FeatureMap.md | 2 +- ...omponents.feature_maps.RawFeatureVector.md | 2 +- ...t.aqua.components.initial_states.Custom.md | 2 +- ....components.initial_states.InitialState.md | 2 +- ....components.initial_states.VarFormBased.md | 2 +- ...kit.aqua.components.initial_states.Zero.md | 2 +- ...mponents.multiclass_extensions.AllPairs.md | 2 +- ...lticlass_extensions.ErrorCorrectingCode.md | 2 +- ...lticlass_extensions.MulticlassExtension.md | 2 +- ...ts.multiclass_extensions.OneAgainstRest.md | 2 +- ...s.neural_networks.DiscriminativeNetwork.md | 2 +- ...nents.neural_networks.GenerativeNetwork.md | 2 +- ...ents.neural_networks.NumPyDiscriminator.md | 2 +- ...ts.neural_networks.PyTorchDiscriminator.md | 2 +- ...onents.neural_networks.QuantumGenerator.md | 2 +- .../qiskit.aqua.components.optimizers.ADAM.md | 2 +- .../qiskit.aqua.components.optimizers.AQGD.md | 2 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 2 +- .../qiskit.aqua.components.optimizers.CG.md | 2 +- ...iskit.aqua.components.optimizers.COBYLA.md | 2 +- .../qiskit.aqua.components.optimizers.CRS.md | 2 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 2 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 2 +- .../qiskit.aqua.components.optimizers.ESCH.md | 2 +- .../qiskit.aqua.components.optimizers.GSLS.md | 2 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 2 +- ...qiskit.aqua.components.optimizers.ISRES.md | 2 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 2 +- ....aqua.components.optimizers.NELDER_MEAD.md | 2 +- .../qiskit.aqua.components.optimizers.NFT.md | 2 +- ...it.aqua.components.optimizers.Optimizer.md | 2 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 2 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 2 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 2 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 2 +- .../qiskit.aqua.components.optimizers.SPSA.md | 2 +- .../qiskit.aqua.components.optimizers.TNC.md | 2 +- ....components.oracles.CustomCircuitOracle.md | 2 +- ...ponents.oracles.LogicalExpressionOracle.md | 2 +- .../qiskit.aqua.components.oracles.Oracle.md | 2 +- ...qua.components.oracles.TruthTableOracle.md | 2 +- ...qua.components.reciprocals.LongDivision.md | 2 +- ...a.components.reciprocals.LookupRotation.md | 2 +- ....aqua.components.reciprocals.Reciprocal.md | 2 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 2 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 2 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 2 +- ...els.MultivariateVariationalDistribution.md | 2 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 2 +- ....uncertainty_models.UniformDistribution.md | 2 +- ...certainty_models.UnivariateDistribution.md | 2 +- ...odels.UnivariateVariationalDistribution.md | 2 +- ...ncertainty_problems.MultivariateProblem.md | 2 +- ...uncertainty_problems.UncertaintyProblem.md | 2 +- ...lems.UnivariatePiecewiseLinearObjective.md | 2 +- ....uncertainty_problems.UnivariateProblem.md | 2 +- ...nents.variational_forms.VariationalForm.md | 2 +- .../qiskit.aqua.operators.OperatorBase.md | 2 +- ...qua.operators.converters.AbelianGrouper.md | 2 +- ...qua.operators.converters.CircuitSampler.md | 2 +- ...aqua.operators.converters.ConverterBase.md | 2 +- ...a.operators.converters.DictToCircuitSum.md | 2 +- ...a.operators.converters.PauliBasisChange.md | 2 +- ...aqua.operators.evolutions.EvolutionBase.md | 2 +- ...a.operators.evolutions.EvolutionFactory.md | 2 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 2 +- ...ua.operators.evolutions.MatrixEvolution.md | 2 +- ...rators.evolutions.PauliTrotterEvolution.md | 2 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 2 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 2 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 2 +- ...rators.evolutions.TrotterizationFactory.md | 2 +- ...rators.expectations.AerPauliExpectation.md | 2 +- ....operators.expectations.CVaRExpectation.md | 2 +- ....operators.expectations.ExpectationBase.md | 2 +- ...erators.expectations.ExpectationFactory.md | 2 +- ...perators.expectations.MatrixExpectation.md | 2 +- ...operators.expectations.PauliExpectation.md | 2 +- ...qua.operators.gradients.CircuitGradient.md | 2 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 2 +- ...aqua.operators.gradients.DerivativeBase.md | 2 +- ...iskit.aqua.operators.gradients.Gradient.md | 2 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 2 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 2 +- .../qiskit.aqua.operators.gradients.QFI.md | 2 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 2 +- ...it.aqua.operators.legacy.MatrixOperator.md | 2 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 2 +- ....operators.legacy.WeightedPauliOperator.md | 2 +- ...skit.aqua.operators.legacy.Z2Symmetries.md | 2 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 2 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 2 +- ...qiskit.aqua.operators.list_ops.SummedOp.md | 2 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 2 +- ....aqua.operators.primitive_ops.CircuitOp.md | 2 +- ...t.aqua.operators.primitive_ops.MatrixOp.md | 2 +- ...it.aqua.operators.primitive_ops.PauliOp.md | 2 +- ...qua.operators.primitive_ops.PrimitiveOp.md | 2 +- ...qua.operators.state_fns.CVaRMeasurement.md | 2 +- ...aqua.operators.state_fns.CircuitStateFn.md | 2 +- ...it.aqua.operators.state_fns.DictStateFn.md | 2 +- ...qua.operators.state_fns.OperatorStateFn.md | 2 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 2 +- ....aqua.operators.state_fns.VectorStateFn.md | 2 +- .../0.27/qiskit.aqua.utils.CircuitFactory.md | 2 +- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.27/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.27/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.27/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.27/qiskit.aqua.utils.name_args.md | 2 +- .../0.27/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.27/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.27/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.27/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.27/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.27/qiskit.assembler.RunConfig.md | 2 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.27/qiskit.assembler.disassemble.md | 2 +- .../0.27/qiskit.chemistry.BosonicOperator.md | 2 +- .../qiskit.chemistry.FermionicOperator.md | 2 +- .../qiskit/0.27/qiskit.chemistry.MP2Info.md | 2 +- .../qiskit/0.27/qiskit.chemistry.QMolecule.md | 2 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 2 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 2 +- ...chemistry.algorithms.EigensolverFactory.md | 2 +- ...try.algorithms.ExcitedStatesEigensolver.md | 2 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 2 +- ...istry.algorithms.GroundStateEigensolver.md | 2 +- ....chemistry.algorithms.GroundStateSolver.md | 2 +- ...ry.algorithms.MinimumEigensolverFactory.md | 2 +- ...stry.algorithms.NumPyEigensolverFactory.md | 2 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 2 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 2 +- .../0.27/qiskit.chemistry.algorithms.QEOM.md | 2 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 2 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 2 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 2 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 2 +- ...s.pes_samplers.DifferentialExtrapolator.md | 2 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 2 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 2 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 2 +- ...gorithms.pes_samplers.HarmonicPotential.md | 2 +- ....algorithms.pes_samplers.MorsePotential.md | 2 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 2 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 2 +- ...y.algorithms.pes_samplers.PotentialBase.md | 2 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 2 +- ...thms.pes_samplers.VibronicStructureBase.md | 2 +- ...orithms.pes_samplers.WindowExtrapolator.md | 2 +- ...applications.MolecularGroundStateEnergy.md | 2 +- ...y.components.bosonic_bases.BosonicBasis.md | 2 +- ....components.bosonic_bases.HarmonicBasis.md | 2 +- ...y.components.initial_states.HartreeFock.md | 2 +- ...hemistry.components.initial_states.VSCF.md | 2 +- ...mistry.components.variational_forms.CHC.md | 2 +- ...stry.components.variational_forms.UCCSD.md | 2 +- ...istry.components.variational_forms.UVCC.md | 2 +- ...qiskit.chemistry.core.ChemistryOperator.md | 2 +- .../0.27/qiskit.chemistry.core.Hamiltonian.md | 2 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 2 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 2 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 2 +- ...iskit.chemistry.drivers.FermionicDriver.md | 2 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 2 +- ....chemistry.drivers.GaussianForcesDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogResult.md | 2 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 2 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.27/qiskit.chemistry.drivers.Molecule.md | 2 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 2 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 2 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 2 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 2 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 2 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 2 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 2 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 2 +- .../0.27/qiskit.circuit.AncillaQubit.md | 2 +- .../0.27/qiskit.circuit.AncillaRegister.md | 2 +- .../0.27/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.27/qiskit.circuit.Clbit.md | 2 +- .../0.27/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.27/qiskit.circuit.Delay.md | 2 +- .../0.27/qiskit.circuit.EquivalenceLibrary.md | 2 +- docs/api/qiskit/0.27/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.27/qiskit.circuit.Instruction.md | 2 +- .../0.27/qiskit.circuit.InstructionSet.md | 2 +- .../api/qiskit/0.27/qiskit.circuit.Measure.md | 2 +- .../qiskit/0.27/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.27/qiskit.circuit.ParameterVector.md | 2 +- .../0.27/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.27/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.27/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.27/qiskit.circuit.Reset.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.AND.md | 2 +- .../0.27/qiskit.circuit.library.Barrier.md | 2 +- .../0.27/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.27/qiskit.circuit.library.C3XGate.md | 2 +- .../0.27/qiskit.circuit.library.C4XGate.md | 2 +- .../0.27/qiskit.circuit.library.CCXGate.md | 2 +- .../0.27/qiskit.circuit.library.CHGate.md | 2 +- .../0.27/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.27/qiskit.circuit.library.CRXGate.md | 2 +- .../0.27/qiskit.circuit.library.CRYGate.md | 2 +- .../0.27/qiskit.circuit.library.CRZGate.md | 2 +- .../0.27/qiskit.circuit.library.CSXGate.md | 2 +- .../0.27/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.27/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.27/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.27/qiskit.circuit.library.CUGate.md | 2 +- .../0.27/qiskit.circuit.library.CXGate.md | 2 +- .../0.27/qiskit.circuit.library.CYGate.md | 2 +- .../0.27/qiskit.circuit.library.CZGate.md | 2 +- .../0.27/qiskit.circuit.library.DCXGate.md | 2 +- .../0.27/qiskit.circuit.library.Diagonal.md | 2 +- .../0.27/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.GRZ.md | 2 +- .../0.27/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.27/qiskit.circuit.library.HGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.27/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.27/qiskit.circuit.library.MCMT.md | 2 +- .../0.27/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.27/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.27/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.27/qiskit.circuit.library.MSGate.md | 2 +- .../0.27/qiskit.circuit.library.Measure.md | 2 +- .../0.27/qiskit.circuit.library.NLocal.md | 2 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.27/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.27/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.27/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.27/qiskit.circuit.library.RCCXGate.md | 2 +- .../0.27/qiskit.circuit.library.RGate.md | 2 +- .../0.27/qiskit.circuit.library.RVGate.md | 2 +- .../0.27/qiskit.circuit.library.RXGate.md | 2 +- .../0.27/qiskit.circuit.library.RXXGate.md | 2 +- .../0.27/qiskit.circuit.library.RYGate.md | 2 +- .../0.27/qiskit.circuit.library.RYYGate.md | 2 +- .../0.27/qiskit.circuit.library.RZGate.md | 2 +- .../0.27/qiskit.circuit.library.RZXGate.md | 2 +- .../0.27/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.27/qiskit.circuit.library.Reset.md | 2 +- .../0.27/qiskit.circuit.library.SGate.md | 2 +- .../0.27/qiskit.circuit.library.SXGate.md | 2 +- .../0.27/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.27/qiskit.circuit.library.SdgGate.md | 2 +- .../0.27/qiskit.circuit.library.SwapGate.md | 2 +- .../0.27/qiskit.circuit.library.TGate.md | 2 +- .../0.27/qiskit.circuit.library.TdgGate.md | 2 +- .../0.27/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.27/qiskit.circuit.library.U1Gate.md | 2 +- .../0.27/qiskit.circuit.library.U2Gate.md | 2 +- .../0.27/qiskit.circuit.library.U3Gate.md | 2 +- .../0.27/qiskit.circuit.library.UGate.md | 2 +- ...kit.circuit.library.UniformDistribution.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.27/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.27/qiskit.circuit.library.XOR.md | 2 +- .../0.27/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.27/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.27/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.27/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.27/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.27/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.27/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.27/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.27/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.27/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.27/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.27/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.27/qiskit.compiler.transpile.md | 2 +- .../0.27/qiskit.converters.ast_to_dag.md | 2 +- .../0.27/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.27/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.27/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.27/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.27/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.27/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.27/qiskit.dagcircuit.DAGDependency.md | 2 +- .../qiskit/0.27/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.27/qiskit.extensions.HamiltonianGate.md | 2 +- .../0.27/qiskit.extensions.Initialize.md | 2 +- .../qiskit/0.27/qiskit.extensions.Snapshot.md | 2 +- .../0.27/qiskit.extensions.UnitaryGate.md | 2 +- .../0.27/qiskit.finance.QiskitFinanceError.md | 2 +- ...it.finance.applications.ising.portfolio.md | 10 +++---- ...cations.ising.portfolio_diversification.md | 6 ++--- ....uncertainty_problems.EuropeanCallDelta.md | 2 +- ...inty_problems.EuropeanCallExpectedValue.md | 2 +- ...ainty_problems.FixedIncomeExpectedValue.md | 2 +- ...finance.data_providers.BaseDataProvider.md | 2 +- ...nce.data_providers.DataOnDemandProvider.md | 2 +- ...nce.data_providers.ExchangeDataProvider.md | 2 +- ...nance.data_providers.RandomDataProvider.md | 2 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 2 +- ...inance.data_providers.YahooDataProvider.md | 2 +- ...t.ignis.characterization.AmpCalCXFitter.md | 2 +- ...kit.ignis.characterization.AmpCalFitter.md | 2 +- ...ignis.characterization.AngleCalCXFitter.md | 2 +- ...t.ignis.characterization.AngleCalFitter.md | 2 +- ...is.characterization.BaseCoherenceFitter.md | 2 +- ...t.ignis.characterization.BaseGateFitter.md | 2 +- ...iskit.ignis.characterization.DragFitter.md | 2 +- ...iskit.ignis.characterization.RabiFitter.md | 2 +- .../qiskit.ignis.characterization.T1Fitter.md | 2 +- .../qiskit.ignis.characterization.T2Fitter.md | 2 +- ...kit.ignis.characterization.T2StarFitter.md | 2 +- .../qiskit.ignis.characterization.ZZFitter.md | 2 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 2 +- .../0.27/qiskit.ignis.logging.IgnisLogger.md | 2 +- .../0.27/qiskit.ignis.logging.IgnisLogging.md | 2 +- ....ignis.measurement.DiscriminationFilter.md | 2 +- ...gnis.measurement.IQDiscriminationFitter.md | 2 +- ...ignis.measurement.LinearIQDiscriminator.md | 2 +- ...is.measurement.QuadraticIQDiscriminator.md | 2 +- ...gnis.measurement.SklearnIQDiscriminator.md | 2 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 2 +- ....mitigation.CompleteExpvalMeasMitigator.md | 2 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 2 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 2 +- ...skit.ignis.mitigation.MeasurementFilter.md | 2 +- ....mitigation.TensoredExpvalMeasMitigator.md | 2 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 2 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 2 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 2 +- ....ignis.verification.AccreditationFitter.md | 2 +- .../0.27/qiskit.ignis.verification.BConfig.md | 2 +- .../qiskit.ignis.verification.CNOTDihedral.md | 2 +- ...ignis.verification.CNOTDihedralRBFitter.md | 2 +- ...is.verification.GatesetTomographyFitter.md | 2 +- .../qiskit.ignis.verification.GraphDecoder.md | 2 +- ....ignis.verification.InterleavedRBFitter.md | 2 +- .../0.27/qiskit.ignis.verification.Plotter.md | 2 +- ...is.verification.ProcessTomographyFitter.md | 2 +- ...iskit.ignis.verification.PurityRBFitter.md | 2 +- .../0.27/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 2 +- .../qiskit.ignis.verification.RBFitter.md | 2 +- ...iskit.ignis.verification.RepetitionCode.md | 2 +- ...gnis.verification.StateTomographyFitter.md | 2 +- ...kit.ignis.verification.TomographyFitter.md | 2 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 2 +- .../0.27/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.27/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.27/qiskit.ml.datasets.digits.md | 2 +- .../0.27/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.27/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.27/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.27/qiskit.opflow.OperatorBase.md | 2 +- .../qiskit/0.27/qiskit.opflow.OpflowError.md | 2 +- .../0.27/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.27/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../0.27/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.27/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.27/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.27/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.27/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.27/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.27/qiskit.opflow.gradients.QFI.md | 2 +- .../0.27/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.27/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.27/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.27/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.27/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.27/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 2 +- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 2 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 2 +- ....optimization.algorithms.CplexOptimizer.md | 2 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 2 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 2 +- ...zation.algorithms.MinimumEigenOptimizer.md | 2 +- ...mization.algorithms.MultiStartOptimizer.md | 2 +- ...zation.algorithms.OptimizationAlgorithm.md | 2 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 2 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 2 +- ....optimization.algorithms.SolutionSample.md | 2 +- ....optimization.applications.ising.clique.md | 6 ++--- ....optimization.applications.ising.common.md | 12 ++++----- ...optimization.applications.ising.docplex.md | 2 +- ...mization.applications.ising.exact_cover.md | 6 ++--- ...tion.applications.ising.graph_partition.md | 6 ++--- ...ptimization.applications.ising.knapsack.md | 6 ++--- ...optimization.applications.ising.max_cut.md | 6 ++--- ...timization.applications.ising.partition.md | 4 +-- ...mization.applications.ising.set_packing.md | 6 ++--- ...imization.applications.ising.stable_set.md | 6 ++--- ...kit.optimization.applications.ising.tsp.md | 14 +++++----- ...tion.applications.ising.vehicle_routing.md | 8 +++--- ...ization.applications.ising.vertex_cover.md | 6 ++--- ...ization.converters.InequalityToEquality.md | 2 +- ...optimization.converters.IntegerToBinary.md | 2 +- ...tion.converters.LinearEqualityToPenalty.md | 2 +- ...on.converters.QuadraticProgramConverter.md | 2 +- ...ation.converters.QuadraticProgramToQubo.md | 2 +- ...qiskit.optimization.problems.Constraint.md | 2 +- ....optimization.problems.LinearConstraint.md | 2 +- ....optimization.problems.LinearExpression.md | 2 +- ...timization.problems.QuadraticConstraint.md | 2 +- ...timization.problems.QuadraticExpression.md | 2 +- ...ptimization.problems.QuadraticObjective.md | 2 +- ....optimization.problems.QuadraticProgram.md | 2 +- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 2 +- .../qiskit/0.27/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.27/qiskit.providers.BackendV1.md | 2 +- .../0.27/qiskit.providers.BaseBackend.md | 2 +- .../qiskit/0.27/qiskit.providers.BaseJob.md | 2 +- .../0.27/qiskit.providers.BaseProvider.md | 2 +- docs/api/qiskit/0.27/qiskit.providers.Job.md | 2 +- .../qiskit/0.27/qiskit.providers.JobError.md | 2 +- .../qiskit/0.27/qiskit.providers.JobStatus.md | 2 +- .../0.27/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.27/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.27/qiskit.providers.Options.md | 2 +- .../qiskit/0.27/qiskit.providers.Provider.md | 2 +- .../0.27/qiskit.providers.ProviderV1.md | 2 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.27/qiskit.providers.aer.AerError.md | 2 +- .../0.27/qiskit.providers.aer.AerJob.md | 2 +- .../0.27/qiskit.providers.aer.AerProvider.md | 2 +- .../0.27/qiskit.providers.aer.AerSimulator.md | 2 +- .../qiskit.providers.aer.PulseSimulator.md | 2 +- .../qiskit.providers.aer.QasmSimulator.md | 2 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 2 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 2 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 2 +- ...qiskit.providers.aer.noise.QuantumError.md | 2 +- ...qiskit.providers.aer.noise.ReadoutError.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 2 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 2 +- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 2 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.27/qiskit.providers.ibmq.IBMQBackend.md | 2 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 2 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.27/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.27/qiskit.providers.ibmq.IBMQFactory.md | 2 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 2 +- ....providers.ibmq.credentials.Credentials.md | 2 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...roviders.ibmq.experiment.AnalysisResult.md | 2 +- ...it.providers.ibmq.experiment.Experiment.md | 2 +- ...iders.ibmq.experiment.ExperimentService.md | 2 +- .../0.27/qiskit.providers.ibmq.job.IBMQJob.md | 2 +- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 2 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.27/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 2 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 2 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 2 +- ...t.providers.ibmq.managed.ManagedResults.md | 2 +- ...skit.providers.ibmq.random.CQCExtractor.md | 2 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 2 +- ...providers.ibmq.random.IBMQRandomService.md | 2 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 2 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 2 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 2 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 2 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 2 +- ...it.providers.ibmq.runtime.UserMessenger.md | 2 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.27/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../0.27/qiskit.providers.models.JobStatus.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Acquire.md | 2 +- .../0.27/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Call.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Constant.md | 2 +- .../0.27/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Delay.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Drag.md | 2 +- .../qiskit/0.27/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Gaussian.md | 2 +- .../0.27/qiskit.pulse.GaussianSquare.md | 2 +- .../qiskit/0.27/qiskit.pulse.Instruction.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- .../0.27/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.27/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Play.md | 2 +- .../qiskit/0.27/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.27/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.27/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit/0.27/qiskit.pulse.SetFrequency.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md | 2 +- .../0.27/qiskit.pulse.ShiftFrequency.md | 2 +- .../qiskit/0.27/qiskit.pulse.ShiftPhase.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.Waveform.md | 2 +- .../0.27/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.27/qiskit.pulse.builder.align_func.md | 2 +- .../0.27/qiskit.pulse.builder.align_left.md | 2 +- .../0.27/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.27/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.delay.md | 2 +- .../0.27/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.27/qiskit.pulse.builder.inline.md | 2 +- .../0.27/qiskit.pulse.builder.measure.md | 2 +- .../0.27/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.27/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.pad.md | 2 +- .../0.27/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.27/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.27/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.27/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.27/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.27/qiskit.pulse.builder.x.md | 2 +- docs/api/qiskit/0.27/qiskit.pulse.channels.md | 18 ++++++------- .../0.27/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.27/qiskit.pulse.instructions.Call.md | 2 +- .../0.27/qiskit.pulse.instructions.Delay.md | 2 +- .../qiskit.pulse.instructions.Instruction.md | 2 +- .../0.27/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../0.27/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.27/qiskit.pulse.library.Drag.md | 2 +- .../0.27/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../0.27/qiskit.pulse.library.Waveform.md | 2 +- .../0.27/qiskit.pulse.library.discrete.md | 26 +++++++++---------- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.27/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.27/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.27/qiskit.qasm.Qasm.md | 2 +- docs/api/qiskit/0.27/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.27/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.27/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.27/qiskit.qobj.GateCalibration.md | 2 +- .../0.27/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.md | 2 +- .../0.27/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.27/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.27/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.27/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.27/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.27/qiskit.qobj.QasmQobjInstruction.md | 2 +- docs/api/qiskit/0.27/qiskit.qobj.Qobj.md | 2 +- .../0.27/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.27/qiskit.qobj.QobjHeader.md | 2 +- .../0.27/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.27/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.27/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.27/qiskit.quantum_info.Choi.md | 2 +- .../0.27/qiskit.quantum_info.Clifford.md | 2 +- .../0.27/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.27/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.27/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.27/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.27/qiskit.quantum_info.Pauli.md | 2 +- .../0.27/qiskit.quantum_info.PauliTable.md | 2 +- .../0.27/qiskit.quantum_info.Quaternion.md | 2 +- .../0.27/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.27/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerTable.md | 2 +- .../0.27/qiskit.quantum_info.Statevector.md | 2 +- .../0.27/qiskit.quantum_info.Stinespring.md | 2 +- .../0.27/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.27/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.27/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.27/qiskit.quantum_info.entropy.md | 2 +- .../0.27/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.27/qiskit.quantum_info.partial_trace.md | 2 +- .../0.27/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.27/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.27/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.27/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.27/qiskit.result.Counts.md | 2 +- .../0.27/qiskit.result.ProbDistribution.md | 2 +- .../0.27/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/0.27/qiskit.result.Result.md | 2 +- .../qiskit/0.27/qiskit.result.ResultError.md | 2 +- .../0.27/qiskit.result.marginal_counts.md | 2 +- .../0.27/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.27/qiskit.scheduler.methods.basic.md | 4 +-- .../0.27/qiskit.scheduler.schedule_circuit.md | 2 +- .../0.27/qiskit.tools.backend_monitor.md | 2 +- .../0.27/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.27/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.27/qiskit.tools.parallel_map.md | 2 +- .../0.27/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.27/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.27/qiskit.transpiler.FlowController.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- .../qiskit/0.27/qiskit.transpiler.Layout.md | 2 +- .../0.27/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.27/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.27/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.27/qiskit.transpiler.passes.CheckMap.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- .../0.27/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.27/qiskit.transpiler.passes.Depth.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.27/qiskit.transpiler.passes.Size.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- .../0.27/qiskit.transpiler.passes.Unroller.md | 2 +- .../0.27/qiskit.transpiler.passes.Width.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.27/qiskit.utils.QuantumInstance.md | 2 +- .../qiskit/0.27/qiskit.utils.apply_prefix.md | 2 +- .../0.27/qiskit.utils.deprecate_arguments.md | 2 +- .../0.27/qiskit.utils.deprecate_function.md | 2 +- .../0.27/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.27/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.27/qiskit.utils.has_ibmq.md | 2 +- .../0.27/qiskit.utils.is_main_process.md | 2 +- .../0.27/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.27/qiskit.utils.name_args.md | 2 +- .../0.27/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.27/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1208 files changed, 1266 insertions(+), 1266 deletions(-) diff --git a/docs/api/qiskit/0.27/execute.md b/docs/api/qiskit/0.27/execute.md index f8e620f7153..396c542b693 100644 --- a/docs/api/qiskit/0.27/execute.md +++ b/docs/api/qiskit/0.27/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.27/logging.md b/docs/api/qiskit/0.27/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.27/logging.md +++ b/docs/api/qiskit/0.27/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.md index 2d896f3128d..399182a81fc 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.md index f799eec0eae..0c5c3774a63 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.md index cb143c4956f..d916819487b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.md index f5e0c2f1458..eefb858540c 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.md index b556964d697..e80e0ad124c 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The Amplitude Estimation interface. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.md index e2bf527b243..bce7fdcd886 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.md index d76e5f2dbcc..f1ba5b78959 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.md index f3bea317eb5..406952446e9 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.md index 956caa9f16a..c733f091a7f 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.md index 9eae6998d00..f3fd662003e 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 802aefeae6e..1321c3b62aa 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.27/qiskit.algorithms.Grover.md index f5722b33868..68b38ac8011 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.md index 45b3bf0cb95..d2a41d6a70b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.27/qiskit.algorithms.HHL.md index 2316b6843a0..f7ca01dcafa 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/hhl.py "view source code") Systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4c5df5656a4..d35103f35ad 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 6542136e76a..37bb09ff020 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.md index 286465f6461..f6b4b7ec3f7 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 16aea5c0c06..4ff530ca25f 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.md index 90f59f74936..99f9df925a3 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") An abstract class for linear system solvers in Qiskit. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.md index ace4ff0075a..195d6ae7a97 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") A base class for linear systems results. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index f90c1e8d6c2..ade7fa651f5 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 346339eac91..43eca5da3b7 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.md index 2be2ffe8d92..dab4dfd4f10 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.md index 49cf01feaae..b7784de4cbc 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.md index 29ff1e70f59..8016ad1d832 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.md index 5d558a83797..308ddf79339 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.md index e15f655a13c..155b6730e86 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.md index 44b2866c219..49be1e2b403 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.md index 2a9caa1e2bc..dd79745f27b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.md index d9b6f50ade3..58dd8c1c7cc 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.md index df6c62b283c..3699a989534 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.27/qiskit.algorithms.Shor.md index a942f519b46..bfd4b1aba6b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.md index 29429c230ab..8666044bbc3 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/factorizers/shor.py "view source code") Shor Result. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.27/qiskit.algorithms.VQE.md index 5cb0c3d9d7b..21914112dca 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.md index 8667004cd86..c0088011ce9 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.md index 043c72235c4..3cfde2deeb7 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.md index 282299ccc49..c685e6e6cd1 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.md index a2eb42c003d..f689ce5137a 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.md index 8cc769b8779..4535e33a34e 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.md index 320a2da2045..c8fa927308a 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.md index c33a9198de8..cd14867f526 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5db2468fec2..c7642b708ef 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.md index 4b08da729f7..1f575ddcfec 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.md index e4e32268446..3d16d6e192b 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.md index 20df721fd7a..038a472e106 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.md index b7361c2bd7b..9d09d71d01a 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.md index 4e29aec7286..edd2a901880 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.md index e288e1ce8e6..d988f51f278 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.md index 75acbf82ce6..ec21a1922f6 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.md index 2ef52d30202..655c1f1bee4 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 0856e50bf5b..fc5ebf7953c 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.md index 0a8cefe3e5d..fc196284bd8 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.md index 5eb307d6470..32e64af2d05 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.md index 0ed226faf24..e07787c2b9a 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.md index 0ee40c914bf..ec70d18b8fd 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.md index 0a31ffb9b99..a0ec22f3126 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.md index b9628dad7d8..4a27afbfd5f 100644 --- a/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.27/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.27/qiskit.aqua.AquaError.md index 72bdd21c8cf..b0bbe2c81ef 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.md index a2705fb67ae..eef98fffca2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.md index 9ee4dad3049..0d8d6fc9477 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.md index c82a3f32b92..630926f0093 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 1f4556654dd..055cccfe474 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") AmplitudeEstimationAlgorithm Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 0450944cb6f..6382e73321e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") AmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.md index c782a8d61a8..33fd16d3b8f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 2c7ef4f8ac5..bbbc746c26d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.md index 39823865eaa..a67ca03ffc4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.md index 8ea64d5fad0..d3f8f9d731e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.md index 60113e9584c..e4598fd3333 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.md index f65a77574de..5d0835978d2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.md index 31d6a1c92f5..d1dc9805d11 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.md index 21f87ab7b5f..716729919ab 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.md index 40e4e5b30c0..c20a7413d27 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.md index ade87bb3d36..deeafde8261 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") The HHL algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.md index 711bc422e46..fe9eef0961f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") HHL Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.md index 3f5ba5aa9ab..b0a14448851 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") The Iterative Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index 8f2f88b7644..31a0777eceb 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index ca43e5778c6..79f7e665c21 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") IterativeAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.md index b2f1bbffc4f..ecfc7c0798e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Linear solver Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 24fc5dce30d..8a298d586b7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5c5d5e9ba73..148f0f90794 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") MaximumLikelihoodAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.md index b2572553aed..9f3296c218d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.md index 7f00556e724..bbb0f773d64 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.md index b6ce362fe1f..5ffd928f1e5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.md index be768fecf96..13f5d645b9b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 3bfdd481080..f97e6f296e7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Numpy LinearSystem Result. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index c424f9e0e3e..d4a62ade0f5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.md index a6e445c0c3a..075785e6fdb 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.md index 1c9433e0d0c..e49adddc4c4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.md index bf43630fd78..e2f4eba9f96 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") The Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.md index 4b11c7633ba..b3deb6dbdd5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Quantum SVM algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.md index e6dd5b1eaca..ce3d74260e7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.md index 56b4c11512f..2e3a4acafad 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.md index 8c76ae0bbda..4c781638b97 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") The Simon algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.md index 138ef590f05..a49fe1e2bf2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.md index de10c7051e1..d94d46d0847 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.md index 6889911df56..15795469c33 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.md index 433ff83adf1..8fbf05eac12 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.md index e309a95bd69..2385738c43c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.md index 99920079c46..73bd8cdd705 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 567d5d259dd..6df044e0ba4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.md index 2d4db79e802..9bc47428835 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.md index 345d2660260..2522a4854c2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds q^T \* w to separate register for non-negative integer weights w. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.md index 65c6382293c..9806b883b54 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Base class for eigenvalue estimation. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.md index f1abaff3330..bc20afe9d56 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.md index d09393cf480..e9f7b7b57f3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Base class for FeatureMap. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 9a188d126e0..8ea631c0a78 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Raw Feature Vector feature map. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.md index b1d1f7b7271..5a1982c7ace 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") The custom initial state. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.md index 4bed6eca882..ca765509ba7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Base class for InitialState. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.md index 446d360c9bb..6eb58020d6b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") The variational form based initial state. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.md index b9a66f9d084..86296612375 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.md index c97d45b3cf4..34bae3465dc 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 4b2eb2401d1..33d47cdb258 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 2eb6d3936db..e5ddf888858 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Base class for multiclass extension. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99d97264a8a..2ef53d7a23d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index cd60657c2a6..96ff7c3a0d4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Base class for discriminative Quantum or Classical Neural Networks. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 9724d541106..00fd1c50839 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Base class for generative Quantum and Classical Neural Networks. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 258ba48db93..cbede1b9f11 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Discriminator based on NumPy diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index dd11fb4be31..b3a32c57436 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 4cd9e258717..fdbc49aae48 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Quantum Generator. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.md index c20e5fb3db1..95d989bc92b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.md index 954ee20efcb..5823c34e847 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.md index 6f1df370dec..05c8a097e53 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.md index 4fdf15efc24..99abed6409e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.md index 67750b21b4d..58775337bc4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.md index 69f36fe5624..183be12c4e2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.md index f56e5ea574b..b14e7f6c251 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index cccef7e7320..72a9933e1f2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.md index 0906f993280..279ce0fb387 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.md index f88b865421e..636612e97c7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.md index 7387deb4d94..f7995f0a52d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.md index 555b00309b0..3cd707eaf29 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.md index 63dc681d75d..79558fd2d4d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.md index 34a97f3e91f..171aa2b67d9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.md index dae5ca40b91..c04ac766d9b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.md index 116295f4b6a..69dca758b6d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index d0e669bb1a7..37309e501f9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.md index 9c92991e2f7..56344c968b7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.md index 942baa7df9f..64596f96b46 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.md index c8ae54d9375..f4088801997 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.md index f883074badd..716c298f629 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.md index 211bbe75eb9..9d62ecb9d94 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.md index 52d1edcfb01..8575b1a8289 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 1efaf9e160d..6e6feb2e2c1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index 65747fac0be..3f4147f11aa 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.md index 29b17616d91..04bc2a4d417 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Base class for oracles. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.md index c8e8073d3e4..154378c14ca 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.md index 733b94065b9..8a122be5cc1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.md index 9b6aa75d977..e35cb5fddb6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.md index 29c83c2fd62..86c1b50d8a7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Base class for reciprocal calculation. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 945b9184909..e3e1dff27f1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") The Univariate Bernoulli Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 3715f75da1b..eea2bf371e7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") The Gaussian Conditional Independence Model for Credit Risk. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index ad68dffadeb..f04631bb7f6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") The Univariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 5ea01becec1..3622ff695a2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index e6038a59507..f2abd17b3d9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") The Multivariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 94b689e8499..702881b3beb 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") The Multivariate Normal Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index 7b2d17d5126..8c73d966e65 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") The Multivariate Uniform Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index a55a92a56e6..3406fdf8517 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") The Multivariate Variational Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index ad8841dd922..b3e399cf438 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") The Univariate Normal Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 082f187b3b9..b9a129ad8b4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") The abstract Uncertainty Model diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 089a4e41e48..54b2b6b2020 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") The Univariate Uniform Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index 8cc2bde0c8b..336f9e61c25 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 61ddd07d327..3eee9c45c7a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") The Univariate Variational Distribution. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 0f147dad700..32b5cf95140 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 4efc7c450e2..1570c4b049e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") The abstract Uncertainty Problem component. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 00398280d6c..4455c3fde38 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index c03f18d2b15..3763244e48e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.md index 7f77cc6a568..ae54370571e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Base class for VariationalForms. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.md index ec1917ebed0..9270c17966e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.md index 729f6c68b5e..16564a49cf8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.md index 101c6bac51f..104cae3fe55 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.md index c9c7905ff87..29d99e3b4a3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.md index fc2e0ba5493..289c8148ad7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.md index 14b55172bd2..013ed5623c9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.md index 8990a75bb23..9d7b75a0499 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.md index a8b3394e7b9..5d9f1afdf50 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.md index 924860e8670..c43bffcbc12 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.md index b78b1c8ba98..0f416fb1f81 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index f493a23c982..657c2eaf4b2 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.md index ff4a37374f8..26e712f47d8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.md index 663d6383679..63b01749667 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.md index 6937b3fc107..5a710fdbab4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.md index 493badc098d..0edc7d5fe4d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index 5acb3a36034..fe533716b26 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.md index d7b830c478e..fed697d4233 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.md index c6f9a807400..361118c50b1 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.md index cd31bab12bf..ba5d70e49d0 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.md index 520dfc545de..98c4fb9e474 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.md index 43fa318a514..a868c4bdba9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.md index 07eef403ff8..692df017e9a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.md index 8b6c5c27435..7b74a425017 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.md index 0af05335f59..e77492cc3a8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.md index a7034b7eb91..4358446ae62 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.md index 3ebf61675db..e4964472425 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.md index a531bd1b466..33f5d0652ee 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.md index b9b5a7aa145..25e02a21a8e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.md index d4b1ca8b495..63c7da727fa 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.md index 48a5ac2948f..a3c798ac103 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.md index 60790f54865..cd438b5d63e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.md index 817840970a5..5e8c7943fd8 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 9160971edff..aa8397ab620 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Operators relevant for quantum applications. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.md index dcfcb2d47f6..154e11912a7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.md index 56a752f289b..b8d7a1deb2f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Pauli Graph. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 6e3362f5b06..54b70f2993e 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") TPB Grouped Weighted Pauli Operator diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 46267d36942..8c7716d5814 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Weighted Pauli Operator diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.md index 8a6fcf48fac..c97c874fb6f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.md index ae2ec0e6793..351a63dea5c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.md index 667679ecec5..bcec2f74aa7 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.md index e16a1ab505f..6d86cba2f32 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.md index 4ef7c8af75a..76e3cec082c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0a46099874e..e15dc17735d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c584f2aa350..ba75a648daf 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.md index eeb9f35ed8b..478c72ab719 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 9867f1076e2..bdeec83e436 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 77fcc50b8ec..d477db9812a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.md index f0bc8604346..0eeaf0a02fd 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.md index e501482d8e1..05487a0a028 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.md index e63b4bae41c..a8dbb043504 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.md index 5ffd220a203..72d5480cbe4 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.md index cf5411c0ae5..fb2b001ed7d 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.md index 296315f2a33..a163f1dd643 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Base class for CircuitFactories diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.27/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.27/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.27/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.md index d1632a4184f..febbb1173ee 100644 --- a/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.27/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py "view source code") Class for Run Configuration. diff --git a/docs/api/qiskit/0.27/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.27/qiskit.assembler.assemble_circuits.md index caa783f499d..6349ddca727 100644 --- a/docs/api/qiskit/0.27/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.27/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.27/qiskit.assembler.assemble_schedules.md index 7c20b810bfd..b7d0e44ee02 100644 --- a/docs/api/qiskit/0.27/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.27/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.27/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.27/qiskit.assembler.disassemble.md index 3ca3fdc354a..bdfe1082bed 100644 --- a/docs/api/qiskit/0.27/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.27/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.md index 5c24fc48425..9940482184e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.md index 747136a0eec..955d0862bf5 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.md index 920d3f7a586..986c8ace0f2 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.md index 94dabc11d23..2a2137f0aa6 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Molecule data class containing driver result. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.md index 748e8648b33..ab262eba395 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.md index 05db7fb4c1d..9e0c20dc5f6 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.md index e4f4159190f..446cd7614f5 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.md index 8bc2599e3d7..379b0ffbda3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.md index 5795becc89a..c7bec35725f 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") A factory to construct a eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index bc7f21a57c3..2485d08dc09 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index 84a7fb46129..e8490042751 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") The excited states calculation interface diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 3dc080851a3..2cba3095bb8 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.md index 81e46c6895c..628441ad2df 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") The ground state calculation interface diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index f5231e126f6..5b0c2212770 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") A factory to construct a minimum eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index 22b0c687db2..121cee11ff7 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index fdf3ea87d60..48578808d21 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 66e029e6e97..0fc89fd5d13 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.md index c740cc0916d..12b6c879030 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.md index 10f5bf790b9..bd4b5beda83 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") QEomEE algorithm (classical) diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.md index 52341c1f288..a8383d988ee 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") QEomVQE algorithm diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.md index 91c095d3e2c..af6f1263af4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 7475c54a220..e49abf6427a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index d889402948f..ef4fb71169c 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 7fb7a8d3d9f..65c259a031a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 3a84c9a2f36..1eb0f3fe5a4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index f4c17027475..d32fc9580fb 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 75ac290d615..3d79c5bf9ba 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a potential energy surface diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index b7e582e3e2e..7c340ea87bc 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index bcd46c5f7bb..8775905ff06 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Implements a 1D Harmonic potential. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 54708eb2f7e..d2535769625 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Implements a 1D Morse potential. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index a73b1fb0456..2d7e114251e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 61194171a49..b9c4941f5be 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 1d859cea127..7c4a0073c60 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index f706abfdc97..3093a133add 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index bcea8622fd5..905c40eb111 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 4e834213def..9d9775ca901 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index cd1181103f9..cc8da4b32b9 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Molecular ground state energy chemistry application diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index c06008cf7d7..945666620d7 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 77719be753e..f98567f64f1 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.md index 76c30edce7f..2d9d0d70387 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.md index f95092a6d16..3054f09ac8d 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.md index f7ce6a53c02..b537bd9de45 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") This trial wavefunction is the Compact Heuristic for Chemistry. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.md index 4b2e49ad24a..e4fe17702d7 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.md index fbb3af3f7cb..5fd446b538f 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.md index 7a04e316abb..0b220e457c2 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Base class for ChemistryOperator. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.md index b5b4bcc999b..185dc931e06 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.md index 472883dd644..86424d40d53 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular chemistry Result diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.md index 5ce2ba01ee9..10c36ed37a4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Excited States Result diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.md index a5758bb9c74..b6ccc3eca49 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Ground State Energy Result. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.md index ce80df72b53..5b8d8a929a3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") QubitMappingType enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.md index 37622039125..fd938f5a0a7 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Transformation Type enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.md index 28c9c724102..9034ca598f4 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.md index 84eba214cee..3824fc7c343 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Basis Type diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.md index c1ff963cf6b..f966e471f6d 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Base class for Qiskit’s chemistry bosonic drivers. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.md index 059fd03f59b..559ab8099a6 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Qiskit chemistry driver reading an FCIDump file. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.md index a2a64dc4b38..e141b6ecbba 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Base class for Qiskit’s chemistry fermionic drivers. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.md index 8569c886245..a7afb167a16 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.md index 12591ef52b8..cf24c4d96aa 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.md index 8b57a5a98dd..d9243ba36f8 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.md index 9326f859b70..8158d55b550 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.md index 3ea0b3e6e71..79a14826c18 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.md index 0edd9b59c50..d62382da59b 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") HFMethodType Enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.md index aacfe0f8d8f..8562017cc21 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Initial Guess Enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.md index c9e14294833..506e0425c5e 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Driver-independent Molecule definition. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.md index de7fcc3f798..fdb29f147d3 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.md index 1011f674456..5e063af7f3a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.md index 5177ea1e968..285a1320513 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.md index a43e813c0a9..db273883a45 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Units Type Enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.md index a84f7153a90..07a6eb9eab5 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") The BOPES Sampler result diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.md index 97fb8c855f1..f865295260a 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") The eigenstate result interface. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.md index d10665d56ca..4d37d454137 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") The electronic structure result. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.md index 41cc19ec851..4d61669b64b 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") The vibronic structure result. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.md index 01afb136d73..f50e6d669d5 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.md index 74da609f5a7..72622b1d608 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.md index b2257adaf1d..e9b62d52d3c 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicTransformationType enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3c79ecddccd..1847365b7c2 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.md index 39a1dcc61fa..a135e2a8287 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.md index 313dfcc0743..5803fed8481 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.md index f2f8e92bd2d..421c80b7baf 100644 --- a/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.27/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Base class for transformation to qubit operators for chemistry problems diff --git a/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.md index b8689446b24..48a58d682f6 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.md index de10a32674e..e0290b3d0a0 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement an ancilla register. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.md index d083711c431..def9b25fa8f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") Implement a classical register. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.27/qiskit.circuit.Clbit.md index 464a68392df..74e20979ffc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalregister.py "view source code") Implement a classical bit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.md index 9c06f2820a3..62c183dd41e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/controlledgate.py "view source code") Controlled unitary gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Delay.md b/docs/api/qiskit/0.27/qiskit.circuit.Delay.md index d5c6ff453d2..aeadce3ce9f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/delay.py "view source code") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.md index a4076c216a1..424d81eb007 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/equivalence.py "view source code") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Gate.md b/docs/api/qiskit/0.27/qiskit.circuit.Gate.md index 87ccf338957..54771e428d4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/gate.py "view source code") Unitary gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.27/qiskit.circuit.Instruction.md index 27c72011ece..32af90da5ea 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instruction.py "view source code") Generic quantum instruction. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.md index 65b771ba972..371785e4377 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/instructionset.py "view source code") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Measure.md b/docs/api/qiskit/0.27/qiskit.circuit.Measure.md index fbc388f8ebc..80fd13c3be1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.27/qiskit.circuit.Parameter.md index 96ebbee240a..fad20f5f650 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameter.py "view source code") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.md index ea4fe86a18f..910130a0ce7 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parameterexpression.py "view source code") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.md index a1145de5ae0..1f7876fd981 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/parametervector.py "view source code") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.md index c080c90ec22..83f8e01354e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumcircuit.py "view source code") Create a new circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.md index 2a12a9e1d24..bb7934be4ca 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement a quantum register. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.27/qiskit.circuit.Qubit.md index 7e07d881fd0..13ec1c3157d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py "view source code") Implement a quantum bit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.Reset.md b/docs/api/qiskit/0.27/qiskit.circuit.Reset.md index 6c7b62d0bca..29189a0037f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.md index ca96fbc97a9..ec78258a01f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") The Boolean Expression gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.md index 5493bc601b1..c85fb8bd9e9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 203d8900620..7a4905c5809 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 696bd8c7af5..6405f681e92 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.27/qiskit.circuit.library.AND.md index afcd36ad3a9..28eaaab9f82 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.md index 48067f79177..9878d93904b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/barrier.py "view source code") Barrier instruction. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.md index 2c76e5f589c..65ddb03b4b9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.md index c71b31ab9ff..f0ebe618639 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.md index facfe34ef63..0ccf5336925 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.md index 46c58665cfd..8347d7c4be4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.md index 02ea8afc1c6..bb279bd6c4e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.md index bf1f8247edd..c25e44f3564 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.md index de66b1e4fe7..3f965968d07 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") Controlled-RX gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.md index 3ae575796dd..1351553d161 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") Controlled-RY gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.md index 489b596fcc2..d365c733473 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.md index 4458281078f..6918c1a4c71 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") Controlled-√X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.md index d09fbd49b4a..c4106265d44 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.md index 15b7ffe7aae..5d0e0222bb9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.md index 6a87acc41c4..adb8a77ca7e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.md index 4a8f4228748..0808aa5c07b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.md index 5e4bf000bd5..57444db44cc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.md index b6f9894be80..99adc9969c5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") Controlled-Y gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.md index c5f9f859308..ebeeaf808f3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") Controlled-Z gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.md index 1184e2363e1..5152b5bec1b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/dcx.py "view source code") Double-CNOT gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.md index fd4c2528474..a0378770c01 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Diagonal circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.md index af7c6bd4ee0..9d34fb14c21 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ecr.py "view source code") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.md index 53b69f8722d..42c30db3ee3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/efficient_su2.py "view source code") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.md index bb9dd768d83..6534fa7e336 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.md index 0039552c183..bd6a82954f9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/fourier_checking.py "view source code") Fourier checking circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.md index 0409499e7f0..df7de0aa97d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.md index 4a305f596f8..d20fd0c7279 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GR.md index 046e37dcc99..ed097f35255 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global R gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.md index ca99399e592..31eea8f93de 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RX gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.md index b7693d744cb..6fdb8cfe85f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RY gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.md index c0034711745..d2d5d9f2b6c 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RZ gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.md index 4d2b20facad..d3c84dcfae0 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/graph_state.py "view source code") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.md index 3bfec8fc887..6eae7cdcef8 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/grover_operator.py "view source code") The Grover operator. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.md index dd9495a2bf2..1fd884aec7d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/h.py "view source code") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.md index a5a74d992ea..7ae33efe75a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/hidden_linear_function.py "view source code") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.md index f09fda86823..eb81b33cc00 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/i.py "view source code") Identity gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.md index 65709e9fa84..78b2863c198 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/iqp.py "view source code") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.md index d89445d65e7..7de380bb797 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") An n\_qubit circuit that computes the inner product of two registers. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.md index faebd6aadea..7cd87eed9a2 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Integer Comparator. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.md index 852716e2ff9..73f7066a994 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.md index 54ce7765d60..8f1ce5240d7 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.md index 0495d77f6f9..1b03fd9a119 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.md index 3d43d634b63..a11f738c2e7 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.md index ac1d128605e..b3b201a668e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.md index ad365ea6e88..52afb1d2c57 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.md index 25a83e73333..93c004fffd0 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The general, multi-controlled X gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.md index fe84787d890..3e153507f0f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.md index 336eb9cfcc2..67d0a987ceb 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using recursion. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.md index cd8600feab1..276cf79c504 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using a V-chain of CX gates. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.md index 314e2adfb3d..b6fb9748276 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ms.py "view source code") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.md index 96884eb1d54..8ea2da31c57 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.md index e8639bde078..936dc3c08cc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/n_local.py "view source code") The n-local circuit class. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.md index 0879ab23180..37f2a14b7f1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/normal.py "view source code") A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.27/qiskit.circuit.library.OR.md index 5525939c60e..1cdd9a4ebb5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.md index 671a51e74d2..8ae16dee1c2 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.md index 72db6dac693..f9054b4be46 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.md index e4c8f939b6c..0fcb8a1c4b6 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/permutation.py "view source code") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.md index a2a3509a53a..5ef2b079dde 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_estimation.py "view source code") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.md index c90230ba96b..c44ec9d5e11 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/p.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.md index e685a6b51d1..49314d2216c 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/phase_oracle.py "view source code") Phase Oracle. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.md index 9e3a6f3bef9..06e5564cc13 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index ba823b98576..7d7ffe69dbb 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 6a2617fc18a..16ef5d98058 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.md index a79bb112368..30aeefc906b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.md index 5ecbbbef9c1..f2b074af53d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='qaoa')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='qaoa')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.md index f3278dfd9e9..fec7f4969e0 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='qft')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/basis_change/qft.py "view source code") Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.md index 0b99fab3f17..2d195ba6049 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Implements a quadratic form on binary variables encoded in qubit registers. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.md index b03b2338d75..bdcfe6b2a80 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/quantum_volume.py "view source code") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.md index d828fbbb76a..142218cedb8 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.md index e80e66e23c5..9ad9fec2a21 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.md index 27ae45fddb7..dc4cf3013e3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/r.py "view source code") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.md index 2c2e1883a75..2e35776bb55 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/generalized_gates/rv.py "view source code") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.md index 7ebd43c879a..0aa6996af5e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rx.py "view source code") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.md index 2a791ae1a9a..4fcc145ef71 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rxx.py "view source code") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.md index 8b14cb14fa2..5942b88a721 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ry.py "view source code") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.md index f1197436491..ef94d257fe9 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/ryy.py "view source code") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.md index 8128226e26e..d7c497e3862 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rz.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.md index aff25ba90f8..ddf87476d96 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzx.py "view source code") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.md index 177b15c039b..534d21b34d1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/rzz.py "view source code") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.md index da626a1aa88..c9e6dd48d9e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.md index 7b7c61b44df..e0c93f1d6cd 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.md index b8a49fa527a..5cd883593b3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.md index 281cd0ffbcd..7ea3965c035 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.md index 931bd4bac39..09ae9a04916 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/sx.py "view source code") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.md index cfbddfa9148..02d1d4b0c49 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.md index 40757d25acb..b6d7d3749d4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/swap.py "view source code") The SWAP gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.md index e8f4333227c..01a1c5f7fc5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.md index 8b396c13f5e..8584d33be78 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.md index 717288b6100..1f540c4fb50 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/n_local/two_local.py "view source code") The two-local circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.md index 029f06a5044..f9266056e27 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u1.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.md index 9d178a3df1d..34db0c7f695 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u2.py "view source code") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.md index 55447af66d2..a94db2b64ae 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u3.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.md index 7c04d167347..2f0460ec780 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/u.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.md index 43c62b3a097..76ce640d6d2 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/probability_distributions/uniform.py "view source code") A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.md index daf7159234d..ab7dd2aa189 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.md index fc8bb4d214e..5d3304cdf92 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/x.py "view source code") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.md index f553129f273..f396da6da21 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.md index bde4bf63e2c..ecafaa289bb 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/y.py "view source code") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.md index 8cbc0044b73..63d07a0e09f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.md index 944bc5a0ad5..a88d237646f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/z.py "view source code") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.md index 564336ace5f..fdd3132a5f0 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_1.md index dc4faed3a93..e3cbf9e0a18 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_2.md index a1e62d88610..4aec5545ca1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_3.md index 5e6651ff807..b5a1ee51204 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_4.md index bcc219cdc9a..17d112be973 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_3_1.md index 7a2889c3321..36d9f286835 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_1.md index 1181d7dd892..61afa53bbe6 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_2.md index b4c80ed2ffe..f384fc66775 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_3.md index 6c47aaef224..c12df5f9403 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_4.md index 1f7012859be..9e237e2a6e7 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_5_1.md index d9164f65b22..1dfff65b466 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_1.md index 3f6bf6db46f..bfda63fd168 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_2.md index c63bb56f2b2..6ea1326ed8f 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_3.md index 65d8bc1dccd..cb8b6edeb14 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_4.md index 7d6f87b894f..a182d0cf7f4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_5.md index 1dc75c07c75..1935ec61892 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_1.md index 0b9445c8ddb..c938578f239 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_2.md index 1bc852517ef..42e229e947e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_3.md index b6aa73ac4e1..fa2a54ecaf7 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.md index 12e5e1dfb5a..fea6d949cf5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/standard_gates/iswap.py "view source code") iSWAP gate. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_cy.md index 7ccb8c60296..e38e4f167f3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_xz.md index 1651b1a1592..8793a9321a4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_yz.md index 2ec0caab564..b00d3442af5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz1.md index c9003249f9b..d6717d449ac 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz2.md index 67639bdd08f..72af0080570 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz3.md index 52fd7573040..2bbd9d25cf6 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index dec29c85192..d7212cbdf12 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 4a1561de3b7..26d5b88e2f5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 5465418bb16..71359895c17 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 5ff2a8cd00b..32722501373 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index e008e1d3606..d095b00cbcd 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 2bdd91aec8c..d8aafae0082 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 713d02d8971..df95b4a13ca 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 05da7fc345e..ffce1633fa4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 585f829babb..49a9feae969 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index b07096e01d7..ed86a33416a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f3854aace9a..12ee3bc9110 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index e7e409508a5..c244cdf8cba 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index f0f455970f0..e195041a20a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 6aeff1fc0d5..c7c3e32e552 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 281601f57b8..2c61c90f851 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 67130cf48f6..947ea64e535 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 2837dc024b3..e1465477f79 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index a82552427d9..d1ea13ec6bd 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 7c5b7cc15f8..14f8b25b321 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index ff698e57d50..c87f398da5e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7e302ab4a62..b7c55f674be 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index d4849b0ec07..f42f2e937dc 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 0a47443257a..d87bc1a8271 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index a616d285f91..4aa4a6dc94d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 257e60a4624..6f285fff2ca 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index f2c8c9d5682..5262b2bd07b 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index c158da8da0e..1e8fab96a69 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 6c6e6b9df63..33c443f6608 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index f8becbdd978..222d07711b1 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index d0eb88381e8..6a64f319cc4 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 5e55b75867d..2132041a985 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 730fb05f07b..bf9d9da3555 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 68c9b82dd2d..700c51d2c10 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index f00914d9ec3..bfb6fe8239a 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 66bbb71d092..5df1f2a3564 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 77216d8ced2..7f07f840eaf 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index c985bf917ca..17ac239ee84 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 42ca1cfc0da..d75b80d9927 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 8d91854d4e6..a203bba6f61 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index caa4ba6c373..06d9b565371 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index e4ee0f9f628..06ecb552099 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index f3c1feec0df..e06573c24e5 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 108ccc7045f..62b7e05a4a3 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 81ecf210b0b..a94b396f37d 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 953d059611c..da19fdce43e 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index b0e70996835..15925f38779 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index fcf33cb097d..27c6abb91df 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.27/qiskit.circuit.random.random_circuit.md index f9961cbdd69..c449e7e2c39 100644 --- a/docs/api/qiskit/0.27/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.27/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.27/qiskit.compiler.assemble.md b/docs/api/qiskit/0.27/qiskit.compiler.assemble.md index fb20d988d7e..250b0a0f358 100644 --- a/docs/api/qiskit/0.27/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.27/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.27/qiskit.compiler.schedule.md b/docs/api/qiskit/0.27/qiskit.compiler.schedule.md index 90381037ca0..d357f5eb64e 100644 --- a/docs/api/qiskit/0.27/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.27/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.27/qiskit.compiler.sequence.md b/docs/api/qiskit/0.27/qiskit.compiler.sequence.md index 0f2a638fe95..674c495df7e 100644 --- a/docs/api/qiskit/0.27/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.27/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.27/qiskit.compiler.transpile.md b/docs/api/qiskit/0.27/qiskit.compiler.transpile.md index a22cb317ac3..f661128234a 100644 --- a/docs/api/qiskit/0.27/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.27/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.27/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.27/qiskit.converters.ast_to_dag.md index bc89fa3b34b..9c0ed82d739 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.27/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dag.md index daeeaa95b25..18174091b45 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dagdependency.md index 67a08de74cb..2ec4738cb4e 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_gate.md index 065af631ccf..9f819ac9b94 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_instruction.md index 103490a4ef0..67517f39835 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.27/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.27/qiskit.converters.dag_to_circuit.md index 0d3af46949c..e973c795a9b 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.27/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.27/qiskit.converters.dag_to_dagdependency.md index 5a14894f46d..9cfc2bcf89b 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.27/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_circuit.md index a1808e8bee6..223914d0566 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_dag.md index d7f056bbc86..ecc5d7648e8 100644 --- a/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.27/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.md index 8c6149b55c3..57dd50d7d62 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagcircuit.py "view source code") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.md index 2351592301a..768c8b11811 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.md index d5b7d0f4c42..e6e3ab74d25 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdepnode.py "view source code") Object to represent the information at a node in the DAGDependency(). diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.md index cbd83ac69a9..d8e594c1bcf 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagdependency.py "view source code") Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.md index febeaa15a5f..23ad2af142f 100644 --- a/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.27/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/dagcircuit/dagnode.py "view source code") Object to represent the information at a node in the DAGCircuit. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.md index 5837205347e..028996bf970 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.27/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/hamiltonian_gate.py "view source code") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.27/qiskit.extensions.Initialize.md index 8c4d741c96a..949e9b6cb07 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.27/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py "view source code") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.md index 85f85f8745c..f742203c37c 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/simulator/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.md index 33307a0dab7..85e8bbd120d 100644 --- a/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.27/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/unitary.py "view source code") Class for representing unitary gates diff --git a/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.md index ecb17062b1e..ca345b23a89 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.27/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md index 82487c60134..ef69b4836a1 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md @@ -26,7 +26,7 @@ Convert portfolio optimization instances into Pauli list -`get_operator(mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`get_operator(mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") get qubit op @@ -34,7 +34,7 @@ get qubit op -`portfolio_expected_value(x, mu)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_expected_value(x, mu)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio expected value @@ -42,7 +42,7 @@ returns portfolio expected value -`portfolio_value(x, mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_value(x, mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio value @@ -50,7 +50,7 @@ returns portfolio value -`portfolio_variance(x, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_variance(x, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio variance @@ -58,7 +58,7 @@ returns portfolio variance -`random_model(n, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`random_model(n, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") Generate random model (mu, sigma) for portfolio optimization problem. diff --git a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md index f91ddbb89e1..bb47d349453 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md @@ -24,7 +24,7 @@ portfolio diversification -`get_operator(rho, n, q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_operator(rho, n, q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Converts an instance of portfolio optimization into a list of Paulis. @@ -46,7 +46,7 @@ operator for the Hamiltonian -`get_portfoliodiversification_solution(rho, n, q, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_solution(rho, n, q, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. @@ -69,7 +69,7 @@ a vector describing the solution. -`get_portfoliodiversification_value(rho, n, q, x_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_value(rho, n, q, x_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). diff --git a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 9f5809eb8b1..4f464fc2052 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") The European Call Option Delta. diff --git a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index dab41ef195a..1682162de70 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 142aad07547..a502f97f51d 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.27/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.md index d85745d4aec..ff8b9ee0b55 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") The abstract base class for data\_provider modules within Qiskit’s finance module. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.md index 8f945e76f70..963504596fb 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.md index af2b26fb556..d2b478f9069 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Exchange data provider. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.md index b73991b0df4..b19b1d0c3e8 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.md index 105c54a6304..6b382b8766a 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Stock Market enum diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.md index 5556d0d8463..4fcb867c5fb 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Wikipedia data provider. diff --git a/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.md index b2529cd4972..25ccfa057df 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.27/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Yahoo data provider. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.md index ed885e86acb..f893ff8583f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.md index 529402f02ba..98d87705c94 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.md index 3be217cdf55..a5e78ab334d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.md index 02a0e6a865c..78f0982e69f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.md index 94f70611e32..445eb111c8b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.md index dcbb143056c..ac440e27f5c 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.md index 36ce349ad43..35b450c59e8 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Drag Experiment fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.md index d66deee5d0a..e133ca7ec0c 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Rabi Experiment fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.md index 810576dcce7..b2901ae9ccd 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.md index 2d63119331a..4c52b3df4ba 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.md index 639b9cf3e90..c6359b2cbc0 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.md index 98fb9d3ebef..f57659067dc 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") ZZ fitter diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.27/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.md index 86073e22305..472a8f16b42 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Class to read from Ignis log files diff --git a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.md index b0481d5b676..3f80ff9739e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.md index 2d9915510ed..fdaac5a520a 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.md index 6e65d9093b1..8fa8d3e7401 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Implements a filter based on a discriminator that takes level 1 data to level 2 data. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.md index 445d42fea9f..5376260c0bf 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Abstract discriminator that implements the data formatting for IQ level 1 data. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.md index 52c0f8470d5..ee9c25308de 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index c1c3ff698c7..919f54257e6 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.md index a642898bc59..79be0223b34 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 8e15311737a..6c0871b24a0 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index e7b577353ba..3e133e59a91 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.md index 24a8214febc..7d1c769ba6d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 94239cbb31f..20d9c599347 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.md index a66fbc2dc00..7474d28cca9 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 1fc9f995da8..05e6a60eaad 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.md index 2ea8d6aeb6c..fb77a6ff758 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.md index e0ce4027d78..965d40ad123 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index fda9f345b25..f544793e6c6 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.md index e351e671e68..10b34c7821b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.md index 5745acc3c58..9fd9d225eb1 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Class for fitters for accreditation diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.md index 8f394ba2eb6..8a6398a21b5 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.md index 29ec35ed014..e3d5eadf067 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 984ccf64b31..5b483d5e83d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.md index c05e3fde8b9..5ffc2e22f3c 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.md index 9ac37c8dbe0..78f122d4e7f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.md index 2586d94a7de..b8b89587dc3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.md index 76e568f038f..659f420190d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.md index e22e30738b1..d6b9ef1066b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.md index 9484ec90e87..ebdbd4cf482 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitter for purity RB. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.md index aa6434746b3..cd6678b16ff 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.md index 853da1bd407..5c89a7aba32 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.md index 3a16e469600..6abf51cec2e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.md index 1d4c9a2b8ff..c6524de5a29 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.md index 23e8a604805..c3854fe866b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.gates_per_clifford.md index 12b312b6606..ab98f853ce3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.md index 6ecae0de7c7..6ef54c17ae1 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.27/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") The raw feature vector circuit. diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.27/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.27/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.27/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.27/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.md index 8d94a664800..de0bf7bc9d6 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.md index 58f7a5cd1ca..ca5963e99cd 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.27/qiskit.opflow.anti_commutator.md index 707f53ac858..fb408209fdd 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.commutator.md b/docs/api/qiskit/0.27/qiskit.opflow.commutator.md index d1733a0b85b..d5d40b09107 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.md index 71e83825608..48ebbe7941e 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.md index 0c2082ae486..292d165e0a3 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.md index e24cc84de63..da3c686ca2b 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.md index eb9fa187fa6..c6964a48978 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.md index 877d5687496..4f3064c80af 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.md index 8a6916326d7..425bd278127 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.27/qiskit.opflow.double_commutator.md index 6ad64c090e8..850608b415b 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.md index 0008d1ba281..92b438392fb 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.md index 01965ad18f1..9e7bffdfd39 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.md index f37b64a5fb5..781d328deed 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.md index 0d432c8cff1..b362358f251 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 32d32c2b587..93a4756fe34 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.md index 17ed7374761..52619e0bc91 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.md index 43306334942..669fec7e20b 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.md index bf960e2698f..1988f1f115a 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.md index e8518cef03c..0c652c8734d 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.md index 1a3df80666b..ca66f92fc33 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.md index fdf350c314d..d46f1ee0f2a 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.md index 1f951aeddab..751922cdeec 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.md index 101d3c33823..ebc1296e137 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.md index 44194d5f04f..bf8ea9fd23c 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.md index f95770f1738..20a6c99656d 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.md index f7b5c9b5a29..45462b19951 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.md index dfa76447827..b57a610560e 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.md index abb19f47e5c..1377fe8dc30 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.md index 43d5e281feb..7b3b5bb2ff9 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.md index 9f54fdbdc23..3d65d5d4c53 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.md index 8f41fa3a5f6..55972daa363 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.md index 7ec10d6e24a..bfcede6c7f9 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.md index 157026b9b24..2eacb98e044 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.md index 1ae6e337d8c..13b16a78202 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.md index ef0f9a593c3..ba4227a807b 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.md index 693007f5478..bdfcd6a0a74 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.md index 1f1700876d1..4c0566de079 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.md index dcaff673076..e1a9cab46dc 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.md index e7c1724d624..1eec993539a 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.md index 429e2c35ddd..68f41baa43b 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.md index 481377d1d21..73da1702b17 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.md index 9aae3c6f473..d55ef90b087 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.md index 744b19c7ed4..da79bc56dc6 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.md index ca056f2a6cd..db3f2bdd4d8 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Class for Operators backend by Terra’s `SparsePauliOp` class. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.md index 76c38b6dcad..bf891dd4ad3 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 3a6c2da01dd..20b3eada75d 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.md index 5b9af319b6e..a3f1b4a6f80 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.md index 852c80aef91..54d5ceda6ff 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.md index abbfb1bef17..14fc1084715 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.md index d3b02b27786..8a6c7765394 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.md index af13baec6c4..d910c0c706f 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.md index a10c86c03ad..78933479645 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.md index ac2e50b5ea5..95cac10a5d9 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.md index 2256ab68862..b5f3204ada4 100644 --- a/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.27/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/opflow/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.md index 304150f966a..bd857c9c660 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.md index 674474f35f9..78e99bc2472 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 17af3a09858..1b6166ac65d 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") ADMMOptimization Result. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.md index 5a9e3ff4519..7386da93f22 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.md index 15f3262f99a..4e343ff6377 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.md index 7ee07742d82..362a537c445 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.md index 5ebec509d34..d60a3e2901f 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.md index 30263ad300e..60f4bec0f02 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.md index e8ab32b3942..2e874fdb345 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.md index 7652e7f56f4..fa46bb10223 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.md index ab548ee9a40..e9bb5ad2434 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index fd484fd9968..493aaf92877 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 9a551193b54..9423baa3dfb 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.md index 67ecb8e93b2..e82e9412126 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") An abstract class that implements multi start optimization and should be sub-classed by other optimizers. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 60a45207071..cfa0e08cc4a 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") An abstract class for optimization algorithms in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.md index 29a0d61797e..83b5a934e43 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A base class for optimization results. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.md index 9026c12b26f..5dbb92371d1 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index b3b2bbe8a76..dd89b22cb2f 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index 44f22ffb05d..3941cba02c8 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 0e30e198c16..a188258a27d 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.md index 83328d79f17..e88bae6e104 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.md index 39310570580..670335045ed 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A sample of an optimization solution diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md index c0e4c528922..30654adc846 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md @@ -26,7 +26,7 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_operator(weight_matrix, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Generate Hamiltonian for the clique. @@ -89,7 +89,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`satisfy_or_not(x, w, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`satisfy_or_not(x, w, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md index a80b94865a2..3054279f4fc 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md @@ -27,7 +27,7 @@ common module -`get_gset_result(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`get_gset_result(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Get graph solution in Gset format from binary string. @@ -47,7 +47,7 @@ Dict\[int, int] -`parse_gset_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`parse_gset_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read graph in Gset format from file. @@ -67,7 +67,7 @@ numpy.ndarray -`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate random Erdos-Renyi graph. @@ -92,7 +92,7 @@ numpy.ndarray -`random_number_list(n, weight_range=100, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_number_list(n, weight_range=100, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate a set of positive integers within the given range. @@ -115,7 +115,7 @@ numpy.ndarray -`read_numbers_from_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`read_numbers_from_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read numbers from a file @@ -135,7 +135,7 @@ numpy.ndarray -`sample_most_likely(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`sample_most_likely(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Compute the most likely binary string from state vector. :param state\_vector: state vector or counts. :type state\_vector: numpy.ndarray or dict diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md index 343cc6b736b..d966cb3984e 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md @@ -62,7 +62,7 @@ print('tsp objective:', result['energy'] + offset) -`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") +`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") Generate Ising Hamiltonian from a model of DOcplex. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md index 6eced2620c4..f974ade5491 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md @@ -24,7 +24,7 @@ exact cover -`check_solution_satisfiability(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`check_solution_satisfiability(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") check solution satisfiability @@ -32,7 +32,7 @@ check solution satisfiability -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") Construct the Hamiltonian for the exact solver problem. @@ -62,7 +62,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md index 2d3f7e88296..284fa2483c2 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md @@ -24,7 +24,7 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Generate Hamiltonian for the graph partitioning @@ -74,7 +74,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`objective_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`objective_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md index 6f9306be50f..f84a1081ee4 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md @@ -28,7 +28,7 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We -`get_operator(values, weights, max_weight)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_operator(values, weights, max_weight)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Generate Hamiltonian for the knapsack problem. @@ -67,7 +67,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`get_solution(x, values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_solution(x, values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian @@ -90,7 +90,7 @@ numpy.ndarray -`knapsack_value_weight(solution, values, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`knapsack_value_weight(solution, values, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the total wight and value of the items taken in the knapsack. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md index 0f7cd5d4d0f..4805af75417 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md @@ -24,7 +24,7 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Generate Hamiltonian for the max-cut problem of a graph. @@ -64,7 +64,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`max_cut_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`max_cut_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md index 451c7de04e4..4b11ba268e4 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md @@ -23,7 +23,7 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami -`get_operator(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`get_operator(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Construct the Hamiltonian for a given Partition instance. @@ -45,7 +45,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`partition_value(x, number_list)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`partition_value(x, number_list)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Compute the value of a partition. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md index 6fe5f8562f4..fb73f528287 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md @@ -24,7 +24,7 @@ set packing module -`check_disjoint(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`check_disjoint(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") check disjoint @@ -32,7 +32,7 @@ check disjoint -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") Construct the Hamiltonian for the set packing. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md index 2f6481bbfd8..49ec6bef7c5 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md @@ -24,7 +24,7 @@ Convert stable set instances into Pauli list. We read instances in the Gset form -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_operator(w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Generate Hamiltonian for the maximum stable set in a graph. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`stable_set_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`stable_set_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Compute the value of a stable set, and its feasibility. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md index e5f3da7c799..7cdddb409d5 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md @@ -90,7 +90,7 @@ Alias for field number 3 -`calc_distance(coord, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`calc_distance(coord, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") calculate distance @@ -98,7 +98,7 @@ calculate distance -`get_operator(ins, penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_operator(ins, penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate Hamiltonian for TSP of a graph. @@ -119,7 +119,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_tsp_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_tsp_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Get graph solution from binary string. @@ -145,7 +145,7 @@ Instance data of TSP -`parse_tsplib_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`parse_tsplib_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Read graph in TSPLIB format from file. @@ -165,7 +165,7 @@ instance data. -`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate a random instance for TSP. @@ -190,7 +190,7 @@ instance data. -`tsp_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Check whether a solution is feasible or not. @@ -210,7 +210,7 @@ bool -`tsp_value(z, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_value(z, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Compute the TSP value of a solution. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md index cb9da8e8f25..5f65ba76a71 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md @@ -25,7 +25,7 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela -`get_operator(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_operator(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Converts an instance of a vehicle routing problem into a list of Paulis. @@ -47,7 +47,7 @@ operator for the Hamiltonian. -`get_vehiclerouting_cost(instance, n, K, x_sol)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_cost(instance, n, K, x_sol)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Computes the cost of a solution to an instance of a vehicle routing problem. @@ -70,7 +70,7 @@ objective function value. -`get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_matrices(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Constructs auxiliary matrices from a vehicle routing instance,** @@ -94,7 +94,7 @@ a matrix defining the interactions between variables. a matrix defining the cont -`get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_solution(instance, n, K, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Tries to obtain a feasible solution (in vector form) of an instance** diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md index 5ed46e10885..e7a7f6ca931 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md @@ -24,7 +24,7 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https -`check_full_edge_coverage(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`check_full_edge_coverage(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") **Parameters** @@ -43,7 +43,7 @@ float -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Get graph solution from binary string. @@ -63,7 +63,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. :type weight\_matrix: numpy.ndarray diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.md index f8f704a52fc..29350019ea1 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.md index 2f5c80c1ef7..99f0adf8fe1 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.md index f024d2ee2e8..0dc4616b504 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.md index ab03f35f781..f9a975f909a 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") An abstract class for converters of quadratic programs in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.md index a8104b0ac7b..d4c568df7fa 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a given optimization problem to a new problem that is a QUBO. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.md index 93bc81c16d2..cf06eb77f61 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Abstract Constraint Class. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.md index ea2a6195930..333c6c421ac 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Representation of a linear constraint. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.md index 7d29ca84a02..571ef9bdd64 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.md index a4b05490665..fb524232154 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.md index b3a3d449e0a..98483913d00 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.md index 9b7213f270b..f8bfa4ff1d9 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.md index 37612451790..31d5a1779dd 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.md index e823ffa405e..fa73300a3d2 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.md index 284a7cdc3eb..059a4253795 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Representation of a variable. diff --git a/docs/api/qiskit/0.27/qiskit.providers.Backend.md b/docs/api/qiskit/0.27/qiskit.providers.Backend.md index 27965da709f..26ee0aa9929 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.27/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.md index 6d4a52d2aea..ffca01c35cc 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.27/qiskit.providers.BackendV1.md index ec61a6906be..a4c068000dc 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.27/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/backend.py "view source code") Abstract class for Backends diff --git a/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.md index 4e9335e8cba..d266197603e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.27/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basebackend.py "view source code") Legacy Base class for backends. diff --git a/docs/api/qiskit/0.27/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.27/qiskit.providers.BaseJob.md index 5beccfe7ce7..cfb4d82c484 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py "view source code") Legacy Class to handle asynchronous jobs diff --git a/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.md index 06c4152aad1..faa0a818fbd 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.27/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/baseprovider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.27/qiskit.providers.Job.md b/docs/api/qiskit/0.27/qiskit.providers.Job.md index 1c855b5d67e..5b1ca9e7630 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.27/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobError.md b/docs/api/qiskit/0.27/qiskit.providers.JobError.md index f77462fa523..ba986ac2595 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.27/qiskit.providers.JobStatus.md index 656412ee927..fa48efbbb96 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.27/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/jobstatus.py "view source code") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.md index ec482d8a579..0f3c561a96e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.27/qiskit.providers.JobV1.md b/docs/api/qiskit/0.27/qiskit.providers.JobV1.md index 2206017267e..99ddbd07769 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.27/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py "view source code") Class to handle jobs diff --git a/docs/api/qiskit/0.27/qiskit.providers.Options.md b/docs/api/qiskit/0.27/qiskit.providers.Options.md index 1d72f8e5622..92a63938cf6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.27/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py "view source code") Base options object diff --git a/docs/api/qiskit/0.27/qiskit.providers.Provider.md b/docs/api/qiskit/0.27/qiskit.providers.Provider.md index c8083cac943..3e34ef3b670 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.27/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.md index f18b14a9893..868bdfe5e7a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/provider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.md index 2b6f8d2458c..e2fb65a710d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.md index 2ee285ecc30..962f5d96008 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.md index a5f72fae952..7a37fccd21e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") AerJob class. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.md index 6baae661743..9f0aa5ad188 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.md index d4ecef6e1a4..b577121c0d3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.md index aae39c50b40..26038944531 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Pulse schedule simulator backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.md index 478eff1c779..6de36e122bd 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.md index 1b8736e1fc7..2bfa769ee7a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.md index 67af4b97c18..f33e13f5717 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.md index 066992c8407..df6a08bd898 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index ffe92423a6e..e569f4a78f6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Snapshot instruction for density matrix method of Qasm simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 7f79bbd276f..f17e67e2cda 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Snapshot instruction for supported methods of Qasm simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.md index ddb9a6d0618..7c7cb7c67a8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Snapshot instruction for all methods of Qasm simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 23fb21d1734..d7abca1d82e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Snapshot instruction for stabilizer method of Qasm simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.md index 6ad06288c23..444d19880c6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Snapshot instruction for statevector snapshot type diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.md index 4249e0b58db..b508cde6e54 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.md index 5145be163fd..3b9e1ac52c3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.md index 58f06adf8c2..28846ba4e0b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save a reduced density matrix. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.md index cc701db53b7..51cb318f0c7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value of an operator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 2c86695c951..708d6699363 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.md index f31dd2f5238..067432b4498 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save matrix product state instruction diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.md index 36e7f8ffb9f..87820b5c042 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.md index aa47a2401a5..9fb5f063512 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.md index 3e23b97c24b..1718829f0a4 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save Stabilizer instruction diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.md index 036e7471bfd..920a51b5ef6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save simulator state diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.md index 8ac28acac38..31c040b6dd2 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.md index 0d8625397cd..9b54b2dd98e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.md index 1777a39b185..5ff8e62cc1c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.md index 75eda5796a5..8b525c47e61 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save Unitary diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.md index ec7f72cca70..5f8532d50fe 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.md index 0a8ae348968..364f17e8962 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.md index ebbe1d257d4..5edbc66cdc7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.md index eac31f48437..a16a58c966e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.md index 4c9e01519d5..3395c79fa14 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set superop state of the simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.md index cba8cb98d92..d78ffe14ce8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes.md index 0b669b04105..c34cc5ee857 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes_squared.md index 79bb40eff0c..fdac25ecd47 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_density_matrix.md index 74cc65ec146..1e650bd5b06 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value.md index 2f0af0f1bc9..7d4ffada7f8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value_variance.md index dd1ed4ef639..b591246f76c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_matrix_product_state.md index e77c2db58c1..4db8d3ff042 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities.md index 606b66af4ea..a2eaecff1b7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities_dict.md index 16ae2c687ca..086ffe552f5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_stabilizer.md index d01c85e1c12..3e086d79eaf 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_state.md index 07e5c762060..5cd6ad9855d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector.md index 482606c1893..5dc73b693ee 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector_dict.md index a1f1dc7b1e3..367fbad5b48 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_unitary.md index 73d179e5f2e..06fe9ae787d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_density_matrix.md index bee816e1bb8..51fec524b7e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_matrix_product_state.md index 2db259b4d51..6c1f7c0873a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_stabilizer.md index 31c78105b09..e31c686988f 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_statevector.md index 63b8fb72b15..166311867bd 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_superop.md index 28725784533..a2acde4da8a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_unitary.md index 3755cd50221..0549bfa7dae 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.md index 8a585149850..e7c214d97fc 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Noise model class for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.md index 1fc3e9bcb73..e953bdcab69 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Quantum error class for Qiskit Aer noise model diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.md index fd3891e02af..cc43a7ab1d3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Readout error class for Qiskit Aer noise model. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.amplitude_damping_error.md index 0305f120e20..1fc12ab472e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.coherent_unitary_error.md index de1107669a4..aa2837fad3b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.depolarizing_error.md index 2505d42afae..a0face8dffa 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index bc242d7510e..b7c298bd8e5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index c62af1cd229..3821d29c4e8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_error_values.md index 2b1bc8469bf..7b65ff11d8f 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_length_values.md index be7ea78eba1..69721d2f87d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_param_values.md index e657b1665df..9c81011bd27 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.readout_error_values.md index 97d13adc45c..18730236d34 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index dd116379a5f..18946d6a22b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.kraus_error.md index a35fecba148..4585336fd09 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.mixed_unitary_error.md index 0669b855ab3..69625c92fe6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.pauli_error.md index c92b7ceed49..cdec5fd9b84 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index b76a0b6f054..9d1fedfdf22 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_damping_error.md index 29082f182c5..571f69680b8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.reset_error.md index d44921cd510..c9c5a2c0aa1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.thermal_relaxation_error.md index 09ab8cb4351..5625c43ea4d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.md index a229bde8f91..625add9df89 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Physical model object for pulse simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.duffing_system_model.md index c880b5f09ee..11af83e0ecf 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.md index de7ab8ff080..974c0f09a10 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transforms one quantum channel to another based on a specified criteria. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_noise_model.md index 2f5e3d6397b..014084327f7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_quantum_error.md index 621da3e103e..6182b1978a7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.insert_noise.md index f907d1624eb..ba98e295c3c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.remap_noise_model.md index 02927d984ec..1ac257dc970 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.27/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.md index 26dc5dfdbfe..cd3623b8d65 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.md index 900892fec4d..d272271dfb7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerjob.py "view source code") BasicAerJob class. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.md index 9699d9c1257..3550986bee5 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/basicaerprovider.py "view source code") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.md index b2b8eeca532..76b892ef2a4 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/qasm_simulator.py "view source code") Python implementation of a qasm simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 07fef07a999..f4072c4562b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/statevector_simulator.py "view source code") Python statevector simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.md index 2d92a797b2c..a90d1e8bdd0 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.27/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basicaer/unitary_simulator.py "view source code") Python implementation of a unitary simulator. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.md index e80c085997c..cdc0ffb3c18 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/accountprovider.py "view source code") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.md index bcf48bdd75f..46cab8d6382 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/backendjoblimit.py "view source code") Job limit for a backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index e04c5b4eb07..548da0e2078 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 8d0b37f22be..83cdff98585 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 644280f4f67..2168011d2f1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index c5ab07fb591..775ed876dcc 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.md index fb0446e286c..56b61467a1e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 396765cafd7..6ce1da261c4 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md index 60087735631..0b79be15500 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/ibmqbackend.py "view source code") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.md index a73831b8b01..30bd49f0079 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 820f0598fd5..0da8e896c34 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.md index 6cb21981b34..57e57f95c8a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.md index 3b7cb6232c7..8a59a4cf76c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.md index 1a14be1f5f6..eb27d425c56 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.md index 04781636529..954c2387f4d 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.md index 617fe100c9a..0877e661232 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/ibmqfactory.py "view source code") Factory and account manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.md index 8210d5d4222..9c6746cee27 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.md index 31c44c3848c..1afad68d0a7 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runner_result.py "view source code") Result class for Qiskit Runtime program circuit-runner. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.md index c43b4322946..54a744aa3c0 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/credentials.py "view source code") IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.md index 03a4cbb7d90..5abbf4baec9 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index abe825a7e2b..9c327e369d1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index de441e18a70..88961ddf336 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.md index e5994903d34..ac47f852bdf 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.AnalysisResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult -`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None, verified=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") +`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None, verified=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") Class representing an analysis result for an experiment. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.md index cf2208ce476..97bd8093df0 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.Experiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment -`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None, notes=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/experiment/experiment.py "view source code") +`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None, notes=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/experiment/experiment.py "view source code") Class representing an experiment. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.md index 254641d839e..be0bbec27b4 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.experiment.ExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService -`ExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") +`ExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") Provides experiment related services. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.md index 5af881596f1..180f47d8126 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.md index ec7bb326937..9b67ca04a27 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.md index d88a041e7ed..ef320c91da6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.md index e1f4b089df3..fc1061b9773 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 282e948973c..6f4a8eec670 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index a57564f71f8..adf77d6765e 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.md index 86c78d8f660..4ba31a38d66 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.job_monitor.md index 2f701138ce8..85353602bdc 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.least_busy.md index d78b0b63564..f4041433daf 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.md index 39a64650878..35d5eb7f255 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 61f155dd17d..246554dc589 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index ad78a380fcf..f38f88e5471 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 3244aefe0d5..1314593663f 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 6c28406e072..fe4a38c15d8 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 3fd4e11ea38..804ccd316b1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 0a7acb4edb3..32d9e86bec1 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.md index 81cadacb4ef..a0d7340bddd 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/managedjob.py "view source code") Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.md index 7586489bbb4..50dcf368e79 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/managedjobset.py "view source code") A set of managed jobs. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.md index 5e9b6e9a1d7..830d859c754 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/managed/managedresults.py "view source code") Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.md index 268ab402ec7..28be53ec09a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.md index 1201116e4c5..71b0ee920e2 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.md index 98969cf929d..6d1c24d79a6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 03f06971547..66e93bb8678 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.md index b1060f06ddf..24e0cf73aee 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Base class for a program backend. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.md index fffdeb45164..4dd90e10cba 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Runtime job result decoder. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.md index a55374409ff..dafa9351574 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.md index d4f7f183488..ca03a38f0ed 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Class representing program metadata. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.md index b563456cc54..89cb2b1def0 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.seconds_to_duration.md index 71881b6de76..f2392a27ba4 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.to_python_identifier.md index 0a101c4bd84..4f59dc92e13 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.update_qobj_config.md index dfe412b5cb0..4f1eb336a91 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.utc_to_local.md index 97b7c505d78..780fa2d2d9b 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.validate_job_tags.md index 667a2ba9fb4..6e24ce2d124 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.14/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.md index ea62d3e3e9f..ae999514881 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Backwards compat shim representing an abstract backend configuration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.md index 394373d8a47..3fd560ff7ed 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendproperties.py "view source code") Class representing backend properties diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.md index d85c5bfb269..0162db0c57f 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendstatus.py "view source code") Class representing Backend Status. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.Command.md b/docs/api/qiskit/0.27/qiskit.providers.models.Command.md index 46b89d29b8f..a8bfdc69fd6 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") Class representing a Command. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.md index 28f63b0af7f..de21daf0e6c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Gate Configuration diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.md index 2d6c9ffb6eb..aceea0dcb19 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/jobstatus.py "view source code") Model for JobStatus. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md index cf2ea888aa3..17d320ba57c 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.md index 146cc3cfce6..d418bf7c7ee 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/pulsedefaults.py "view source code") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.md index a70a0a1e70d..7ac17865809 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Qasm Backend Configuration. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.md index d0d3331c6ba..4d99722c34a 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a U Channel LO diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md index 72f12354374..39b4110e664 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md index 7104f339ff5..bf6db5b03f0 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Call.md b/docs/api/qiskit/0.27/qiskit.pulse.Call.md index bdb134c5aec..9b1a7864064 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Constant.md b/docs/api/qiskit/0.27/qiskit.pulse.Constant.md index 7474845609c..8b8c72b4d5f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md index 5dea4fbfbd8..3583ff4c728 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Delay.md b/docs/api/qiskit/0.27/qiskit.pulse.Delay.md index a6331b59ac3..fbb8e8a4d5c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Drag.md b/docs/api/qiskit/0.27/qiskit.pulse.Drag.md index fa3d4820342..0b527cd4eb5 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md index 6e0feba01f1..abf5ca2fecb 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.md index 12ff45af77e..cc6646f4c59 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.md index b1db30256f6..1dbc14c0087 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md index 2c84e0a3425..f2fa53f4979 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.md index 8bd186075b4..b7dee2415fb 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instruction_schedule_map.py "view source code") Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md index 9d661b317d8..04b0993759d 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md index 0ef342e2e8e..23dfdad04f2 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Play.md b/docs/api/qiskit/0.27/qiskit.pulse.Play.md index 8291004209c..915c362b404 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.27/qiskit.pulse.PulseError.md index 963cd6c9685..12d2af8c9ee 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md index 7a8e1fca2fa..e72deb06365 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md index 9b92cfab1ab..174f2546abf 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md index 5164eaef864..8be0481bc9d 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/schedule.py "view source code") A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md index 3df4a86fda5..64c589e200c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md index 1aceeec1749..d1cbc30559f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md index 33c38b6d65b..5c16a6d85a7 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md index 8cb59125556..df8548a4aed 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md index a94951dbe72..f969c52c4ce 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.27/qiskit.pulse.Waveform.md index 8914ca0321b..4c1416c3b75 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md index ba6fd3cb433..9df544b6074 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md index d5543331cb8..7426c83d45b 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.active_backend.md index 6e7d992cf44..cda31c0584e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 7514aade0a3..da3c358f83c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.active_transpiler_settings.md index a930c6dfa06..4aaa72f577a 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_equispaced.md index 662f56b4b67..f58037e7344 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_func.md index 39ec0164ea7..d7f47f661e1 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_left.md index 9dc6b03b3a0..688e95bcae9 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_right.md index 11f05cb8223..e9af2d88da4 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_sequential.md index 92e6a3b4a8c..b4e78bb7c96 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md index 3a7c88ca5df..5e1b78eb817 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.build.md index e79e8c0c309..25cae57b603 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.call.md index 23123ce373d..e687ce5a30a 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.circuit_scheduler_settings.md index fbd0dd14a3f..adc1d755097 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md index fbe9d517782..c061c8919a0 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.cx.md index 28d0ac24d19..123b1a5d4f0 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md index 4f61e2869d0..cd38cd2c003 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.delay_qubits.md index 5260733e787..62e6cf4c68f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md index 830b1f50e7a..c432b1674a9 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md index d3f825feb9f..ba4b6d3dd2d 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.inline.md index 9eee0def1cc..f4cdbd312e3 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md index d172ff13c74..83a017ffcbe 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md index 1d3bf31c2ad..0bf66b239fb 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md index 3d2b1732509..c4f1a134858 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.num_qubits.md index 08e12f8e9a3..abc9f880d25 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md index 1a6ad5573bb..a0ba75ce432 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md index 772a71d232c..d194283075b 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md index a842a673bc8..449b66114d2 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md index 7cec574e84b..0dbb63b9521 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.samples_to_seconds.md index 6070f10a697..3ae963be5fd 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.seconds_to_samples.md index 3a60cdecbb1..e39c80647b2 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md index 87e5b588b7b..1252859cc60 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md index c85e44c392f..ff27ecbcb98 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md index 58142ca9fbb..f542a55226f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md index 96eb4a67d7d..fa83897b4d9 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.snapshot.md index 2a3d4b14013..a867310092e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.transpiler_settings.md index 96faf4f5d07..4fd275e4e61 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.u1.md index baad5b5652b..c64da80352a 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.u2.md index f6b6308a9b5..cd42c6c18ea 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.u3.md index a0f420f64ef..ffb35a051b5 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.x.md index e745b3380e7..fed0e3109b2 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.channels.md b/docs/api/qiskit/0.27/qiskit.pulse.channels.md index e5222160a22..fc5f8e4afb5 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.channels.md @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. @@ -119,7 +119,7 @@ Parameters which determine the channel index. -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -216,7 +216,7 @@ A shorthand string prefix for characterizing the channel type. -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. @@ -301,7 +301,7 @@ Parameters which determine the channel index. -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. @@ -386,7 +386,7 @@ Parameters which determine the channel index. -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. @@ -471,7 +471,7 @@ Parameters which determine the channel index. -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. @@ -556,7 +556,7 @@ Parameters which determine the channel index. -`PulseChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`PulseChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Base class of transmit Channels. Pulses can be played on these channels. @@ -641,7 +641,7 @@ Parameters which determine the channel index. -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). @@ -726,7 +726,7 @@ Parameters which determine the channel index. -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/channels.py "view source code") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md index 11fdb9167e5..e79404c2bf8 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md index 44d242dbb6f..f0eccf9901a 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md index dabc5660778..50cee606ea0 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md index 7cb7777c5d9..b990ff42a5e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md index dd53254d1da..67b13fa4fd4 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md index fe562941083..405372f8265 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md index 5a9fdb8ecc8..6aa92c81c51 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md index c1068485c86..8d21abe1d02 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md index b45bb0b93df..09c027cddd2 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md index 12fd63f17a1..31c52025356 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.md index c88f8591e55..d87aed08138 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.md index 54baca7dfd0..9b8e763699f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.md index 05fcfbf83ff..ec2c1e64472 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.md index d58bb1f5857..e514a61950e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/parametric_pulses.py "view source code") A square pulse with a Gaussian shaped risefall on either side: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.md index 13e95d0301a..4809ac760d3 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md index a9ec40c6100..bacc0c58e98 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md @@ -36,7 +36,7 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -60,7 +60,7 @@ $$ -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -86,7 +86,7 @@ $$ -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -121,7 +121,7 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -159,7 +159,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -186,7 +186,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -226,7 +226,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -274,7 +274,7 @@ plt.plot(range(duration), sawtooth_wave) -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -310,7 +310,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -337,7 +337,7 @@ i.e. the derivative of $\text{sech}$. -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -363,7 +363,7 @@ $$ -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -391,7 +391,7 @@ with the convention $\text{sign}(0) = 1$. -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -439,7 +439,7 @@ plt.plot(range(duration), triangle_wave) -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). diff --git a/docs/api/qiskit/0.27/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.27/qiskit.pulse.transforms.add_implicit_acquires.md index 4497fef18a6..eafa3ed254f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.27/qiskit.pulse.transforms.align_measures.md index 04563d745b3..4b364642e68 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md index c895d5da79f..b2b9d649213 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/alignments.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/transforms/alignments.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.md index 577e304c4c6..1a949167785 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.27/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.27/qiskit.qasm.Qasm.md index e92aff70902..a3054466f17 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.27/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.27/qiskit.qasm.QasmError.md index cac8b1467d8..eb8dbe90a96 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.27/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.md index d72e1a35777..ac3afb48e54 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.27/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.md index f10c4d80efe..90c2e68a134 100644 --- a/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.27/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.md index e642e5e4f4d..680063fad15 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.md index 4699723760b..7b93a15eac9 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") An item in a pulse library. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.md index b031efa6af3..be6c7177d15 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.md index 95c4a83c154..18ca521f7b3 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A configuration for a Pulse Qobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.md index 4f4c90e8843..58045890a6e 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj Experiment. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.md index 37f59007662..f91ee4d1e56 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A config for a single Pulse experiment in the qobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.md index ded4d145766..15cd2341326 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") A class representing a single instruction in an PulseQobj Experiment. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.md index 80ec0d1289c..4165f68b66a 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.md index 052bb4cfc8d..7290308a586 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.md index 342dc1b709f..d48dbd8d6e3 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A configuration for a QASM Qobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.md index 297965a8b59..553f6b6c3ce 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj Experiment. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.md index a74860268c0..e089a77c448 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") Configuration for a single QASM experiment in the qobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.md index 72c03b88672..ac64386d7ed 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/qasm_qobj.py "view source code") A class representing a single instruction in an QasmQobj Experiment. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.27/qiskit.qobj.Qobj.md index ea560eb0bb9..b39646c58d9 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/__init__.py "view source code") A backwards compat alias for QasmQobj. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.md index 1169160923b..f4fb4e7db1c 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") A class representing a header dictionary for a Qobj Experiment. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.md index 923edaf5803..99480072acf 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/common.py "view source code") A class used to represent a dictionary header in Qobj objects. diff --git a/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.md index 47546c0bc50..caf01b74ce2 100644 --- a/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.27/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/qobj/pulse_qobj.py "view source code") An individual measurement option. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.md index 21ee5413aa0..7a09e6144e2 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.md index 3cfbe75f58e..73a64eb2745 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/chi.py "view source code") Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.md index ace84d19b8f..7491103a135 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/choi.py "view source code") Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.md index 50a0f218b26..762bb0793a2 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") An N-qubit unitary operator from the Clifford group. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.md index dbfa795c218..0356f840ec8 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/densitymatrix.py "view source code") DensityMatrix class diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.md index 37e0ffcc6b8..67d26ec0284 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/kraus.py "view source code") Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.md index 8b94c23432e..05260b2d294 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.md index f3da2c57373..70fabbff5c6 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/operator.py "view source code") Matrix operator class diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.md index f2a553262a6..18dc0fea2a0 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/ptm.py "view source code") Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.md index 83c2e430dd0..3964c9d3d2f 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") N-qubit Pauli operator. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.md index 544fcac85ba..a1e17f94799 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Symplectic representation of a list Pauli matrices. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.md index 9d2734306fd..0f5f3c4e182 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/quaternion.py "view source code") A class representing a Quaternion. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.md index 6baec9a8335..44a3fc8cd1f 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/scalar_op.py "view source code") Scalar identity operator class. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.md index 78e6e5b8fcc..ad2b9bd9b6b 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sparse N-qubit operator in a Pauli basis representation. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.md index c01d923dfbd..8430cbd9753 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Symplectic representation of a list Stabilizer matrices. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.md index 7f28b42d06f..0225c1ce651 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/statevector.py "view source code") Statevector class diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.md index 2472ecd971c..68c7f943c83 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.md index 6a0e4908b36..c3166c4c81e 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/channel/superop.py "view source code") Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.md index fb4377a4923..4c4295fe82c 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.27/qiskit.quantum_info.average_gate_fidelity.md index 6d802aa7e1d..56e7e824816 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.27/qiskit.quantum_info.concurrence.md index 0765a817535..b426d9b3af1 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.27/qiskit.quantum_info.decompose_clifford.md index c8804c3188a..0bf0adb7d41 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.27/qiskit.quantum_info.diamond_norm.md index 183c70efb46..4b84c406c65 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.27/qiskit.quantum_info.entanglement_of_formation.md index 5d163f29f8a..451f890c196 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.27/qiskit.quantum_info.entropy.md index 7b0d105badb..938ad61e35c 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.27/qiskit.quantum_info.gate_error.md index 99d1a977ccc..e3c8fe2af31 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_distance.md index a337c6e0b7b..3fb0288ea24 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_fidelity.md index c1d8c27177b..8023c80c913 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.27/qiskit.quantum_info.mutual_information.md index 1caa0026154..72278bad311 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.27/qiskit.quantum_info.partial_trace.md index 1de7483f21b..8e3f1cf72dc 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_basis.md index 4aec52700e1..4794a2f838f 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_group.md index 34f566a176a..662a1d1bf90 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.27/qiskit.quantum_info.process_fidelity.md index 6be1eea06f7..ed367d74b3a 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.27/qiskit.quantum_info.purity.md index b67ea5ceaaf..d2407bd278e 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_clifford.md index 183e81f082c..c72131715a0 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_cnotdihedral.md index 0800959cdfb..8efd92543e1 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_density_matrix.md index c0bb5d0fe00..e684fa5f943 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_hermitian.md index 85f3e768c34..6d129ca5e65 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli.md index 3f22c443a65..194e2c8b8a5 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli_table.md index d5749747b63..2f0e987fcab 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_quantum_channel.md index 6638cdb0369..8807c0758cc 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_stabilizer_table.md index 314ab85ee58..a1a255afefa 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_statevector.md index 594a72133b6..c32e5e40c69 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.27/qiskit.quantum_info.random_unitary.md index a12d83dd53b..cdd50970c44 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.27/qiskit.quantum_info.shannon_entropy.md index d56cdea5872..0e2496c4305 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.27/qiskit.quantum_info.state_fidelity.md index 2075c83b415..92873e95470 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.27/qiskit.result.Counts.md b/docs/api/qiskit/0.27/qiskit.result.Counts.md index e914d0778f8..f8bf252ec42 100644 --- a/docs/api/qiskit/0.27/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.27/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/counts.py "view source code") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.md index 4dcba914422..fa446f5369d 100644 --- a/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/probability.py "view source code") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.md index c847bd95c4a..b8cd78d2509 100644 --- a/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.27/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/distributions/quasi.py "view source code") A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.27/qiskit.result.Result.md b/docs/api/qiskit/0.27/qiskit.result.Result.md index a628eba78cd..ae800b31d55 100644 --- a/docs/api/qiskit/0.27/qiskit.result.Result.md +++ b/docs/api/qiskit/0.27/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/result.py "view source code") Model for Results. diff --git a/docs/api/qiskit/0.27/qiskit.result.ResultError.md b/docs/api/qiskit/0.27/qiskit.result.ResultError.md index 2fcba4e322e..70502831c76 100644 --- a/docs/api/qiskit/0.27/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.27/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.27/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.27/qiskit.result.marginal_counts.md index 37c3ed5dd6d..953bed88628 100644 --- a/docs/api/qiskit/0.27/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.27/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.md index 96d2e2cb083..932b7c25a7e 100644 --- a/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.27/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md index 27cd8d0ce83..b370a2d7fbf 100644 --- a/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md @@ -23,7 +23,7 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat -`as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") +`as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. @@ -48,7 +48,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as late as -`as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") +`as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. diff --git a/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md index 1b7bc625d39..b811d97cb7c 100644 --- a/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md @@ -22,7 +22,7 @@ QuantumCircuit to Pulse scheduler. -`schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/schedule_circuit.py "view source code") +`schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. diff --git a/docs/api/qiskit/0.27/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.27/qiskit.tools.backend_monitor.md index d8413988e30..e153df4e07c 100644 --- a/docs/api/qiskit/0.27/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.27/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.27/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.27/qiskit.tools.backend_overview.md index e8c072870e2..5d4e4bf27aa 100644 --- a/docs/api/qiskit/0.27/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.27/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.27/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.27/qiskit.tools.job_monitor.md index 53be7b012a3..ec20a90e14b 100644 --- a/docs/api/qiskit/0.27/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.27/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.27/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.27/qiskit.tools.parallel_map.md index 8362d37af51..de590d737ce 100644 --- a/docs/api/qiskit/0.27/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.27/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.md index 5ba9f81b695..05f8ef60db6 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") An analysis pass: change property set, not DAG. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.md index dcd406965db..380659e6ca3 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/coupling.py "view source code") Directed graph specifying fixed coupling. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.md index e0db537efff..00c4c506e69 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.md index 420c65e728b..8b1c6bbbb87 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/fencedobjs.py "view source code") A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.md index 97ba461b0cc..87315fa24f0 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/runningpassmanager.py "view source code") Base class for multiple types of working list. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.md index 7b1de2f94d1..fc12c6d4463 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/instruction_durations.py "view source code") Helper class to provide durations of instructions for scheduling. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.27/qiskit.transpiler.Layout.md index 849af2cfa5b..a6a7062cfea 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/layout.py "view source code") Two-ways dict to represent a Layout. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.md index 086f6fa3ee3..b8825c5f152 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager.py "view source code") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.md index b54a78bd521..1439f488321 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passmanager_config.py "view source code") Pass Manager Configuration. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.md index 748e5bc3f42..d4b58c29788 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/propertyset.py "view source code") A default dictionary-like object diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.md index e7cd7afeacc..76b475b5aed 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/basepasses.py "view source code") A transformation pass: change DAG, not property set. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.md index 5fe8c1c6b20..6d321be3562 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.md index f6851bc33f9..98ed4cf78f8 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.md index 57c2ca55996..863c90d0d02 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/alap.py "view source code") ALAP Scheduling. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.md index 8adfcf17a68..2673143baf5 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/asap.py "view source code") ASAP Scheduling. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.md index 66453a91d79..0164a2c6389 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 2589a9b19ff..242ea824c24 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.md index eab63ae6252..7a107f1916b 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.md index 97a705f523e..aba0e636db1 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.md index aae7f08e35f..d896b32f826 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py "view source code") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.md index 88bf08911a1..513e93c2cc1 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.md index 1f31a15142e..a3691654e3a 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.md index d7e48675c31..987b6162d2d 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.md index 259a53186b0..4815eb08c0d 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.md index 2aa05b12680..c4c3e29b36c 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/check_map.py "view source code") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.md index 4366ab0460f..1f92d4d239d 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.md index 21036dccbf0..69dd13326a7 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.md index 87309fe9123..affe7e85d1f 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.md index d66525efafa..babd5857bbd 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.md index fd077e9b630..9e4f3d33ce0 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.md index d908982a246..cdde9254b01 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 565d067b9e3..920f77263db 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.md index a08754653c1..e8651bfb5d8 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.md index 64e90906592..505acb020ee 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.md index 2ae375b2461..32e27f7a467 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/decompose.py "view source code") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.md index 3cb1aba1946..75b09f55813 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.md index 5b716a41e99..6f7705b43d5 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/depth.py "view source code") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.md index 087cd389943..356a0b70e61 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.md index c73c3af2ab6..5445accb222 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.md index 91cb7ff4408..4605c389f53 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Allocate all idle nodes from the coupling map as ancilla on the layout. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.md index 65b936f52a4..295d98c78b9 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.md index bf9afe6a941..d8da88518cd 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.md index 245f35f2f60..462bab7d5ab 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 17add1c0022..34dfe1667e2 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index a7779eda46b..c5e6cc8b8da 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.md index 495ddf5b8a9..a1d055f3d1e 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.md index a057a25a2b0..6882e338c56 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index de374af8d9a..9efb0f64c49 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.md index f511a9101de..4910293a11b 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 67aba62b64b..87e0b4a5da1 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.md index e5e1b76caa6..9603449047c 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.md index b89d8b46fbe..e838547475c 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.md index 0f2e08b8fef..252299e05ee 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.md index 18c9a91e65a..c05329fb42a 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.md index 00d8827a66a..7d4a23d7fe8 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/set_layout.py "view source code") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.md index 4b368cc7029..5e26cc4e89b 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/size.py "view source code") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.md index b7c38858bc0..f747a700531 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.md index b7cda6673ba..45d9f76c88e 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.md index c52dfd598b4..8c2df4eefe3 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.md index 4b0e2a3342f..7a35a7886a2 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.md index e186403129e..fd98b3af5ea 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.md index bf95016280b..577b967e57e 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.md index 9daf803930e..6b9b00b0f15 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/basis/unroller.py "view source code") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.md index c359f02ff34..a9d5d40c28c 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/analysis/width.py "view source code") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index f1c559abbb1..4704fd2a77d 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 7c6a854c908..f316da9448f 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 73e3c35178e..d474d9db6a3 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index c4f7ea3a027..d0d211473c7 100644 --- a/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.27/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.md index 8bda33ba7ad..1eaf1e27566 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.27/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.27/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.27/qiskit.utils.apply_prefix.md index e1a21283e3c..a2e0412392a 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.27/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.27/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.27/qiskit.utils.deprecate_arguments.md index beef229b5e7..946438f30b3 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.27/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.27/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.27/qiskit.utils.deprecate_function.md index 3d4cd31040b..25307ea72d3 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.27/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.27/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.27/qiskit.utils.get_entangler_map.md index 5955ba2b9db..79f19231eac 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.27/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.27/qiskit.utils.has_aer.md b/docs/api/qiskit/0.27/qiskit.utils.has_aer.md index cc0af41aebd..ef60c5839f9 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.27/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.27/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.27/qiskit.utils.has_ibmq.md index 79af8d8f31a..a1c46b7b40b 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.27/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.27/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.27/qiskit.utils.is_main_process.md index 7f1b0a64d19..b25c5a29882 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.27/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.27/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.27/qiskit.utils.local_hardware_info.md index b07303b2156..d6c47db28aa 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.27/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.27/qiskit.utils.name_args.md b/docs/api/qiskit/0.27/qiskit.utils.name_args.md index a3c5cb59400..6fbf128f4a8 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.27/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.27/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.27/qiskit.utils.summarize_circuits.md index 8cd4d5b973f..03b31d82a19 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.27/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.27/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.27/qiskit.utils.validate_entangler_map.md index de6cf9bce13..a4bd4f0a6e0 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.27/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.md index ef32933e75b..dfbedd852a0 100644 --- a/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.27/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.27/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.27/qiskit.validation.jsonschema.validate_json_against_schema.md index 9433c912dd0..9aad9cfb8d7 100644 --- a/docs/api/qiskit/0.27/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.27/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.md index 78e1a473a49..f3611d669bf 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.27/qiskit.visualization.array_to_latex.md index 5550e0ceec0..ded76053b0b 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.27/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.27/qiskit.visualization.circuit_drawer.md index 3039058c69a..ff01f672afa 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.27/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.27/qiskit.visualization.dag_drawer.md index a8f9a24dee7..f8c930043fa 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.27/qiskit.visualization.pass_manager_drawer.md index c8695d1bd56..4174720f188 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_multivector.md index 65289afa3e7..bfe2e18fca6 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_vector.md index ad01d9df8f4..d147b05a1c8 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_circuit_layout.md index 3eda22cc137..82d39dccff2 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_error_map.md index f4942a74fb9..20f4f0028e6 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_gate_map.md index 69b4d4c5801..b8711da71cf 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=24, line_width=4, font_size=12, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_histogram.md index 2ba4d71cc87..1d4c0279a82 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_city.md index 3fc11adb66e..451ab85d709 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_hinton.md index 3d585f20a31..f7f6ef3503a 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_paulivec.md index 7a47d333878..ab2040b6e46 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_qsphere.md index eeac6aeead2..2254276fb11 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.md index bd30d0b8511..fcf7d067917 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.md index 366c64f3f18..c5d1f49e6d8 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.md index 57ab433773b..5e11e2c50f1 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md index 1f4b5fccdad..328e08a0fe3 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.md index 92419a554ef..b6c1487a8e2 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/qcstyle.py "view source code") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.27/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.27/qiskit.visualization.timeline.draw.md index 72977e21be2..6b9bc0bb6de 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.27/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.27/qiskit.visualization.visualize_transition.md index cfaf5429544..a1f06a92596 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From e7363daccfb3028c5952874a5a741e813e1c01ed Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:24:32 +0100 Subject: [PATCH 09/41] Regenerate qiskit 0.28.0 --- docs/api/qiskit/0.28/execute.md | 2 +- docs/api/qiskit/0.28/logging.md | 2 +- .../0.28/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.28/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.28/qiskit.algorithms.Grover.md | 2 +- .../0.28/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.28/qiskit.algorithms.HHL.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 2 +- .../0.28/qiskit.algorithms.LinearSolver.md | 2 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.algorithms.NumPyLinearSolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.28/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.28/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.28/qiskit.algorithms.Shor.md | 2 +- .../0.28/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.28/qiskit.algorithms.VQE.md | 2 +- .../0.28/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.28/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.28/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.28/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.28/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.28/qiskit.algorithms.optimizers.GSLS.md | 2 +- ...t.algorithms.optimizers.GradientDescent.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.28/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.28/qiskit.algorithms.optimizers.SPSA.md | 2 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 2 +- .../0.28/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.28/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.28/qiskit.aqua.QuantumInstance.md | 2 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 2 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 2 +- ...ua.algorithms.AmplitudeEstimationResult.md | 2 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 2 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 2 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 2 +- .../qiskit/0.28/qiskit.aqua.algorithms.EOH.md | 2 +- .../qiskit.aqua.algorithms.Eigensolver.md | 2 +- ...iskit.aqua.algorithms.EigensolverResult.md | 2 +- .../0.28/qiskit.aqua.algorithms.Grover.md | 2 +- .../qiskit.aqua.algorithms.GroverResult.md | 2 +- .../qiskit/0.28/qiskit.aqua.algorithms.HHL.md | 2 +- .../0.28/qiskit.aqua.algorithms.HHLResult.md | 2 +- .../0.28/qiskit.aqua.algorithms.IQPE.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.LinearsolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 2 +- ...qua.algorithms.MinimumEigensolverResult.md | 2 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 2 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 2 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 2 +- .../0.28/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.28/qiskit.aqua.algorithms.QGAN.md | 2 +- .../qiskit/0.28/qiskit.aqua.algorithms.QPE.md | 2 +- .../0.28/qiskit.aqua.algorithms.QSVM.md | 2 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 2 +- .../0.28/qiskit.aqua.algorithms.Shor.md | 2 +- .../0.28/qiskit.aqua.algorithms.Simon.md | 2 +- .../0.28/qiskit.aqua.algorithms.SklearnSVM.md | 2 +- .../qiskit/0.28/qiskit.aqua.algorithms.VQC.md | 2 +- .../qiskit/0.28/qiskit.aqua.algorithms.VQE.md | 2 +- .../qiskit/0.28/qiskit.aqua.circuits.CNF.md | 2 +- .../qiskit/0.28/qiskit.aqua.circuits.DNF.md | 2 +- .../qiskit/0.28/qiskit.aqua.circuits.ESOP.md | 2 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 2 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 2 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 2 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 2 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 2 +- ...aqua.components.feature_maps.FeatureMap.md | 2 +- ...omponents.feature_maps.RawFeatureVector.md | 2 +- ...t.aqua.components.initial_states.Custom.md | 2 +- ....components.initial_states.InitialState.md | 2 +- ....components.initial_states.VarFormBased.md | 2 +- ...kit.aqua.components.initial_states.Zero.md | 2 +- ...mponents.multiclass_extensions.AllPairs.md | 2 +- ...lticlass_extensions.ErrorCorrectingCode.md | 2 +- ...lticlass_extensions.MulticlassExtension.md | 2 +- ...ts.multiclass_extensions.OneAgainstRest.md | 2 +- ...s.neural_networks.DiscriminativeNetwork.md | 2 +- ...nents.neural_networks.GenerativeNetwork.md | 2 +- ...ents.neural_networks.NumPyDiscriminator.md | 2 +- ...ts.neural_networks.PyTorchDiscriminator.md | 2 +- ...onents.neural_networks.QuantumGenerator.md | 2 +- .../qiskit.aqua.components.optimizers.ADAM.md | 2 +- .../qiskit.aqua.components.optimizers.AQGD.md | 2 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 2 +- .../qiskit.aqua.components.optimizers.CG.md | 2 +- ...iskit.aqua.components.optimizers.COBYLA.md | 2 +- .../qiskit.aqua.components.optimizers.CRS.md | 2 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 2 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 2 +- .../qiskit.aqua.components.optimizers.ESCH.md | 2 +- .../qiskit.aqua.components.optimizers.GSLS.md | 2 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 2 +- ...qiskit.aqua.components.optimizers.ISRES.md | 2 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 2 +- ....aqua.components.optimizers.NELDER_MEAD.md | 2 +- .../qiskit.aqua.components.optimizers.NFT.md | 2 +- ...it.aqua.components.optimizers.Optimizer.md | 2 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 2 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 2 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 2 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 2 +- .../qiskit.aqua.components.optimizers.SPSA.md | 2 +- .../qiskit.aqua.components.optimizers.TNC.md | 2 +- ....components.oracles.CustomCircuitOracle.md | 2 +- ...ponents.oracles.LogicalExpressionOracle.md | 2 +- .../qiskit.aqua.components.oracles.Oracle.md | 2 +- ...qua.components.oracles.TruthTableOracle.md | 2 +- ...qua.components.reciprocals.LongDivision.md | 2 +- ...a.components.reciprocals.LookupRotation.md | 2 +- ....aqua.components.reciprocals.Reciprocal.md | 2 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 2 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 2 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 2 +- ...els.MultivariateVariationalDistribution.md | 2 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 2 +- ....uncertainty_models.UniformDistribution.md | 2 +- ...certainty_models.UnivariateDistribution.md | 2 +- ...odels.UnivariateVariationalDistribution.md | 2 +- ...ncertainty_problems.MultivariateProblem.md | 2 +- ...uncertainty_problems.UncertaintyProblem.md | 2 +- ...lems.UnivariatePiecewiseLinearObjective.md | 2 +- ....uncertainty_problems.UnivariateProblem.md | 2 +- ...nents.variational_forms.VariationalForm.md | 2 +- .../qiskit.aqua.operators.OperatorBase.md | 2 +- ...qua.operators.converters.AbelianGrouper.md | 2 +- ...qua.operators.converters.CircuitSampler.md | 2 +- ...aqua.operators.converters.ConverterBase.md | 2 +- ...a.operators.converters.DictToCircuitSum.md | 2 +- ...a.operators.converters.PauliBasisChange.md | 2 +- ...aqua.operators.evolutions.EvolutionBase.md | 2 +- ...a.operators.evolutions.EvolutionFactory.md | 2 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 2 +- ...ua.operators.evolutions.MatrixEvolution.md | 2 +- ...rators.evolutions.PauliTrotterEvolution.md | 2 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 2 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 2 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 2 +- ...rators.evolutions.TrotterizationFactory.md | 2 +- ...rators.expectations.AerPauliExpectation.md | 2 +- ....operators.expectations.CVaRExpectation.md | 2 +- ....operators.expectations.ExpectationBase.md | 2 +- ...erators.expectations.ExpectationFactory.md | 2 +- ...perators.expectations.MatrixExpectation.md | 2 +- ...operators.expectations.PauliExpectation.md | 2 +- ...qua.operators.gradients.CircuitGradient.md | 2 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 2 +- ...aqua.operators.gradients.DerivativeBase.md | 2 +- ...iskit.aqua.operators.gradients.Gradient.md | 2 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 2 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 2 +- .../qiskit.aqua.operators.gradients.QFI.md | 2 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 2 +- ...it.aqua.operators.legacy.MatrixOperator.md | 2 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 2 +- ....operators.legacy.WeightedPauliOperator.md | 2 +- ...skit.aqua.operators.legacy.Z2Symmetries.md | 2 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 2 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 2 +- ...qiskit.aqua.operators.list_ops.SummedOp.md | 2 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 2 +- ....aqua.operators.primitive_ops.CircuitOp.md | 2 +- ...t.aqua.operators.primitive_ops.MatrixOp.md | 2 +- ...it.aqua.operators.primitive_ops.PauliOp.md | 2 +- ...qua.operators.primitive_ops.PrimitiveOp.md | 2 +- ...qua.operators.state_fns.CVaRMeasurement.md | 2 +- ...aqua.operators.state_fns.CircuitStateFn.md | 2 +- ...it.aqua.operators.state_fns.DictStateFn.md | 2 +- ...qua.operators.state_fns.OperatorStateFn.md | 2 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 2 +- ....aqua.operators.state_fns.VectorStateFn.md | 2 +- .../0.28/qiskit.aqua.utils.CircuitFactory.md | 2 +- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.28/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.28/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.28/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.28/qiskit.aqua.utils.name_args.md | 2 +- .../0.28/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.28/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.28/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.28/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.28/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.28/qiskit.assembler.RunConfig.md | 2 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.28/qiskit.assembler.disassemble.md | 2 +- .../0.28/qiskit.chemistry.BosonicOperator.md | 2 +- .../qiskit.chemistry.FermionicOperator.md | 2 +- .../qiskit/0.28/qiskit.chemistry.MP2Info.md | 2 +- .../qiskit/0.28/qiskit.chemistry.QMolecule.md | 2 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 2 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 2 +- ...chemistry.algorithms.EigensolverFactory.md | 2 +- ...try.algorithms.ExcitedStatesEigensolver.md | 2 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 2 +- ...istry.algorithms.GroundStateEigensolver.md | 2 +- ....chemistry.algorithms.GroundStateSolver.md | 2 +- ...ry.algorithms.MinimumEigensolverFactory.md | 2 +- ...stry.algorithms.NumPyEigensolverFactory.md | 2 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 2 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 2 +- .../0.28/qiskit.chemistry.algorithms.QEOM.md | 2 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 2 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 2 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 2 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 2 +- ...s.pes_samplers.DifferentialExtrapolator.md | 2 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 2 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 2 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 2 +- ...gorithms.pes_samplers.HarmonicPotential.md | 2 +- ....algorithms.pes_samplers.MorsePotential.md | 2 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 2 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 2 +- ...y.algorithms.pes_samplers.PotentialBase.md | 2 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 2 +- ...thms.pes_samplers.VibronicStructureBase.md | 2 +- ...orithms.pes_samplers.WindowExtrapolator.md | 2 +- ...applications.MolecularGroundStateEnergy.md | 2 +- ...y.components.bosonic_bases.BosonicBasis.md | 2 +- ....components.bosonic_bases.HarmonicBasis.md | 2 +- ...y.components.initial_states.HartreeFock.md | 2 +- ...hemistry.components.initial_states.VSCF.md | 2 +- ...mistry.components.variational_forms.CHC.md | 2 +- ...stry.components.variational_forms.UCCSD.md | 2 +- ...istry.components.variational_forms.UVCC.md | 2 +- ...qiskit.chemistry.core.ChemistryOperator.md | 2 +- .../0.28/qiskit.chemistry.core.Hamiltonian.md | 2 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 2 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 2 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 2 +- ...iskit.chemistry.drivers.FermionicDriver.md | 2 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 2 +- ....chemistry.drivers.GaussianForcesDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 2 +- ...kit.chemistry.drivers.GaussianLogResult.md | 2 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 2 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.28/qiskit.chemistry.drivers.Molecule.md | 2 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 2 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 2 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 2 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 2 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 2 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 2 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 2 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 2 +- .../0.28/qiskit.circuit.AncillaQubit.md | 2 +- .../0.28/qiskit.circuit.AncillaRegister.md | 2 +- .../0.28/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.28/qiskit.circuit.Clbit.md | 2 +- .../0.28/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.28/qiskit.circuit.Delay.md | 2 +- .../0.28/qiskit.circuit.EquivalenceLibrary.md | 2 +- docs/api/qiskit/0.28/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.28/qiskit.circuit.Instruction.md | 2 +- .../0.28/qiskit.circuit.InstructionSet.md | 2 +- .../api/qiskit/0.28/qiskit.circuit.Measure.md | 2 +- .../qiskit/0.28/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.28/qiskit.circuit.ParameterVector.md | 2 +- .../0.28/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.28/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.28/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.28/qiskit.circuit.Reset.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.AND.md | 2 +- .../0.28/qiskit.circuit.library.Barrier.md | 2 +- .../0.28/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.28/qiskit.circuit.library.C3XGate.md | 2 +- .../0.28/qiskit.circuit.library.C4XGate.md | 2 +- .../0.28/qiskit.circuit.library.CCXGate.md | 2 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.28/qiskit.circuit.library.CHGate.md | 2 +- .../0.28/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.28/qiskit.circuit.library.CRXGate.md | 2 +- .../0.28/qiskit.circuit.library.CRYGate.md | 2 +- .../0.28/qiskit.circuit.library.CRZGate.md | 2 +- .../0.28/qiskit.circuit.library.CSXGate.md | 2 +- .../0.28/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.28/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.28/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.28/qiskit.circuit.library.CUGate.md | 2 +- .../0.28/qiskit.circuit.library.CXGate.md | 2 +- .../0.28/qiskit.circuit.library.CYGate.md | 2 +- .../0.28/qiskit.circuit.library.CZGate.md | 2 +- .../0.28/qiskit.circuit.library.DCXGate.md | 2 +- .../0.28/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.28/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.GRZ.md | 2 +- .../0.28/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.28/qiskit.circuit.library.HGate.md | 2 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.28/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.28/qiskit.circuit.library.MCMT.md | 2 +- .../0.28/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.28/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.28/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.28/qiskit.circuit.library.MSGate.md | 2 +- .../0.28/qiskit.circuit.library.Measure.md | 2 +- .../0.28/qiskit.circuit.library.NLocal.md | 2 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../0.28/qiskit.circuit.library.PauliGate.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.28/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.28/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.28/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.28/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.28/qiskit.circuit.library.RGate.md | 2 +- .../0.28/qiskit.circuit.library.RVGate.md | 2 +- .../0.28/qiskit.circuit.library.RXGate.md | 2 +- .../0.28/qiskit.circuit.library.RXXGate.md | 2 +- .../0.28/qiskit.circuit.library.RYGate.md | 2 +- .../0.28/qiskit.circuit.library.RYYGate.md | 2 +- .../0.28/qiskit.circuit.library.RZGate.md | 2 +- .../0.28/qiskit.circuit.library.RZXGate.md | 2 +- .../0.28/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.28/qiskit.circuit.library.Reset.md | 2 +- .../0.28/qiskit.circuit.library.SGate.md | 2 +- .../0.28/qiskit.circuit.library.SXGate.md | 2 +- .../0.28/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.28/qiskit.circuit.library.SdgGate.md | 2 +- .../0.28/qiskit.circuit.library.SwapGate.md | 2 +- .../0.28/qiskit.circuit.library.TGate.md | 2 +- .../0.28/qiskit.circuit.library.TdgGate.md | 2 +- .../0.28/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.28/qiskit.circuit.library.U1Gate.md | 2 +- .../0.28/qiskit.circuit.library.U2Gate.md | 2 +- .../0.28/qiskit.circuit.library.U3Gate.md | 2 +- .../0.28/qiskit.circuit.library.UGate.md | 2 +- ...kit.circuit.library.UniformDistribution.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.28/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.28/qiskit.circuit.library.XOR.md | 2 +- .../0.28/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.28/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.28/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.28/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.28/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.28/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.28/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.28/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.28/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.28/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.28/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.28/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.28/qiskit.compiler.transpile.md | 2 +- .../0.28/qiskit.converters.ast_to_dag.md | 2 +- .../0.28/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.28/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.28/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.28/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.28/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.28/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.28/qiskit.dagcircuit.DAGDependency.md | 2 +- .../qiskit/0.28/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.28/qiskit.extensions.HamiltonianGate.md | 2 +- .../0.28/qiskit.extensions.Initialize.md | 2 +- .../qiskit/0.28/qiskit.extensions.Snapshot.md | 2 +- .../0.28/qiskit.extensions.UnitaryGate.md | 2 +- .../0.28/qiskit.finance.QiskitFinanceError.md | 2 +- ...it.finance.applications.ising.portfolio.md | 10 +++---- ...cations.ising.portfolio_diversification.md | 6 ++--- ....uncertainty_problems.EuropeanCallDelta.md | 2 +- ...inty_problems.EuropeanCallExpectedValue.md | 2 +- ...ainty_problems.FixedIncomeExpectedValue.md | 2 +- ...finance.data_providers.BaseDataProvider.md | 2 +- ...nce.data_providers.DataOnDemandProvider.md | 2 +- ...nce.data_providers.ExchangeDataProvider.md | 2 +- ...nance.data_providers.RandomDataProvider.md | 2 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 2 +- ...inance.data_providers.YahooDataProvider.md | 2 +- ...t.ignis.characterization.AmpCalCXFitter.md | 2 +- ...kit.ignis.characterization.AmpCalFitter.md | 2 +- ...ignis.characterization.AngleCalCXFitter.md | 2 +- ...t.ignis.characterization.AngleCalFitter.md | 2 +- ...is.characterization.BaseCoherenceFitter.md | 2 +- ...t.ignis.characterization.BaseGateFitter.md | 2 +- ...iskit.ignis.characterization.DragFitter.md | 2 +- ...iskit.ignis.characterization.RabiFitter.md | 2 +- .../qiskit.ignis.characterization.T1Fitter.md | 2 +- .../qiskit.ignis.characterization.T2Fitter.md | 2 +- ...kit.ignis.characterization.T2StarFitter.md | 2 +- .../qiskit.ignis.characterization.ZZFitter.md | 2 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 2 +- .../0.28/qiskit.ignis.logging.IgnisLogger.md | 2 +- .../0.28/qiskit.ignis.logging.IgnisLogging.md | 2 +- ....ignis.measurement.DiscriminationFilter.md | 2 +- ...gnis.measurement.IQDiscriminationFitter.md | 2 +- ...ignis.measurement.LinearIQDiscriminator.md | 2 +- ...is.measurement.QuadraticIQDiscriminator.md | 2 +- ...gnis.measurement.SklearnIQDiscriminator.md | 2 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 2 +- ....mitigation.CompleteExpvalMeasMitigator.md | 2 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 2 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 2 +- ...skit.ignis.mitigation.MeasurementFilter.md | 2 +- ....mitigation.TensoredExpvalMeasMitigator.md | 2 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 2 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 2 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 2 +- ....ignis.verification.AccreditationFitter.md | 2 +- .../0.28/qiskit.ignis.verification.BConfig.md | 2 +- .../qiskit.ignis.verification.CNOTDihedral.md | 2 +- ...ignis.verification.CNOTDihedralRBFitter.md | 2 +- ...is.verification.GatesetTomographyFitter.md | 2 +- .../qiskit.ignis.verification.GraphDecoder.md | 2 +- ....ignis.verification.InterleavedRBFitter.md | 2 +- .../0.28/qiskit.ignis.verification.Plotter.md | 2 +- ...is.verification.ProcessTomographyFitter.md | 2 +- ...iskit.ignis.verification.PurityRBFitter.md | 2 +- .../0.28/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 2 +- .../qiskit.ignis.verification.RBFitter.md | 2 +- ...iskit.ignis.verification.RepetitionCode.md | 2 +- ...gnis.verification.StateTomographyFitter.md | 2 +- ...kit.ignis.verification.TomographyFitter.md | 2 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 2 +- .../0.28/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.28/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.28/qiskit.ml.datasets.digits.md | 2 +- .../0.28/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.28/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.28/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.28/qiskit.opflow.OperatorBase.md | 2 +- .../qiskit/0.28/qiskit.opflow.OpflowError.md | 2 +- .../0.28/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.28/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../0.28/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.28/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.28/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.28/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.28/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.28/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.28/qiskit.opflow.gradients.QFI.md | 2 +- .../0.28/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.28/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.28/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.28/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.28/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.28/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 2 +- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 2 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 2 +- ....optimization.algorithms.CplexOptimizer.md | 2 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 2 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 2 +- ...zation.algorithms.MinimumEigenOptimizer.md | 2 +- ...mization.algorithms.MultiStartOptimizer.md | 2 +- ...zation.algorithms.OptimizationAlgorithm.md | 2 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 2 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 2 +- ....optimization.algorithms.SolutionSample.md | 2 +- ....optimization.applications.ising.clique.md | 6 ++--- ....optimization.applications.ising.common.md | 12 ++++----- ...optimization.applications.ising.docplex.md | 2 +- ...mization.applications.ising.exact_cover.md | 6 ++--- ...tion.applications.ising.graph_partition.md | 6 ++--- ...ptimization.applications.ising.knapsack.md | 6 ++--- ...optimization.applications.ising.max_cut.md | 6 ++--- ...timization.applications.ising.partition.md | 4 +-- ...mization.applications.ising.set_packing.md | 6 ++--- ...imization.applications.ising.stable_set.md | 6 ++--- ...kit.optimization.applications.ising.tsp.md | 14 +++++----- ...tion.applications.ising.vehicle_routing.md | 8 +++--- ...ization.applications.ising.vertex_cover.md | 6 ++--- ...ization.converters.InequalityToEquality.md | 2 +- ...optimization.converters.IntegerToBinary.md | 2 +- ...tion.converters.LinearEqualityToPenalty.md | 2 +- ...on.converters.QuadraticProgramConverter.md | 2 +- ...ation.converters.QuadraticProgramToQubo.md | 2 +- ...qiskit.optimization.problems.Constraint.md | 2 +- ....optimization.problems.LinearConstraint.md | 2 +- ....optimization.problems.LinearExpression.md | 2 +- ...timization.problems.QuadraticConstraint.md | 2 +- ...timization.problems.QuadraticExpression.md | 2 +- ...ptimization.problems.QuadraticObjective.md | 2 +- ....optimization.problems.QuadraticProgram.md | 2 +- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 2 +- .../qiskit/0.28/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.28/qiskit.providers.BackendV1.md | 2 +- .../0.28/qiskit.providers.BaseBackend.md | 2 +- .../qiskit/0.28/qiskit.providers.BaseJob.md | 2 +- .../0.28/qiskit.providers.BaseProvider.md | 2 +- docs/api/qiskit/0.28/qiskit.providers.Job.md | 2 +- .../qiskit/0.28/qiskit.providers.JobError.md | 2 +- .../qiskit/0.28/qiskit.providers.JobStatus.md | 2 +- .../0.28/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.28/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.28/qiskit.providers.Options.md | 2 +- .../qiskit/0.28/qiskit.providers.Provider.md | 2 +- .../0.28/qiskit.providers.ProviderV1.md | 2 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.28/qiskit.providers.aer.AerError.md | 2 +- .../0.28/qiskit.providers.aer.AerJob.md | 2 +- .../0.28/qiskit.providers.aer.AerProvider.md | 2 +- .../0.28/qiskit.providers.aer.AerSimulator.md | 2 +- .../qiskit.providers.aer.PulseSimulator.md | 2 +- .../qiskit.providers.aer.QasmSimulator.md | 2 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 2 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 2 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 2 +- ...qiskit.providers.aer.noise.QuantumError.md | 2 +- ...qiskit.providers.aer.noise.ReadoutError.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 2 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 2 +- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 2 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.28/qiskit.providers.ibmq.IBMQBackend.md | 2 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 2 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.28/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.28/qiskit.providers.ibmq.IBMQFactory.md | 2 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 2 +- ....providers.ibmq.credentials.Credentials.md | 2 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...roviders.ibmq.experiment.AnalysisResult.md | 2 +- ...it.providers.ibmq.experiment.Experiment.md | 2 +- ...iders.ibmq.experiment.ExperimentService.md | 2 +- .../0.28/qiskit.providers.ibmq.job.IBMQJob.md | 2 +- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 2 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.28/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 2 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 2 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 2 +- ...t.providers.ibmq.managed.ManagedResults.md | 2 +- ...skit.providers.ibmq.random.CQCExtractor.md | 2 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 2 +- ...providers.ibmq.random.IBMQRandomService.md | 2 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 2 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 2 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 2 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 2 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 2 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 2 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 2 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 2 +- ...it.providers.ibmq.runtime.UserMessenger.md | 2 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.28/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../0.28/qiskit.providers.models.JobStatus.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Acquire.md | 2 +- .../0.28/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Call.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Constant.md | 2 +- .../0.28/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Delay.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Drag.md | 2 +- .../qiskit/0.28/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Gaussian.md | 2 +- .../0.28/qiskit.pulse.GaussianSquare.md | 2 +- .../qiskit/0.28/qiskit.pulse.Instruction.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- .../0.28/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.28/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Play.md | 2 +- .../qiskit/0.28/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.28/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.28/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit/0.28/qiskit.pulse.SetFrequency.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md | 2 +- .../0.28/qiskit.pulse.ShiftFrequency.md | 2 +- .../qiskit/0.28/qiskit.pulse.ShiftPhase.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.Waveform.md | 2 +- .../0.28/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.28/qiskit.pulse.builder.align_func.md | 2 +- .../0.28/qiskit.pulse.builder.align_left.md | 2 +- .../0.28/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.28/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.delay.md | 2 +- .../0.28/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.28/qiskit.pulse.builder.inline.md | 2 +- .../0.28/qiskit.pulse.builder.measure.md | 2 +- .../0.28/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.28/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.pad.md | 2 +- .../0.28/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.28/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.28/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.28/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.28/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.28/qiskit.pulse.builder.x.md | 2 +- docs/api/qiskit/0.28/qiskit.pulse.channels.md | 18 ++++++------- .../0.28/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.28/qiskit.pulse.instructions.Call.md | 2 +- .../0.28/qiskit.pulse.instructions.Delay.md | 2 +- .../qiskit.pulse.instructions.Instruction.md | 2 +- .../0.28/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../0.28/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.28/qiskit.pulse.library.Drag.md | 2 +- .../0.28/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../0.28/qiskit.pulse.library.Waveform.md | 2 +- .../0.28/qiskit.pulse.library.discrete.md | 26 +++++++++---------- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.28/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.28/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.28/qiskit.qasm.Qasm.md | 2 +- docs/api/qiskit/0.28/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.28/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.28/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.28/qiskit.qobj.GateCalibration.md | 2 +- .../0.28/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.md | 2 +- .../0.28/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.28/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.28/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.28/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.28/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.28/qiskit.qobj.QasmQobjInstruction.md | 2 +- docs/api/qiskit/0.28/qiskit.qobj.Qobj.md | 2 +- .../0.28/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.28/qiskit.qobj.QobjHeader.md | 2 +- .../0.28/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.28/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.28/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.28/qiskit.quantum_info.Choi.md | 2 +- .../0.28/qiskit.quantum_info.Clifford.md | 2 +- .../0.28/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.28/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.28/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.28/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.28/qiskit.quantum_info.Pauli.md | 2 +- .../0.28/qiskit.quantum_info.PauliList.md | 2 +- .../0.28/qiskit.quantum_info.PauliTable.md | 2 +- .../0.28/qiskit.quantum_info.Quaternion.md | 2 +- .../0.28/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.28/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerState.md | 2 +- .../qiskit.quantum_info.StabilizerTable.md | 2 +- .../0.28/qiskit.quantum_info.Statevector.md | 2 +- .../0.28/qiskit.quantum_info.Stinespring.md | 2 +- .../0.28/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.28/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.28/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.28/qiskit.quantum_info.entropy.md | 2 +- .../0.28/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.28/qiskit.quantum_info.partial_trace.md | 2 +- .../0.28/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.28/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.28/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.28/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.28/qiskit.result.Counts.md | 2 +- .../0.28/qiskit.result.ProbDistribution.md | 2 +- .../0.28/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/0.28/qiskit.result.Result.md | 2 +- .../qiskit/0.28/qiskit.result.ResultError.md | 2 +- .../0.28/qiskit.result.marginal_counts.md | 2 +- .../0.28/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.28/qiskit.scheduler.methods.basic.md | 4 +-- .../0.28/qiskit.scheduler.schedule_circuit.md | 2 +- .../0.28/qiskit.tools.backend_monitor.md | 2 +- .../0.28/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.28/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.28/qiskit.tools.parallel_map.md | 2 +- .../0.28/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.28/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.28/qiskit.transpiler.FlowController.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- .../qiskit/0.28/qiskit.transpiler.Layout.md | 2 +- .../0.28/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.28/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.28/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- .../qiskit.transpiler.passes.AlignMeasures.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- .../qiskit.transpiler.passes.BIPMapping.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.28/qiskit.transpiler.passes.CheckMap.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- .../0.28/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.28/qiskit.transpiler.passes.Depth.md | 2 +- ...t.transpiler.passes.DynamicalDecoupling.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 2 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.28/qiskit.transpiler.passes.Size.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- ...it.transpiler.passes.TimeUnitConversion.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- .../0.28/qiskit.transpiler.passes.Unroller.md | 2 +- ...it.transpiler.passes.ValidatePulseGates.md | 2 +- .../0.28/qiskit.transpiler.passes.Width.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.28/qiskit.utils.QuantumInstance.md | 2 +- .../qiskit/0.28/qiskit.utils.apply_prefix.md | 2 +- .../0.28/qiskit.utils.deprecate_arguments.md | 2 +- .../0.28/qiskit.utils.deprecate_function.md | 2 +- .../0.28/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.28/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.28/qiskit.utils.has_ibmq.md | 2 +- .../0.28/qiskit.utils.is_main_process.md | 2 +- .../0.28/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.28/qiskit.utils.name_args.md | 2 +- .../0.28/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.28/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1231 files changed, 1289 insertions(+), 1289 deletions(-) diff --git a/docs/api/qiskit/0.28/execute.md b/docs/api/qiskit/0.28/execute.md index 8755b9240c2..3b45799405a 100644 --- a/docs/api/qiskit/0.28/execute.md +++ b/docs/api/qiskit/0.28/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.28/logging.md b/docs/api/qiskit/0.28/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.28/logging.md +++ b/docs/api/qiskit/0.28/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.md index e309efc863f..a9a3272fe98 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.md index 17c91527416..a8387b976a2 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") The amplification problem is the input to amplitude amplification algorithms, like Grover. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.md index 3e0140c5cef..4bb20635223 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.md index abe15029318..c4fd58ef791 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") The `AmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.md index 3e39046c504..23afb7bdf40 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The Amplitude Estimation interface. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.md index 8744dac0af5..30fa2ec48c4 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") The results object for amplitude estimation algorithms. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.md index dd467d750e5..1e770169b9f 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.md index 8e4c3d459f7..4dce2b37c90 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.md index 1ba7ff179ac..9fcfd0606d4 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") The estimation problem is the input to amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.md index 7198558921f..fb05b65009e 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 24b1204c23a..0fd6514a2da 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") The result object for the Faster Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.28/qiskit.algorithms.Grover.md index a4471599984..f2df99c9ff2 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.md index a626eb35e56..6b7307399cb 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.28/qiskit.algorithms.HHL.md index ad1680f307d..2b32f13ebca 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. The problem can be defined as, given a matrix $A\in\mathbb{C}^{N\times N}$ and a vector $\vec{b}\in\mathbb{C}^{N}$, find $\vec{x}\in\mathbb{C}^{N}$ satisfying $A\vec{x}=\vec{b}$. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.md index 0d4734ce4f6..4cb0524fdcf 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index a342efd4562..e3c43466b51 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Store and manipulate results from running HamiltonianPhaseEstimation. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.md index c26a2e4f39e..2a432368078 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 300de14ee30..e0867b82281 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") The `IterativeAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.md index 079bc424969..7e2963e6c2a 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Run the Iterative quantum phase estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.md index fc16b84bd91..c953e118ebf 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") An abstract class for linear system solvers in Qiskit. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.md index 28be292bac1..5ff2814b27e 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") A base class for linear systems results. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index fdcc7db4bd5..8ae5403cb63 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index fa78648372b..5d5954fb9a9 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") The `MaximumLikelihoodAmplitudeEstimation` result object. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.md index caa1a2cf93f..da193f35dc7 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.md index b4ecef92659..840ff0d153a 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.md index 70496d9babb..a87ce8e5afd 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.md index 48d93da1345..f2341499a2c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") The Numpy Linear Solver algorithm (classical). diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.md index 97cf124af8a..4a431c40034 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.md index 7ba8e151d36..a954a487d76 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the Quantum Phase Estimation (QPE) algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.md index 0f2d2203369..99d63709fe8 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Store and manipulate results from running PhaseEstimation. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.md index a0990a98335..f1c4d638653 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.md index 10e7094d03c..33e002154a6 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.28/qiskit.algorithms.Shor.md index 7b0a83d6e1a..5c3e51831a7 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.md index 769531376c3..d945449c2fd 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Shor Result. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.28/qiskit.algorithms.VQE.md index 4d6f1af1713..eccd78ececc 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.md index 59b4f5fe899..86f7e69307a 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.md index 9854baf2aee..ea1526371b6 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parameterized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.md index 444413463f4..051a3ea00f7 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.md index bb3098a7240..e3f4d3f7417 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.md index 14dfcaf5b75..bb34be3c93c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.md index 890ff032365..ce56a677095 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.md index 023307e769e..34ee5bb224e 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5d8f876d762..3cf14fa407c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.md index 67b22fe0fcf..e57d9424141 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.md index f790edc8a26..513af570cd4 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.md index fb710afb48d..862c0656c85 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") The gradient descent minimization routine. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.md index 8a80cf5df51..7ba2f62d759 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.md index f00d5913d69..6485f058e58 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.md index 83f7393156e..16b2cb78ab9 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.md index 38c035b66ca..6a85a9e2e92 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.md index ae26a08eb14..d27702eb9f5 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.md index be0782eaa35..74ea5700efd 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 659c96b6168..af942d94762 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.md index ca0d2890bf7..c80db12b8e4 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.md index b98c97f88c0..3fd603b673c 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.md index fe29b6067b8..774bb2f65fa 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") The Quantum Natural SPSA (QN-SPSA) optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.md index 76d1b86f354..4995b6043d8 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.md index 0b71d7a93e3..ee87999e7a6 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.md index 908af596454..007e05b2cff 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.md index 19fbcf02681..6977b85ce62 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") A general Qiskit Optimizer wrapping scipy.optimize.minimize. diff --git a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.md index 5c223cb60a2..8175987ea03 100644 --- a/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.28/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.28/qiskit.aqua.AquaError.md index 72bdd21c8cf..b0bbe2c81ef 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.md index a2705fb67ae..eef98fffca2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.md index 9ee4dad3049..0d8d6fc9477 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.md index c82a3f32b92..630926f0093 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") The Quantum Phase Estimation-based Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 1f4556654dd..055cccfe474 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") AmplitudeEstimationAlgorithm Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 0450944cb6f..6382e73321e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") AmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.md index c782a8d61a8..33fd16d3b8f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") The Bernstein-Vazirani algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 2c7ef4f8ac5..bbbc746c26d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Base class for Classical Algorithms. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.md index 39823865eaa..a67ca03ffc4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") The Classical CPLEX algorithm (classical). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.md index 8ea64d5fad0..d3f8f9d731e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") The Deutsch-Jozsa algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.md index 60113e9584c..e4598fd3333 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") The Quantum EOH (Evolution of Hamiltonian) algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.md index f65a77574de..5d0835978d2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") The Eigensolver Interface. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.md index 31d6a1c92f5..d1dc9805d11 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Eigensolver Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.md index de18ce89e29..2073af34c39 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover’s Search algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.md index 40e4e5b30c0..c20a7413d27 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Grover Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.md index ade87bb3d36..deeafde8261 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") The HHL algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.md index 711bc422e46..fe9eef0961f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") HHL Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.md index 3f5ba5aa9ab..b0a14448851 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") The Iterative Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index 8f2f88b7644..31a0777eceb 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") The Iterative Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index ca43e5778c6..79f7e665c21 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") IterativeAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.md index b2f1bbffc4f..ecfc7c0798e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Linear solver Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 24fc5dce30d..8a298d586b7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") The Maximum Likelihood Amplitude Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5c5d5e9ba73..148f0f90794 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") MaximumLikelihoodAmplitudeEstimation Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.md index b2572553aed..9f3296c218d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") The Minimum Eigensolver Interface. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.md index 7f00556e724..bbb0f773d64 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Minimum Eigensolver Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.md index b6ce362fe1f..5ffd928f1e5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") The NumPy Eigensolver algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.md index be768fecf96..13f5d645b9b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") The Numpy LinearSystem algorithm (classical). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 3bfdd481080..f97e6f296e7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Numpy LinearSystem Result. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index c424f9e0e3e..d4a62ade0f5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") The Numpy Minimum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.md index a6e445c0c3a..075785e6fdb 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") The Quantum Approximate Optimization Algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.md index 1c9433e0d0c..e49adddc4c4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") The Quantum Generative Adversarial Network algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.md index bf43630fd78..e2f4eba9f96 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") The Quantum Phase Estimation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.md index 4b11c7633ba..b3deb6dbdd5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Quantum SVM algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.md index e6dd5b1eaca..ce3d74260e7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Base class for Quantum Algorithms. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.md index 56b4c11512f..2e3a4acafad 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Shor’s factoring algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.md index 8c76ae0bbda..4c781638b97 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") The Simon algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.md index 138ef590f05..a49fe1e2bf2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") The Sklearn SVM algorithm (classical). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.md index de10c7051e1..d94d46d0847 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") The Variational Quantum Classifier algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.md index 6889911df56..15795469c33 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") The Variational Quantum Eigensolver algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.md index 433ff83adf1..8fbf05eac12 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Conjunctive Normal Forms diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.md index e309a95bd69..2385738c43c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Disjunctive Normal Forms diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.md index 99920079c46..73bd8cdd705 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Class for constructing circuits for Exclusive Sum of Products diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 567d5d259dd..6df044e0ba4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Quantum Phase Estimation Circuit. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.md index 2d4db79e802..9bc47428835 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Arbitrary State-Vector Circuit. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.md index 345d2660260..2522a4854c2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds q^T \* w to separate register for non-negative integer weights w. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.md index 65c6382293c..9806b883b54 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Base class for eigenvalue estimation. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.md index f1abaff3330..bc20afe9d56 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Eigenvalues using Quantum Phase Estimation. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.md index d09393cf480..e9f7b7b57f3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Base class for FeatureMap. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 9a188d126e0..8ea631c0a78 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Raw Feature Vector feature map. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.md index b1d1f7b7271..5a1982c7ace 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") The custom initial state. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.md index 4bed6eca882..ca765509ba7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Base class for InitialState. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.md index 446d360c9bb..6eb58020d6b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") The variational form based initial state. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.md index b9a66f9d084..86296612375 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") The zero (null/vacuum) state. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.md index c97d45b3cf4..34bae3465dc 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") The All-Pairs multiclass extension. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 4b2eb2401d1..33d47cdb258 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") The Error Correcting Code multiclass extension. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 2eb6d3936db..e5ddf888858 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Base class for multiclass extension. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99d97264a8a..2ef53d7a23d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") The One Against Rest multiclass extension. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index cd60657c2a6..96ff7c3a0d4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Base class for discriminative Quantum or Classical Neural Networks. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 9724d541106..00fd1c50839 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Base class for generative Quantum and Classical Neural Networks. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 258ba48db93..cbede1b9f11 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Discriminator based on NumPy diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index dd11fb4be31..b3a32c57436 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Discriminator based on PyTorch diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 4cd9e258717..fdbc49aae48 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Quantum Generator. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.md index c20e5fb3db1..95d989bc92b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Adam and AMSGRAD optimizers. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.md index 954ee20efcb..5823c34e847 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. Performs gradient descent optimization with a momentum term, analytic gradients, and customized step length schedule for parametrized quantum gates, i.e. Pauli Rotations. See, for example: diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.md index 6f1df370dec..05c8a097e53 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bound Optimization BY Quadratic Approximation algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.md index 4fdf15efc24..99abed6409e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Conjugate Gradient optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.md index 67750b21b4d..58775337bc4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Constrained Optimization By Linear Approximation optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.md index 69f36fe5624..183be12c4e2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Controlled Random Search (CRS) with local mutation optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.md index f56e5ea574b..b14e7f6c251 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") DIviding RECTangles Locally-biased optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index cccef7e7320..72a9933e1f2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") DIviding RECTangles Locally-biased Randomized optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.md index 0906f993280..279ce0fb387 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") ESCH evolutionary optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.md index f88b865421e..636612e97c7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Gaussian-smoothed Line Search. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.md index 7387deb4d94..f7995f0a52d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") IMplicit FILtering algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.md index 555b00309b0..3cd707eaf29 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Improved Stochastic Ranking Evolution Strategy optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.md index 63dc681d75d..79558fd2d4d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Limited-memory BFGS Bound optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.md index 34a97f3e91f..171aa2b67d9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Nelder-Mead optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.md index dae5ca40b91..c04ac766d9b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Nakanishi-Fujii-Todo algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.md index 116295f4b6a..69dca758b6d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Base class for optimization algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index d0e669bb1a7..37309e501f9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Support Level enum for features such as bounds, gradient and initial point diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.md index 9c92991e2f7..56344c968b7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Powell optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.md index 942baa7df9f..64596f96b46 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Parallelized Limited-memory BFGS optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.md index c8ae54d9375..f4088801997 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Sequential Least SQuares Programming optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.md index f883074badd..716c298f629 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Stable Noisy Optimization by Branch and FIT algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.md index 211bbe75eb9..9d62ecb9d94 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.md index 52d1edcfb01..8575b1a8289 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Truncated Newton (TNC) optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 1efaf9e160d..6e6feb2e2c1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") The Custom Circuit-based Quantum Oracle. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index 65747fac0be..3f4147f11aa 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") The Logical Expression Quantum Oracle. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.md index 29b17616d91..04bc2a4d417 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Base class for oracles. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.md index c8e8073d3e4..154378c14ca 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") The Truth Table-based Quantum Oracle. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.md index 733b94065b9..8a122be5cc1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") The Long Division Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.md index 9b6aa75d977..e35cb5fddb6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") The Lookup Rotation for Reciprocals. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.md index 29c83c2fd62..86c1b50d8a7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Base class for reciprocal calculation. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 945b9184909..e3e1dff27f1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") The Univariate Bernoulli Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 3715f75da1b..eea2bf371e7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") The Gaussian Conditional Independence Model for Credit Risk. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index ad68dffadeb..f04631bb7f6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") The Univariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 5ea01becec1..3622ff695a2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") This module contains the definition of a base class for multivariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index e6038a59507..f2abd17b3d9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") The Multivariate Log-Normal Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 94b689e8499..702881b3beb 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") The Multivariate Normal Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index 7b2d17d5126..8c73d966e65 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") The Multivariate Uniform Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index a55a92a56e6..3406fdf8517 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") The Multivariate Variational Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index ad8841dd922..b3e399cf438 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") The Univariate Normal Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 082f187b3b9..b9a129ad8b4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") The abstract Uncertainty Model diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 089a4e41e48..54b2b6b2020 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") The Univariate Uniform Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index 8cc2bde0c8b..336f9e61c25 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") This module contains the definition of a base class for univariate distributions. (Interface for discrete bounded uncertainty models assuming an equidistant grid) diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 61ddd07d327..3eee9c45c7a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") The Univariate Variational Distribution. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 0f147dad700..32b5cf95140 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Multivariate Uncertainty Problem. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 4efc7c450e2..1570c4b049e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") The abstract Uncertainty Problem component. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 00398280d6c..4455c3fde38 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Univariate Piecewise Linear Objective Function. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index c03f18d2b15..3763244e48e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Univariate uncertainty problem. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.md index 7f77cc6a568..ae54370571e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Base class for VariationalForms. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.md index ec1917ebed0..9270c17966e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.md index 729f6c68b5e..16564a49cf8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.md index 101c6bac51f..104cae3fe55 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.md index c9c7905ff87..29d99e3b4a3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.md index fc2e0ba5493..289c8148ad7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.md index 14b55172bd2..013ed5623c9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.md index 8990a75bb23..9d7b75a0499 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.md index a8b3394e7b9..5d9f1afdf50 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.md index 924860e8670..c43bffcbc12 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.md index b78b1c8ba98..0f416fb1f81 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index f493a23c982..657c2eaf4b2 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.md index ff4a37374f8..26e712f47d8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.md index 663d6383679..63b01749667 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.md index 6937b3fc107..5a710fdbab4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.md index 493badc098d..0edc7d5fe4d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index 5acb3a36034..fe533716b26 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.md index d7b830c478e..fed697d4233 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.md index c6f9a807400..361118c50b1 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.md index cd31bab12bf..ba5d70e49d0 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.md index 520dfc545de..98c4fb9e474 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.md index 43fa318a514..a868c4bdba9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.md index 07eef403ff8..692df017e9a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.md index 8b6c5c27435..7b74a425017 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.md index 0af05335f59..e77492cc3a8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.md index a7034b7eb91..4358446ae62 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.md index 3ebf61675db..e4964472425 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.md index a531bd1b466..33f5d0652ee 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.md index b9b5a7aa145..25e02a21a8e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.md index d4b1ca8b495..63c7da727fa 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.md index 48a5ac2948f..a3c798ac103 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.md index 60790f54865..cd438b5d63e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.md index 817840970a5..5e8c7943fd8 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 9160971edff..aa8397ab620 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Operators relevant for quantum applications. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.md index dcfcb2d47f6..154e11912a7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Operators relevant for quantum applications diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.md index 56a752f289b..b8d7a1deb2f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Pauli Graph. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 6e3362f5b06..54b70f2993e 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") TPB Grouped Weighted Pauli Operator diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 46267d36942..8c7716d5814 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Weighted Pauli Operator diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.md index 8a6fcf48fac..c97c874fb6f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.md index ae2ec0e6793..351a63dea5c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.md index 667679ecec5..bcec2f74aa7 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.md index e16a1ab505f..6d86cba2f32 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.md index 4ef7c8af75a..76e3cec082c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0a46099874e..e15dc17735d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c584f2aa350..ba75a648daf 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.md index eeb9f35ed8b..478c72ab719 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 9867f1076e2..bdeec83e436 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 77fcc50b8ec..d477db9812a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.md index f0bc8604346..0eeaf0a02fd 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.md index e501482d8e1..05487a0a028 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.md index e63b4bae41c..a8dbb043504 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.md index 5ffd220a203..72d5480cbe4 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.md index cf5411c0ae5..fb2b001ed7d 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.md index 296315f2a33..a163f1dd643 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Base class for CircuitFactories diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.28/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.28/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.28/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.md index e71fa399626..24714a1cb63 100644 --- a/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.28/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Class for Run Configuration. diff --git a/docs/api/qiskit/0.28/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.28/qiskit.assembler.assemble_circuits.md index 0b7badfe8e7..91302eba922 100644 --- a/docs/api/qiskit/0.28/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.28/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.28/qiskit.assembler.assemble_schedules.md index 174896e6b6b..25ff21249a3 100644 --- a/docs/api/qiskit/0.28/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.28/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.28/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.28/qiskit.assembler.disassemble.md index acbe0abbd5d..d27cfe3c9e2 100644 --- a/docs/api/qiskit/0.28/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.28/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.md index 5c24fc48425..9940482184e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.md index 747136a0eec..955d0862bf5 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.md index 920d3f7a586..986c8ace0f2 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") A utility class for Moller-Plesset 2nd order (MP2) information diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.md index 94dabc11d23..2a2137f0aa6 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Molecule data class containing driver result. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.md index 748e8648b33..ab262eba395 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.md index 05db7fb4c1d..9e0c20dc5f6 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Watson Hamiltonian class containing the results of a driver’s anharmonic calculation diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.md index e4f4159190f..446cd7614f5 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") A ground state calculation employing the AdaptVQE algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.md index 8bc2599e3d7..379b0ffbda3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.md index 5795becc89a..c7bec35725f 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") A factory to construct a eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index bc7f21a57c3..2485d08dc09 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") The calculation of excited states via an Eigensolver algorithm diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index 84a7fb46129..e8490042751 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") The excited states calculation interface diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 3dc080851a3..2cba3095bb8 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Ground state computation using a minimum eigensolver. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.md index 81e46c6895c..628441ad2df 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") The ground state calculation interface diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index f5231e126f6..5b0c2212770 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") A factory to construct a minimum eigensolver based on a qubit operator transformation. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index 22b0c687db2..121cee11ff7 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") A factory to construct a NumPyEigensolver. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index fdf3ea87d60..48578808d21 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") A factory to construct a NumPyMinimumEigensolver. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 66e029e6e97..0fc89fd5d13 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") A ground state calculation employing the OOVQE algorithm. The Variational Quantum Eigensolver (VQE) algorithm enhanced with the Orbital Optimization (OO). The core of the approach resides in the optimization of orbitals through the AO-to-MO coefficients matrix C. In the usual VQE, the latter remains constant throughout the simulation. Here, its elements are modified according to C=Ce^(-kappa) where kappa is an anti-hermitian matrix. This transformation preserves the spectrum but modifies the amplitudes of the ground state of given operator such that in the end a given ansatz can be closest to that ground state, producing larger overlap and lower eigenvalue than conventional VQE. Kappa is parametrized and optimized inside the OOVQE in the same way as the gate angles. Therefore, at each step of OOVQE the coefficient matrix C is modified and the operator is recomputed, unlike usual VQE where operator remains constant. Iterative OO refers to optimization in two steps, first the wavefunction and then the orbitals. It allows for faster optimization as the operator is not recomputed when wavefunction is optimized. It is recommended to use the iterative method on real device/qasm simulator with noise to facilitate the convergence of the classical optimizer. For more details of this method refer to: [https://aip.scitation.org/doi/10.1063/1.5141835](https://aip.scitation.org/doi/10.1063/1.5141835) diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.md index c740cc0916d..12b6c879030 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") The calculation of excited states via the qEOM algorithm diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.md index 10f5bf790b9..bd4b5beda83 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") QEomEE algorithm (classical) diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.md index 52341c1f288..a8383d988ee 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") QEomVQE algorithm diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.md index 91c095d3e2c..af6f1263af4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") DEPRECATED. The Adaptive VQE algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 7475c54a220..e49abf6427a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index d889402948f..ef4fb71169c 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 7fb7a8d3d9f..65c259a031a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 3a84c9a2f36..1eb0f3fe5a4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. The user specifies the type of regression model to perform fitting, and a degree which adds derivatives to the values in the point vector; serving as features for the regression model. WARNING: Should only be used with window. Using no window includes points after the point being extrapolated in the data window. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index f4c17027475..d32fc9580fb 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") A simple cubic spline interpolation for the potential energy surface. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 75ac290d615..3d79c5bf9ba 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a potential energy surface diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index b7e582e3e2e..7c340ea87bc 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. This concept is based on fitting a set of (point,parameter) data to some specified function and predicting the optimal variational parameters for the next point. This technique is aimed towards providing a better starting point for the variational algorithm, in addition to bootstrapping techniques, ultimately reducing the total number of function evaluations. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index bcd46c5f7bb..8775905ff06 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Implements a 1D Harmonic potential. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 54708eb2f7e..d2535769625 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Implements a 1D Morse potential. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index a73b1fb0456..2d7e114251e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. A user specifies the kernel within how the PCA transformation should be done. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 61194171a49..b9c4941f5be 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 1d859cea127..7c4a0073c60 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of freedom. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index f706abfdc97..3093a133add 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index bcea8622fd5..905c40eb111 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 4e834213def..9d9775ca901 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index cd1181103f9..cc8da4b32b9 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Molecular ground state energy chemistry application diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index c06008cf7d7..945666620d7 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Basis to express a second quantization Bosonic Hamiltonian. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 77719be753e..f98567f64f1 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Basis in which the Watson Hamiltonian is expressed. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.md index 76c30edce7f..2d9d0d70387 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") A Hartree-Fock initial state. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.md index f95092a6d16..3054f09ac8d 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Initial state for vibrational modes. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.md index f7ce6a53c02..b537bd9de45 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") This trial wavefunction is the Compact Heuristic for Chemistry. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.md index 4b2e49ad24a..e4fe17702d7 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. For more information, see [https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340) And for the singlet q-UCCD (full) and pair q-UCCD) see: [https://arxiv.org/abs/1911.10864](https://arxiv.org/abs/1911.10864) diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.md index fbb3af3f7cb..5fd446b538f 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. For more information, see Ollitrault Pauline J., Chemical science 11 (2020): 6842-6855. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.md index 7a04e316abb..0b220e457c2 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Base class for ChemistryOperator. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.md index b5b4bcc999b..185dc931e06 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.md index 472883dd644..86424d40d53 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular chemistry Result diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.md index 5ce2ba01ee9..10c36ed37a4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Excited States Result diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.md index a5758bb9c74..b6ccc3eca49 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Molecular Ground State Energy Result. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.md index ce80df72b53..5b8d8a929a3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") QubitMappingType enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.md index 37622039125..fd938f5a0a7 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Transformation Type enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.md index 28c9c724102..9034ca598f4 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Base class for Qiskit’s chemistry drivers. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.md index 84eba214cee..3824fc7c343 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Basis Type diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.md index c1ff963cf6b..f966e471f6d 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Base class for Qiskit’s chemistry bosonic drivers. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.md index 059fd03f59b..559ab8099a6 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Qiskit chemistry driver reading an FCIDump file. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.md index a2a64dc4b38..e141b6ecbba 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Base class for Qiskit’s chemistry fermionic drivers. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.md index 8569c886245..a7afb167a16 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Qiskit chemistry driver using the Gaussian™ 16 program. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.md index 12591ef52b8..cf24c4d96aa 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Gaussian™ 16 forces driver. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.md index 8b57a5a98dd..d9243ba36f8 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.md index 9326f859b70..8158d55b550 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Result for Gaussian™ 16 log driver. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.md index 3ea0b3e6e71..79a14826c18 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Qiskit chemistry driver reading an HDF5 file. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.md index 0edd9b59c50..d62382da59b 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") HFMethodType Enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.md index aacfe0f8d8f..8562017cc21 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Initial Guess Enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.md index c9e14294833..506e0425c5e 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Driver-independent Molecule definition. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.md index de7fcc3f798..fdb29f147d3 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Qiskit chemistry driver using the PSI4 program. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.md index 1011f674456..5e063af7f3a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Qiskit chemistry driver using the PyQuante2 library. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.md index 5177ea1e968..285a1320513 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Qiskit chemistry driver using the PySCF library. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.md index a43e813c0a9..db273883a45 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Units Type Enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.md index a84f7153a90..07a6eb9eab5 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") The BOPES Sampler result diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.md index 97fb8c855f1..f865295260a 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") The eigenstate result interface. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.md index d10665d56ca..4d37d454137 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") The electronic structure result. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.md index 41cc19ec851..4d61669b64b 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") The vibronic structure result. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.md index 01afb136d73..f50e6d669d5 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicQubitMappingType enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.md index 74da609f5a7..72622b1d608 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.md index b2257adaf1d..e9b62d52d3c 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") BosonicTransformationType enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3c79ecddccd..1847365b7c2 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") FermionicQubitMappingType enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.md index 39a1dcc61fa..a135e2a8287 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") A transformation from a fermionic problem, represented by a driver, to a qubit operator. diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.md index 313dfcc0743..5803fed8481 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Electronic Transformation Type enum diff --git a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.md index f2f8e92bd2d..421c80b7baf 100644 --- a/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.28/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Base class for transformation to qubit operators for chemistry problems diff --git a/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.md index 1dd3e122116..3a5a23ae964 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") A qubit used as ancillary qubit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.md index 7dcb578d228..eaad0469161 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Implement an ancilla register. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.md index 37270c9566e..9357d340832 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Implement a classical register. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.28/qiskit.circuit.Clbit.md index 74485afd57b..c08f45af3a6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Implement a classical bit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.md index e07c6f2d4dd..eae056a27d9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Controlled unitary gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Delay.md b/docs/api/qiskit/0.28/qiskit.circuit.Delay.md index 896288444fd..cb82a8d2ba7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Do nothing and just delay/wait/idle for a specified duration. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.md index f766feb8c7a..97a0837b28c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Gate.md b/docs/api/qiskit/0.28/qiskit.circuit.Gate.md index 0c5c7c1e547..a17a822604a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Unitary gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.28/qiskit.circuit.Instruction.md index 13c4969594f..8009b4239ad 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Generic quantum instruction. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.md index 6f1431b0239..864ba6fc51d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Instruction collection, and their contexts. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Measure.md b/docs/api/qiskit/0.28/qiskit.circuit.Measure.md index dcf4bc8f31e..fe5f7e09293 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.28/qiskit.circuit.Parameter.md index 4112e79d2b1..e347164b4fb 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Parameter Class for variable parameters. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.md index beff04ba508..e6f3d19655a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") ParameterExpression class to enable creating expressions of Parameters. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.md index 23518ca49b9..d1a2a71a9b8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") ParameterVector class to quickly generate lists of parameters. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.md index 00ab4e9e3e7..9cc2b5a23c7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create a new circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.md index 2c429dca70f..25c14a1e940 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Implement a quantum register. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.28/qiskit.circuit.Qubit.md index 220afaceedb..e95bb30a479 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Implement a quantum bit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.Reset.md b/docs/api/qiskit/0.28/qiskit.circuit.Reset.md index 66e7ca2d3ed..c369230c773 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.md index e7ab069b4c9..6c7c9a4f031 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") The Boolean Expression gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.md index ac1fdb824c7..1302a656d83 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Represent a classical function function and its logic network. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 689186f65d7..16c7a7b4e34 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 6ca627f7c3b..96e02336cf7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.28/qiskit.circuit.library.AND.md index 5822ba66cf8..183787e28d8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") A circuit implementing the logical AND operation on a number of qubits. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.md index 393183bbc69..772fd836e0f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Barrier instruction. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.md index ee86178cc14..379be0477db 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.md index 2435d868ca5..51a3ea9ed40 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The X gate controlled on 3 qubits. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.md index 09a1415dec8..7e42c8fa880 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The 4-qubit controlled X gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.md index 67528c1b0c1..4de7264e1ba 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") CCX gate, also known as Toffoli gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.md index 7c4c30b7d5d..232e1e78dd3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") A ripple-carry circuit to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.md index a9d7e94c9dd..00a95751e50 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Controlled-Hadamard gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.md index ed4e7d2e2bf..d2264b42af0 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled-Phase gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.md index 542d33a0f5d..af9851ecabf 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Controlled-RX gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.md index d65397c369a..3bbcc82f397 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Controlled-RY gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.md index 9d83f33e4b9..9894694ef1f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Controlled-RZ gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.md index d95ea730b24..3a7474dbfad 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Controlled-√X gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.md index 13804a12ee2..fafd08ba96c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Controlled-SWAP gate, also known as the Fredkin gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.md index 1c8bb877894..f9996117e98 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled-U1 gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.md index 50c80c11788..8366c5de6a6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Controlled-U3 gate (3-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.md index 07d55515a16..baea0b46c0d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Controlled-U gate (4-parameter two-qubit gate). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.md index 6e69abba9ce..49b1016f84a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled-X gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.md index 2336ebaae21..8b899e815e7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Controlled-Y gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.md index 05309a251c9..b3f58b75e6a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Controlled-Z gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.md index d3e82312ee5..4fb06d329ee 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") Double-CNOT gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.md index 424f7501cbe..72a313075a4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Diagonal circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.md index c3d307ac229..525b98433f7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") A circuit that uses QFT to perform in-place addition on two qubit registers. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.md index 5d51d6045e3..ce87fe664bf 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.md index 654b0f59531..33c77bf567a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") The hardware efficient SU(2) 2-local circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 54e58e977ee..9b86eec6339 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") The evolved operator ansatz. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.md index 466011f0270..a816a06f55f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") The heuristic excitation-preserving wave function ansatz. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.md index 80f882831d2..873f565bb77 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") Fourier checking circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.md index 4aec066da78..63f771d57ba 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Base class for functional Pauli rotations. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.md index 29010928f89..7e232483d2c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") Global Mølmer–Sørensen gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GR.md index ce24c0b3ac5..0fa8d1b16d6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global R gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.md index 7252a298ef9..2405719f8ed 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RX gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.md index 0ec34831243..8512c23b6dd 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RY gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.md index 6ec211c384d..abbe25bc833 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Global RZ gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.md index 55846ce3bb0..6105edca4a7 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") Circuit to prepare a graph state. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.md index e09ed60b8af..95a456fe12b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") The Grover operator. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.md index b879892f0a3..454d9150b57 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Single-qubit Hadamard gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.md index b5e2bce5c99..e89019e433c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") A multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.md index 6b2e509b93d..1b49f2f1e0c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") Circuit to solve the hidden linear function problem. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.md index 1527ef72957..3616d368667 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Identity gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.md index 8935a693b75..2c75905bc20 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") Instantaneous quantum polynomial (IQP) circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.md index 99037860122..308f369010c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.md index f8014caa036..29b462351ab 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Integer Comparator. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.md index fecd5a43447..a1403289f50 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") A circuit implementing a (piecewise) linear function on qubit amplitudes. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.md index 183e6bb504e..9cbe0754334 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Linearly-controlled X, Y or Z rotation. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.md index 6c2bb052ff6..ba7438a939c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") A circuit to encode a discretized log-normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.md index ad1d1421ec3..a3a3df76f49 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.md index 479fce2d9eb..0c039ed92de 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") The MCMT implementation using the CCX V-chain. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.md index 66e2536d9b8..7c64dad6c0f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Multi-controlled-Phase gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.md index b49e6115c9f..34b55b2c847 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The general, multi-controlled X gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.md index 02f75d652f4..f726e054aa0 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using the Gray code. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.md index 195bc9b3942..1710442a3be 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using recursion. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.md index f989cf0caff..5bbfc7bc6db 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Implement the multi-controlled X gate using a V-chain of CX gates. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.md index 1f95748a871..5d7fb0b22c3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") MSGate has been deprecated. Please use `GMS` in `qiskit.circuit.generalized_gates` instead. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.md index be44666e173..fd02c726026 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Quantum measurement in the computational basis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.md index caecc17b5a3..74f03b42cc8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") The n-local circuit class. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.md index 9130ea26c8f..ba80f32e84e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") A circuit to encode a discretized normal distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.28/qiskit.circuit.library.OR.md index a7a464a850f..d74854ecee1 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") A circuit implementing the logical OR operation on a number of qubits. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.md index 5e966e9720c..709d693ef66 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") The Pauli Expansion circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.md index dfc4a89887d..6350594fccb 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") A multi-qubit Pauli gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.md index af4636478f8..81ef5121914 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") The Pauli Two-Design ansatz. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.md index 7afaadcade8..b20d2bfda76 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") An n\_qubit circuit that permutes qubits. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.md index eb128bf3f1d..b20edebff7c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") Phase Estimation circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.md index e0fea663e8d..619272f81ed 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.md index 561f8c01794..13ffedfef78 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Phase Oracle. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.md index f556eafd62a..f0595a0a793 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Piecewise Chebyshev approximation to an input function. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index ae663bce103..633f38cd6c6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Piecewise-linearly-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 3f69350fb39..a8cbb9b4263 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Piecewise-polynomially-controlled Pauli rotations. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.md index c9cb6efd0ca..3de2d91bc24 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") A circuit implementing polynomial Pauli rotations. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.md index 1fcd355f66c..4445866dcc9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") A generalized QAOA quantum circuit with a support of custom initial states and mixers. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.md index 2554091f0b2..ee6749e077b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='QFT')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name='QFT')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Quantum Fourier Transform Circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.md index 25fb2c94c73..03870d72374 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Implements a quadratic form on binary variables encoded in qubit registers. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.md index 36a15989f9e..ccfd1a74840 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") A quantum volume model circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.md index 5ac0299a43c..ffbb1e69257 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.md index b170003588d..221367910a8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.md index a3da59dff5c..ad2e129386c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") A QFT multiplication circuit to store product of two input registers out-of-place. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.md index 21b17de06fb..ebb20ad7ea8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Rotation θ around the cos(φ)x + sin(φ)y axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.md index 0098b8078ca..8600e1e1034 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Rotation around arbitrary rotation axis $v$ where $|v|$ is angle of rotation in radians. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.md index 65f26be59dc..a4f30211b80 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Single-qubit rotation about the X axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.md index 35c79af479b..adf42fa5907 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.md index 66d7f764ebd..e158eb2c19f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Single-qubit rotation about the Y axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.md index dd07f358c9a..77b1863703d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.md index 483bfc564e3..9bd434b0d40 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.md index c4e900aed14..242ac7beefb 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.md index 2de5668946a..8a451212921 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.md index f8329f3110a..437f9ab8cee 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.md index 347c5a27080..6f96d2531cc 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Qubit reset. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.md index d6a698da9df..da1d5b0d3b8 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S gate (Z\*\*0.5). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.md index 8de1a65dfba..1796ecb82d3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") The single-qubit Sqrt(X) gate ($\sqrt{X}$). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.md index d1a3c88c9b8..3a0af012c8d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") The inverse single-qubit Sqrt(X) gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.md index 8cea5a5ca88..c667992dbb3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Single qubit S-adjoint gate (\~Z\*\*0.5). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.md index b08d566ae80..6c49efa83c4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") The SWAP gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.md index 03a45b0f8b8..138f45cab34 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T gate (Z\*\*0.25). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.md index c922e43c74b..5fda59efb58 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Single qubit T-adjoint gate (\~Z\*\*0.25). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.md index 5ed53df3f54..6d0c59340ee 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") The two-local circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.md index df959c09c94..9a1cf3b8f1f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Single-qubit rotation about the Z axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.md index 50a271f011f..6666bee4837 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Single-qubit rotation about the X+Z axis. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.md index a121f7bf815..c58abc40da9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.md index 9f6d914e0bf..12cd1373af9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Generic single-qubit rotation gate with 3 Euler angles. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.md index 29dd9c092ca..dbd6502925c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") A circuit to encode a discretized uniform distribution in qubit amplitudes. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.md index 7d7418db8e2..a65adc5857d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") The VBE ripple carry adder \[1]. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.md index 26a2d710a93..3a76705063a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") A circuit to compute the weighted sum of qubit registers. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.md index cb51544fe83..aab5c977f3f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") The single-qubit Pauli-X gate ($\sigma_x$). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.md index 647197f9dc5..6de838a535e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.md index 8db8f236d1d..ce2dd667bc9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") The single-qubit Pauli-Y gate ($\sigma_y$). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.md index 987c217ed4e..5db789dd083 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") The first order Pauli Z-evolution circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.md index 4b2ea1dc8f9..95d63081e13 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") The single-qubit Pauli-Z gate ($\sigma_z$). diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.md index 28eb1dcc32d..bcf7f172f80 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_1.md index 42cf538c532..22bd668f91f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_2.md index 5bf66e9f98c..f2c5dd8fc10 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_3.md index 927f19fa200..94d8dfa34f4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_4.md index 8b16e2825d6..b22af4fca25 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_3_1.md index 2c09082d230..4fba3a33436 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_1.md index 07b3612de9c..ecf6ae0b847 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_2.md index 36856209e49..3c8360c05de 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_3.md index d0f5a22555e..b383502f2b2 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_4.md index 57ae97f2a84..d05d911fcf2 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_5_1.md index 570f78364e6..a13af44ea44 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_1.md index a9b3cb55224..ab33af8a64c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_2.md index 0a9966bb05d..5300850cc44 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_3.md index c979ff290d7..9d98315d660 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_4.md index e48a68c9e45..b60dac07ece 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_5.md index 69364d28f8d..04add82fbe3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_1.md index 4e11397bbef..5023943cd35 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_2.md index 0485bc05efe..ced38daade6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_3.md index feaaa81f23c..caa0eaa3b81 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.md index 917058a233c..45d196c22f9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") iSWAP gate. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_cy.md index bae210512c6..5cee06c07dd 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_xz.md index 6111e4b6d65..41579dc8e27 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_yz.md index f5feb56c245..a09251daecb 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz1.md index f8a2218bc4b..cae37878081 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz2.md index d4d76d03eb4..4771308c6ef 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz3.md index 9ab0e123a91..92dcb301fc6 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index fccc60c5901..6901ced3335 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index bc9dfac625c..79f50d36359 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 9a0f1d6e2e0..8275bd14b9d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index a099d56f93c..6a139dddd79 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 199b0ba73fb..af90757559d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index d8f119d2cde..6a7e2cbba0e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 645f993d038..64eb9dbc638 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index b29f66cbbd3..7d5f16134f9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index cdfab95456d..28a9def5e19 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 42e44c71ccb..38eb6fe0f01 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f2bf2fb8ffd..bfa2880e791 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f5857f8be6d..7bc7fb49e7f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 54d796c48ea..3c958322aef 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 497c7f651c8..d7857911c5c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 05dd1473bf2..500c3f9542b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index bf4346c45e9..506e1f4c1e5 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 143ce700b60..575584da1f5 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index bddea475821..c21c0e0b10b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 1d23abdcba1..dfdf7f93c5e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 5e04b1587b2..31a4609876c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7f827c64901..ad51542d5c9 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 5fd5601a5c9..e8b1fd4612d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index c8b3b9b383b..d6a37940f1a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 5e36d6a1208..86f78e9c92a 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 1340401a8c0..88220d5de36 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 7d6a80af75b..b0ac097f194 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 9d72c54ca1a..19994762b62 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index cfb20db8ead..4e172dfcd3c 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8f053052c41..bf49584b47e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 0dbc8a78f8c..406a990948d 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 767dfc0dc71..4af3a1e4799 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index fbf1fac3a16..cbb0b73f437 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index e00e9a09031..d026edef43f 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 51fafdebc96..e2d6bdcc984 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 7c6acba7de7..9bd4b84a326 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 23417772375..736756f7008 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 1f41755ea0a..4bd9eac06cd 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index f66ad8c3ec1..d55f4e85b13 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 42e65f18b74..7d348ef65a4 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index dcdd118e19e..5c506c0d1a2 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 2eae01bb124..10b935ea263 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 4038dc3d507..83a8fd11254 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 705eded25a9..d07c214552b 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4c845969dab..68996fb600e 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index d55538e6a62..80d5f36a9d0 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 4865ff7af80..ca902b97814 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 03d25edc1ff..f2a903e2504 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.28/qiskit.circuit.random.random_circuit.md index fa266eecbe3..4963b75e5f3 100644 --- a/docs/api/qiskit/0.28/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.28/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.28/qiskit.compiler.assemble.md b/docs/api/qiskit/0.28/qiskit.compiler.assemble.md index 138579fd1f2..5f56d4b597a 100644 --- a/docs/api/qiskit/0.28/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.28/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.28/qiskit.compiler.schedule.md b/docs/api/qiskit/0.28/qiskit.compiler.schedule.md index 8e7a6cffa9f..6788dfb4f20 100644 --- a/docs/api/qiskit/0.28/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.28/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.28/qiskit.compiler.sequence.md b/docs/api/qiskit/0.28/qiskit.compiler.sequence.md index 5bfaf303b8b..4fceaa00aab 100644 --- a/docs/api/qiskit/0.28/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.28/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.28/qiskit.compiler.transpile.md b/docs/api/qiskit/0.28/qiskit.compiler.transpile.md index 3102cf09b2e..485f96f1b66 100644 --- a/docs/api/qiskit/0.28/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.28/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.28/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.28/qiskit.converters.ast_to_dag.md index 9cd58f83e7a..c4493f44193 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.28/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dag.md index 9ef28c39caa..d4a0b637fd3 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dagdependency.md index 15a315afab9..ea1f2e076ca 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_gate.md index 9ec3011bd18..4ec8eb91504 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_instruction.md index 3f7e67885c5..882ef5012f9 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.28/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.28/qiskit.converters.dag_to_circuit.md index 9fd5e9df0d5..e87a0827eee 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.28/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.28/qiskit.converters.dag_to_dagdependency.md index 1659bc658dd..40903d9c45a 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.28/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_circuit.md index 8bc14e76d3b..a95b2c1d722 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_dag.md index 340e3d702ef..87bb9458172 100644 --- a/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.28/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.md index 1e95a0688ac..b1425fd34a0 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Quantum circuit as a directed acyclic graph. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.md index e32befbac5a..0b13f22f374 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.md index 25a6d4b16cb..2d8924c2a7f 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Object to represent the information at a node in the DAGDependency(). diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.md index 3b958ae1f59..599c99a0ab1 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation). diff --git a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.md index 629585b58f1..de9bc467d2f 100644 --- a/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.28/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Object to represent the information at a node in the DAGCircuit. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.md index 7930d03445a..7b657bd3d51 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.28/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Class for representing evolution by a Hermitian Hamiltonian operator as a gate. This gate resolves to a UnitaryGate U(t) = exp(-1j \* t \* H), which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.28/qiskit.extensions.Initialize.md index 4adf64cfc85..d585a00ddd7 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.28/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Complex amplitude initialization. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.md index 6d0f4518ec4..500c0c18431 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.md index 7ee0fd1edd6..4e76a78acb7 100644 --- a/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.28/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Class for representing unitary gates diff --git a/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.md index ecb17062b1e..ca345b23a89 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.28/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md index 82487c60134..ef69b4836a1 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md @@ -26,7 +26,7 @@ Convert portfolio optimization instances into Pauli list -`get_operator(mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`get_operator(mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") get qubit op @@ -34,7 +34,7 @@ get qubit op -`portfolio_expected_value(x, mu)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_expected_value(x, mu)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio expected value @@ -42,7 +42,7 @@ returns portfolio expected value -`portfolio_value(x, mu, sigma, q, budget, penalty)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_value(x, mu, sigma, q, budget, penalty)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio value @@ -50,7 +50,7 @@ returns portfolio value -`portfolio_variance(x, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`portfolio_variance(x, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") returns portfolio variance @@ -58,7 +58,7 @@ returns portfolio variance -`random_model(n, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") +`random_model(n, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py "view source code") Generate random model (mu, sigma) for portfolio optimization problem. diff --git a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md index f91ddbb89e1..bb47d349453 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md @@ -24,7 +24,7 @@ portfolio diversification -`get_operator(rho, n, q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_operator(rho, n, q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Converts an instance of portfolio optimization into a list of Paulis. @@ -46,7 +46,7 @@ operator for the Hamiltonian -`get_portfoliodiversification_solution(rho, n, q, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_solution(rho, n, q, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. @@ -69,7 +69,7 @@ a vector describing the solution. -`get_portfoliodiversification_value(rho, n, q, x_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") +`get_portfoliodiversification_value(rho, n, q, x_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio_diversification.py "view source code") Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). diff --git a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 9f5809eb8b1..4f464fc2052 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") The European Call Option Delta. diff --git a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index dab41ef195a..1682162de70 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") The European Call Option Expected Value. diff --git a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 142aad07547..a502f97f51d 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.28/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") The Fixed Income Expected Value. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.md index d85745d4aec..ff8b9ee0b55 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") The abstract base class for data\_provider modules within Qiskit’s finance module. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.md index 8f945e76f70..963504596fb 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") NASDAQ Data on Demand data provider. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.md index af2b26fb556..d2b478f9069 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Exchange data provider. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.md index b73991b0df4..b19b1d0c3e8 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Pseudo-randomly generated mock stock-market data provider. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.md index 105c54a6304..6b382b8766a 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Stock Market enum diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.md index 5556d0d8463..4fcb867c5fb 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Wikipedia data provider. diff --git a/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.md index b2529cd4972..25ccfa057df 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.28/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Yahoo data provider. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.md index ed885e86acb..f893ff8583f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.md index 529402f02ba..98d87705c94 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.md index 3be217cdf55..a5e78ab334d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.md index 02a0e6a865c..78f0982e69f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Amplitude error fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.md index 94f70611e32..445eb111c8b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of characteristic times diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.md index dcbb143056c..ac440e27f5c 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Base class for fitters of gate errors diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.md index 36ce349ad43..35b450c59e8 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Drag Experiment fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.md index d66deee5d0a..e133ca7ec0c 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Rabi Experiment fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.md index 810576dcce7..b2901ae9ccd 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T1, based on experiments outcomes, diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.md index 2d63119331a..4c52b3df4ba 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2, based on experiments outcomes. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.md index 639b9cf3e90..c6359b2cbc0 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Estimate T2\*, based on experiments outcomes. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.md index 98fb9d3ebef..f57659067dc 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") ZZ fitter diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.28/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.md index 86073e22305..472a8f16b42 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Class to read from Ignis log files diff --git a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.md index b0481d5b676..3f80ff9739e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.md index 2d9915510ed..fdaac5a520a 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Singleton class to configure file logging via IgnisLogger diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.md index 6e65d9093b1..8fa8d3e7401 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Implements a filter based on a discriminator that takes level 1 data to level 2 data. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.md index 445d42fea9f..5376260c0bf 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Abstract discriminator that implements the data formatting for IQ level 1 data. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.md index 52c0f8470d5..ee9c25308de 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Linear discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index c1c3ff698c7..919f54257e6 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Quadratic discriminant analysis discriminator for IQ data. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.md index a642898bc59..79be0223b34 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 8e15311737a..6c0871b24a0 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") N-qubit CTMP measurement error mitigator. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index e7b577353ba..3e133e59a91 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") N-qubit measurement error mitigator. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.md index 24a8214febc..7d1c769ba6d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a full calibration diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 94239cbb31f..20d9c599347 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Expectation value measurement error mitigator calibration fitter. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.md index a66fbc2dc00..7474d28cca9 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Measurement error mitigation filter. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 1fc9f995da8..05e6a60eaad 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") 1-qubit tensor product measurement error mitigator. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.md index 2ea8d6aeb6c..fb77a6ff758 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Tensored measurement error mitigation filter. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.md index e0ce4027d78..965d40ad123 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Measurement correction fitter for a tensored calibration. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index a904145e8ef..3472c4bc068 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.md index e351e671e68..10b34c7821b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") This class generates accreditation circuits from a target. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.md index 5745acc3c58..9fd9d225eb1 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Class for fitters for accreditation diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.md index 8f394ba2eb6..8a6398a21b5 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.md index 10a5607cbfd..2c442cbc1fb 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") CNOT-dihedral Object Class. The CNOT-dihedral group on num\_qubits qubits is generated by the gates CNOT, T and X. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 984ccf64b31..5b483d5e83d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for non-Clifford CNOT-Dihedral RB. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.md index c05e3fde8b9..5ffc2e22f3c 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Initialize gateset tomography fitter with experimental data. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.md index 9ac37c8dbe0..78f122d4e7f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.md index 2586d94a7de..b8b89587dc3 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for interleaved RB, derived from RBFitterBase class. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.md index 76e568f038f..659f420190d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Various plots of the ground state in MQC and PO experiments diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.md index e22e30738b1..d6b9ef1066b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Maximum-Likelihood estimation process tomography fitter. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.md index 9484ec90e87..ebdbd4cf482 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitter for purity RB. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.md index aa6434746b3..cd6678b16ff 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Class for fitters for quantum volume. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.md index 853da1bd407..5c89a7aba32 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Class for fitters for randomized benchmarking. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.md index 3a16e469600..6abf51cec2e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.md index 1d4c9a2b8ff..c6524de5a29 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Maximum-Likelihood estimation state tomography fitter. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.md index 23e8a604805..c3854fe866b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Base maximum-likelihood estimate tomography fitter class diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.gates_per_clifford.md index 1a836243407..acb6c9cbe26 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.md index d308495c913..977ed8a7aa5 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.28/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") The raw feature vector circuit. diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.28/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.28/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.28/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.28/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.md index 68697197dca..6ec7269e094 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the `Zero` StateFn to the complex binary function they represent. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.md index 4e61ace4e7e..e7f08e4caca 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.28/qiskit.opflow.anti_commutator.md index 3898db790be..85f54d4274f 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.commutator.md b/docs/api/qiskit/0.28/qiskit.opflow.commutator.md index fee5b93b02a..d2172385ff8 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.md index b204324188a..878a9bf20d1 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") The AbelianGrouper converts SummedOps into a sum of Abelian sums. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.md index 1a835674ac1..a88e3bd8384 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with **square roots** of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the **square** of the state function, per the Born rule. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.md index 7cc6d40a12b..bc6822fdc9a 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.md index 5fb6a2ec241..77015db34d5 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. The behavior of this class can be mostly replicated by calling `to_circuit_op` on an Operator, but with the added control of choosing whether to convert only `DictStateFns` or `VectorStateFns`, rather than both. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.md index 571adef9783..4f460e43387 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli \{Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a composition of a change of basis circuit and a Pauli composed of only Z and I terms (diagonal), which can be evolved or sampled natively on the Quantum hardware. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.md index f51554cbd3f..d2a32fabd05 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.28/qiskit.opflow.double_commutator.md index 4bdc73dda07..b683221f214 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.md index 173b5b70cdd..c4bfa013656 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any `EvolvedOp` e with a Schrodinger equation-style evolution `CircuitOp` equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.md index 005adccf6ba..bc35a49c642 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.md index 40399ed2a1f..04324b5b37f 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn’t actually hold a primitive object. We could have chosen for it to be an OperatorBase, but would have ended up copying and pasting a lot of code from PrimitiveOp. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.md index 6754ac84be1..35068219671 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.md index fbaa4afdf64..25e25109574 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.md index 934e2b79fc8..35779e40b45 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in [https://arxiv.org/abs/1811.08017](https://arxiv.org/abs/1811.08017). diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.md index 0d9b0951090..e12e2e680dc 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.md index 4183a2b2b6a..0fdab015db5 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.md index 3a673595ae5..8386fe6ec8b 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.md index 590db921958..b53d4e71c7a 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.md index 1d60c32f1bb..75fdb73e4e3 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.md index 6a95f7d249b..cb46db82bb5 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Compute the Conditional Value at Risk (CVaR) expectation value. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.md index b69c7f8b1c5..9a04d236bf3 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a `PauliExpectation` to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.md index 6842535626a..b5fe4e78e23 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.md index 48d44c31b91..fea8019e2a7 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.md index 78ba3e2ac7a..a2535f0b7d3 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution overhead. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.md index 9691056a1f1..b9083f3ee27 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Circuit to gradient operator converter. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.md index 9fd5bce655e..0d43f0fa6c2 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Circuit to Quantum Fisher Information operator converter. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.md index 405c969e5c9..43edb8bf449 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Base class for differentiating opflow objects. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.md index 1e8eedd80ed..b31736729e0 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.md index 546cb081b7b..d17c43a32aa 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") Base class for first-order operator gradient. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.md index a8b93d5d9e4..61f78d9d8ea 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Compute the Hessian of an expected value. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.md index 99fd34dc65c..5e83649f834 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") Base class for the Hessian of an expected value. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.md index 8f93d4ae7bf..b9dc576d056 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") Convert an operator expression to the first-order gradient. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.md index 3ef34b757f5..9fb282ea472 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") Compute the Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.md index 1536e78d92b..6b06a7bb048 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") Base class for Quantum Fisher Information (QFI). diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.md index 60e29eb45c6..343bd598e60 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in `oplist` are meant to be composed, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits or matrices, they can be reduced by composition. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.md index e14c9389fa3..1444dac4a11 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.md index d20d6f7b080..8f10aac34a4 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be added together, and therefore if they reach a point in which they can be, such as after evaluation or conversion to matrices, they can be reduced by addition. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.md index 89325e69c19..b71d1a8fd5b 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in `oplist` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.md index d1685a27353..53e18a82d54 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Class for Operators backed by Terra’s `QuantumCircuit` module. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.md index 2437db31b85..1e91f095216 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Class for Operators represented by matrices, backed by Terra’s `Operator` module. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.md index c57d66a7a05..e84d6aa35ae 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Class for Operators backed by Terra’s `Pauli` module. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.md index 885629f97c5..cd3eb4c5f45 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Class for Operators backend by Terra’s `SparsePauliOp` class. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.md index 1585b5706b7..8a274a6b773 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to “flow” - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. For example, we would not produce an interface in Terra in which `QuantumCircuit1 + QuantumCircuit2` equaled the Operator sum of the circuit unitaries, rather than simply appending the circuits. However, within the Operator flow summing the unitaries is the expected behavior. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index febdfa6359b..d77f79dd8cd 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Class for PauliSumOp after tapering diff --git a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.md index ed37b1d7f4b..9f295149475 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Z2 Symmetries diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.md index 73329ad136d..ed35370a22e 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") **A specialized measurement class to compute CVaR expectation values.** diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.md index 415f9fe128c..c2dab719b34 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra’s `QuantumCircuit` class. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.md index aec9c5f31e2..b0386453b1d 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") A class for state functions and measurements which are defined by a lookup table, stored in a dict. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.md index 9ad6f0055b4..3a472a6592d 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.md index 43dac4f19ce..5d640f211ed 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") A class for sparse state functions and measurements in vector representation. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.md index feb09fe975c..7962a41dd58 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") A class for representing state functions and measurements. diff --git a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.md index c00ed97f337..969a8a54e33 100644 --- a/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.28/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.md index 304150f966a..bd857c9c660 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.md index 674474f35f9..78e99bc2472 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 17af3a09858..1b6166ac65d 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") ADMMOptimization Result. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.md index 5a9e3ff4519..7386da93f22 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") An implementation of the ADMM-based heuristic. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.md index 15f3262f99a..4e343ff6377 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Defines a set of parameters for ADMM optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.md index 7ee07742d82..362a537c445 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Internal computation state of the ADMM implementation. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.md index 5ebec509d34..d60a3e2901f 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.md index 30263ad300e..60f4bec0f02 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.md index e8ab32b3942..2e874fdb345 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") A result object for Grover Optimization methods. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.md index d2e209d9519..efeac68726a 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.md index ab548ee9a40..e9bb5ad2434 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index fd484fd9968..493aaf92877 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Minimum Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 9a551193b54..9423baa3dfb 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") A wrapper for minimum eigen solvers from Qiskit Aqua. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.md index 67ecb8e93b2..e82e9412126 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") An abstract class that implements multi start optimization and should be sub-classed by other optimizers. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 60a45207071..cfa0e08cc4a 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") An abstract class for optimization algorithms in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.md index 29a0d61797e..83b5a934e43 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A base class for optimization results. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.md index 9026c12b26f..5dbb92371d1 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Termination status of an optimization algorithm. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index b3b2bbe8a76..dd89b22cb2f 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Recursive Eigen Optimizer Result. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index 44f22ffb05d..3941cba02c8 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") A meta-algorithm that applies a recursive optimization. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 0e30e198c16..a188258a27d 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") SLSQP optimization result, defines additional properties that may be returned by the optimizer. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.md index 83328d79f17..e88bae6e104 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). diff --git a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.md index 39310570580..670335045ed 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") A sample of an optimization solution diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md index c0e4c528922..30654adc846 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md @@ -26,7 +26,7 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Get graph solution from binary string. @@ -46,7 +46,7 @@ numpy.ndarray -`get_operator(weight_matrix, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`get_operator(weight_matrix, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Generate Hamiltonian for the clique. @@ -89,7 +89,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`satisfy_or_not(x, w, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") +`satisfy_or_not(x, w, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/clique.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md index a80b94865a2..3054279f4fc 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md @@ -27,7 +27,7 @@ common module -`get_gset_result(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`get_gset_result(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Get graph solution in Gset format from binary string. @@ -47,7 +47,7 @@ Dict\[int, int] -`parse_gset_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`parse_gset_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read graph in Gset format from file. @@ -67,7 +67,7 @@ numpy.ndarray -`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_graph(n, weight_range=10, edge_prob=0.3, negative_weight=True, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate random Erdos-Renyi graph. @@ -92,7 +92,7 @@ numpy.ndarray -`random_number_list(n, weight_range=100, savefile=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`random_number_list(n, weight_range=100, savefile=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Generate a set of positive integers within the given range. @@ -115,7 +115,7 @@ numpy.ndarray -`read_numbers_from_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`read_numbers_from_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Read numbers from a file @@ -135,7 +135,7 @@ numpy.ndarray -`sample_most_likely(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") +`sample_most_likely(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/common.py "view source code") Compute the most likely binary string from state vector. :param state\_vector: state vector or counts. :type state\_vector: numpy.ndarray or dict diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md index 343cc6b736b..d966cb3984e 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md @@ -62,7 +62,7 @@ print('tsp objective:', result['energy'] + offset) -`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") +`get_operator(mdl, auto_penalty=True, default_penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/docplex.py "view source code") Generate Ising Hamiltonian from a model of DOcplex. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md index 6eced2620c4..f974ade5491 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md @@ -24,7 +24,7 @@ exact cover -`check_solution_satisfiability(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`check_solution_satisfiability(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") check solution satisfiability @@ -32,7 +32,7 @@ check solution satisfiability -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") Construct the Hamiltonian for the exact solver problem. @@ -62,7 +62,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/exact_cover.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md index 2d3f7e88296..284fa2483c2 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md @@ -24,7 +24,7 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Generate Hamiltonian for the graph partitioning @@ -74,7 +74,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`objective_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") +`objective_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/graph_partition.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md index 6f9306be50f..f84a1081ee4 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md @@ -28,7 +28,7 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We -`get_operator(values, weights, max_weight)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_operator(values, weights, max_weight)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Generate Hamiltonian for the knapsack problem. @@ -67,7 +67,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`get_solution(x, values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`get_solution(x, values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian @@ -90,7 +90,7 @@ numpy.ndarray -`knapsack_value_weight(solution, values, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") +`knapsack_value_weight(solution, values, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/knapsack.py "view source code") Get the total wight and value of the items taken in the knapsack. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md index 0f7cd5d4d0f..4805af75417 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md @@ -24,7 +24,7 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Generate Hamiltonian for the max-cut problem of a graph. @@ -64,7 +64,7 @@ operator for the Hamiltonian float: a constant shift for the obj function. -`max_cut_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") +`max_cut_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/max_cut.py "view source code") Compute the value of a cut. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md index 451c7de04e4..4b11ba268e4 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md @@ -23,7 +23,7 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami -`get_operator(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`get_operator(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Construct the Hamiltonian for a given Partition instance. @@ -45,7 +45,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`partition_value(x, number_list)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") +`partition_value(x, number_list)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/partition.py "view source code") Compute the value of a partition. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md index 6fe5f8562f4..fb73f528287 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md @@ -24,7 +24,7 @@ set packing module -`check_disjoint(sol, list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`check_disjoint(sol, list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") check disjoint @@ -32,7 +32,7 @@ check disjoint -`get_operator(list_of_subsets)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_operator(list_of_subsets)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") Construct the Hamiltonian for the set packing. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") +`get_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/set_packing.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md index 2f6481bbfd8..49ec6bef7c5 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md @@ -24,7 +24,7 @@ Convert stable set instances into Pauli list. We read instances in the Gset form -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Get graph solution from binary string. @@ -44,7 +44,7 @@ numpy.ndarray -`get_operator(w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`get_operator(w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Generate Hamiltonian for the maximum stable set in a graph. @@ -64,7 +64,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`stable_set_value(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") +`stable_set_value(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/stable_set.py "view source code") Compute the value of a stable set, and its feasibility. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md index e5f3da7c799..7cdddb409d5 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md @@ -90,7 +90,7 @@ Alias for field number 3 -`calc_distance(coord, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`calc_distance(coord, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") calculate distance @@ -98,7 +98,7 @@ calculate distance -`get_operator(ins, penalty=100000.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_operator(ins, penalty=100000.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate Hamiltonian for TSP of a graph. @@ -119,7 +119,7 @@ tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`get_tsp_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`get_tsp_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Get graph solution from binary string. @@ -145,7 +145,7 @@ Instance data of TSP -`parse_tsplib_format(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`parse_tsplib_format(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Read graph in TSPLIB format from file. @@ -165,7 +165,7 @@ instance data. -`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`random_tsp(n, low=0, high=100, savefile=None, seed=None, name='tmp')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Generate a random instance for TSP. @@ -190,7 +190,7 @@ instance data. -`tsp_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Check whether a solution is feasible or not. @@ -210,7 +210,7 @@ bool -`tsp_value(z, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") +`tsp_value(z, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/tsp.py "view source code") Compute the TSP value of a solution. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md index cb9da8e8f25..5f65ba76a71 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md @@ -25,7 +25,7 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela -`get_operator(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_operator(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Converts an instance of a vehicle routing problem into a list of Paulis. @@ -47,7 +47,7 @@ operator for the Hamiltonian. -`get_vehiclerouting_cost(instance, n, K, x_sol)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_cost(instance, n, K, x_sol)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") Computes the cost of a solution to an instance of a vehicle routing problem. @@ -70,7 +70,7 @@ objective function value. -`get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_matrices(instance, n, K)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Constructs auxiliary matrices from a vehicle routing instance,** @@ -94,7 +94,7 @@ a matrix defining the interactions between variables. a matrix defining the cont -`get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") +`get_vehiclerouting_solution(instance, n, K, result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") **Tries to obtain a feasible solution (in vector form) of an instance** diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md index 5ed46e10885..e7a7f6ca931 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md @@ -24,7 +24,7 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https -`check_full_edge_coverage(x, w)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`check_full_edge_coverage(x, w)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") **Parameters** @@ -43,7 +43,7 @@ float -`get_graph_solution(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_graph_solution(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Get graph solution from binary string. @@ -63,7 +63,7 @@ numpy.ndarray -`get_operator(weight_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") +`get_operator(weight_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vertex_cover.py "view source code") Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. :type weight\_matrix: numpy.ndarray diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.md index f8f704a52fc..29350019ea1 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert inequality constraints into equality constraints by introducing slack variables. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.md index 2f5c80c1ef7..99f0adf8fe1 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.md index f024d2ee2e8..0dc4616b504 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with only equality constraints to unconstrained with penalty terms. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.md index ab03f35f781..f9a975f909a 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") An abstract class for converters of quadratic programs in Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.md index a8104b0ac7b..d4c568df7fa 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a given optimization problem to a new problem that is a QUBO. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.md index 93bc81c16d2..cf06eb77f61 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Abstract Constraint Class. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.md index ea2a6195930..333c6c421ac 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Representation of a linear constraint. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.md index 7d29ca84a02..571ef9bdd64 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Representation of a linear expression by its coefficients. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.md index a4b05490665..fb524232154 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Representation of a quadratic constraint. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.md index b3a3d449e0a..98483913d00 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Representation of a quadratic expression by its coefficients. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.md index 9b7213f270b..f8bfa4ff1d9 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.md index 37612451790..31d5a1779dd 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Quadratically Constrained Quadratic Program representation. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.md index e823ffa405e..fa73300a3d2 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Interface class for all objects that have a parent QuadraticProgram. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.md index 284a7cdc3eb..059a4253795 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Representation of a variable. diff --git a/docs/api/qiskit/0.28/qiskit.providers.Backend.md b/docs/api/qiskit/0.28/qiskit.providers.Backend.md index 0aaa3be371a..13646f8bdcc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.28/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.md index 424e01ddbbf..d39b0bff295 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.28/qiskit.providers.BackendV1.md index 20e857a6476..5b82dd4b902 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.28/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Abstract class for Backends diff --git a/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.md index 42cc2e09fe8..21efb4f05bf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.28/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Legacy Base class for backends. diff --git a/docs/api/qiskit/0.28/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.28/qiskit.providers.BaseJob.md index 818fa27dbab..d961ba824bf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") DEPRECATED Legacy Class to handle asynchronous jobs diff --git a/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.md index c75609c0deb..cd5828dd29f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.28/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.28/qiskit.providers.Job.md b/docs/api/qiskit/0.28/qiskit.providers.Job.md index 2dd86b09e74..f89fcf3ecfa 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.28/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobError.md b/docs/api/qiskit/0.28/qiskit.providers.JobError.md index 903c9435c0e..09b166661b8 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.28/qiskit.providers.JobStatus.md index b859beac2f1..7c113314d8b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.28/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") Class for job status enumerated type. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.md index c260931c482..b0af3a94646 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.28/qiskit.providers.JobV1.md b/docs/api/qiskit/0.28/qiskit.providers.JobV1.md index 78db98a925a..bcddb4ec3c7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.28/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Class to handle jobs diff --git a/docs/api/qiskit/0.28/qiskit.providers.Options.md b/docs/api/qiskit/0.28/qiskit.providers.Options.md index 9c747355428..0dcf962ef43 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.28/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Base options object diff --git a/docs/api/qiskit/0.28/qiskit.providers.Provider.md b/docs/api/qiskit/0.28/qiskit.providers.Provider.md index 76037bb0bfb..1c6945391df 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.28/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Base common type for all versioned Provider abstract classes. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.md index 94e9a403410..8e25ff1196f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Base class for a Backend Provider. diff --git a/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.md index a1e5b10db80..4a2597f4829 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.md index 2ee285ecc30..962f5d96008 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.md index a5f72fae952..7a37fccd21e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") AerJob class. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.md index 6baae661743..9f0aa5ad188 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Provider for Qiskit Aer backends. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.md index d4ecef6e1a4..b577121c0d3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.md index aae39c50b40..26038944531 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Pulse schedule simulator backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.md index 478eff1c779..6de36e122bd 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Noisy quantum circuit simulator backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.md index 1b8736e1fc7..2bfa769ee7a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Ideal quantum circuit statevector simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.md index 67af4b97c18..f33e13f5717 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Ideal quantum circuit unitary simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.md index 3375219cb77..4bce4e28bcc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Simulator snapshot instruction. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 9ceff996b1d..04acb3b074e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Snapshot instruction for density matrix method of Qasm simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index e93d62236e5..3af17480094 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Snapshot instruction for supported methods of Qasm simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 02d2d291dcf..871f1896ade 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Snapshot instruction for all methods of Qasm simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.md index f8c80023fec..1b9c3e53206 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Snapshot instruction for stabilizer method of Qasm simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.md index 11d82bb4e9c..666787abe8b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Snapshot instruction for statevector snapshot type diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.md index 8d3cfefbc66..e7e02378af2 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.md index a885f86b105..b8425850ea3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.md index d7a78c1bdd3..fb403cab653 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save a reduced density matrix. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.md index 592f4c16ed2..718d439257f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value of an operator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 33299020a00..74320ca87d8 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save expectation value and variance of an operator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.md index 4f6b7f0468f..a0622082a60 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save matrix product state instruction diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.md index 13f393ea907..2cd4536e0fe 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.md index 26e00da3864..3dd1e6d5b36 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities dict. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.md index e498310ce88..d50fd5dd34b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save Stabilizer instruction diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.md index 2209e923146..f796d6d5450 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save simulator state diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.md index fa4dc56309e..e195126a6e6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.md index 36e5caf5648..2daf135a8ad 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save statevector as ket-form dictionary. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.md index 993abef717d..d0a7634242a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save a SuperOp matrix. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.md index a8973160ce6..cc70799e1ca 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save Unitary diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.md index 4812e427d3e..742b3181b6f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set density matrix state of the simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.md index a28e997d3d9..303b6a63e45 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.md index ad5c0cb341d..ead9f19ca71 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.md index 6782e7435cf..4b9ece323d9 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.md index 1473ec76118..da492431713 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set superop state of the simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.md index 748c684eee7..1d566802b6a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set unitary state of the simulator diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes.md index 0b669b04105..c34cc5ee857 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes_squared.md index 79bb40eff0c..fdac25ecd47 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_density_matrix.md index 74cc65ec146..1e650bd5b06 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value.md index 2f0af0f1bc9..7d4ffada7f8 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value_variance.md index dd1ed4ef639..b591246f76c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_matrix_product_state.md index e77c2db58c1..4db8d3ff042 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities.md index 606b66af4ea..a2eaecff1b7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities_dict.md index 16ae2c687ca..086ffe552f5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_stabilizer.md index d01c85e1c12..3e086d79eaf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_state.md index 07e5c762060..5cd6ad9855d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector.md index 482606c1893..5dc73b693ee 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector_dict.md index a1f1dc7b1e3..367fbad5b48 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_unitary.md index 73d179e5f2e..06fe9ae787d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_density_matrix.md index bee816e1bb8..51fec524b7e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_matrix_product_state.md index 2db259b4d51..6c1f7c0873a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_stabilizer.md index 31c78105b09..e31c686988f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_statevector.md index 63b8fb72b15..166311867bd 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_superop.md index 28725784533..a2acde4da8a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_unitary.md index 3755cd50221..0549bfa7dae 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.md index 8a585149850..e7c214d97fc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Noise model class for Qiskit Aer simulators. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.md index 1fc3e9bcb73..e953bdcab69 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Quantum error class for Qiskit Aer noise model diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.md index fd3891e02af..cc43a7ab1d3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Readout error class for Qiskit Aer noise model. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.amplitude_damping_error.md index 0305f120e20..1fc12ab472e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.coherent_unitary_error.md index de1107669a4..aa2837fad3b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.depolarizing_error.md index 2505d42afae..a0face8dffa 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index bc242d7510e..b7c298bd8e5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index c62af1cd229..3821d29c4e8 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_error_values.md index 2b1bc8469bf..7b65ff11d8f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_length_values.md index be7ea78eba1..69721d2f87d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_param_values.md index e657b1665df..9c81011bd27 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.readout_error_values.md index 97d13adc45c..18730236d34 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index dd116379a5f..18946d6a22b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.kraus_error.md index a35fecba148..4585336fd09 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.mixed_unitary_error.md index 0669b855ab3..69625c92fe6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.pauli_error.md index c92b7ceed49..cdec5fd9b84 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index b76a0b6f054..9d1fedfdf22 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_damping_error.md index 29082f182c5..571f69680b8 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.reset_error.md index d44921cd510..c9c5a2c0aa1 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.thermal_relaxation_error.md index 09ab8cb4351..5625c43ea4d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.md index a229bde8f91..625add9df89 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Physical model object for pulse simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.duffing_system_model.md index c880b5f09ee..11af83e0ecf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.md index de7ab8ff080..974c0f09a10 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transforms one quantum channel to another based on a specified criteria. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_noise_model.md index 2f5e3d6397b..014084327f7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_quantum_error.md index 621da3e103e..6182b1978a7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.insert_noise.md index f907d1624eb..ba98e295c3c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.remap_noise_model.md index 02927d984ec..1ac257dc970 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.28/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.md index 728383e6cbb..adfa4b7d01d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.md index 99d36517705..26c1de52fdf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") BasicAerJob class. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.md index 3ba35c47773..b88d4852dbf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Provider for Basic Aer backends. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.md index c0b2c6323b3..0a8b78f38d4 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Python implementation of a qasm simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 89fc1aa789c..1e9fe698acf 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") Python statevector simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.md index 6ecfcc42f45..26ad8d63c1c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.28/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Python implementation of a unitary simulator. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.md index 077f0328e79..797f914d9b6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/accountprovider.py "view source code") Provider for a single IBM Quantum Experience account. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.md index 6829139fc8d..409a79f4dcc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/backendjoblimit.py "view source code") Job limit for a backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index 06c47789f84..35ff08ffd8a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index ad004d8290a..d061821f713 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 48f9df43f47..82b2cab1889 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 6983bde914d..d31318e3a7b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.md index 56c1b9959e7..b5b0b9b5cf3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 1425719a244..d0158ae2050 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md index 78327eb7b7d..eae1ed9e223 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/ibmqbackend.py "view source code") Backend class interfacing with an IBM Quantum Experience device. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.md index 69088ca2a6d..deb877ae526 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 81276a4f77f..4c1edc4f5c4 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.md index 0f445470109..3dc42c41cf7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.md index 80cf5e603aa..e460bcc1bd5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Backend namespace for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.md index d31c7ab0105..ee81ab8fe33 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.md index 2247acf5da0..62e6c784e7c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.md index 991562b0a56..6d2f11511f2 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/ibmqfactory.py "view source code") Factory and account manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.md index ae0b0aebb41..a76b8d2674d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.md index 28bb5d9c752..96596a254fc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runner_result.py "view source code") Result class for Qiskit Runtime program circuit-runner. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.md index c5bf0edb0f3..c607d577bbb 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/credentials.py "view source code") IBM Quantum Experience account credentials. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.md index 1ded8fb2066..f195cc16310 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 95c5d6f3ea7..f371a41b686 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 04c694493db..127b0b89d3b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.md index 7eafd54c784..6d43538152a 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.AnalysisResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.AnalysisResult -`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None, verified=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") +`AnalysisResult(experiment_uuid, device_components, result_type, fit=None, chisq=None, quality=, tags=None, result_uuid=None, backend_name=None, verified=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/experiment/analysis_result.py "view source code") Class representing an analysis result for an experiment. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.md index 42882517818..34686dd22d7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.Experiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.Experiment -`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None, notes=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/experiment/experiment.py "view source code") +`Experiment(provider, backend_name, experiment_type, extra=None, tags=None, start_datetime=None, end_datetime=None, experiment_uuid=None, plot_names=None, analysis_results=None, hub=None, group=None, project=None, share_level=None, owner=None, notes=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/experiment/experiment.py "view source code") Class representing an experiment. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.md index c61c69fb372..261d9223381 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.experiment.ExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ExperimentService -`ExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") +`ExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/experiment/experimentservice.py "view source code") Provides experiment related services. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.md index 668d351261a..5dfab8df58e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Representation of a job that executes on an IBM Quantum Experience backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.md index dfb0aacf486..4e7fe9337fa 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.md index 70f10965563..2194fd8c83d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.md index c3ae23005a4..66868f1f778 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 21aa94217c6..8a168f4a9bc 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 45cb06e218e..e35ede0aa22 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.md index 7ca47e1fc94..89187ae99c3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.job_monitor.md index 1804d2414f8..4ed9bba7c6b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.least_busy.md index c47c87cf5a1..8b76d0fbb7c 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.md index 01087ff7eca..1de95089ab9 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Job Manager for IBM Quantum Experience. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 06c72a4896a..d35e41aea96 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 30593e1f4b1..073cde4e056 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 5b1a0e63000..bc09d967387 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 9106477f588..6aebc8881d6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index bc44f6bc289..0ab9ecf66f0 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index d7941b05636..e1ad45c3153 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.md index 1182d68d833..a26d146024b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/managedjob.py "view source code") Job managed by the Job Manager. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.md index 8874e1dabf0..02866006b13 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/managedjobset.py "view source code") A set of managed jobs. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.md index 9ae2ee33033..7e461b733f5 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/managed/managedresults.py "view source code") Results managed by the Job Manager. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.md index a79fc236161..ec4d5957ee7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Class for interfacing with a CQC remote extractor. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.md index 2cf55e8d7c8..69dfc88a38f 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Representation of an asynchronous call to the CQC extractor. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.md index 5875a09cc01..4f2b0c8778e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Random number services for an IBM Quantum Experience account provider. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 53e684a898b..cc17f6adbac 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 46b59c9cfc1..e62cb184191 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(params)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(params)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") A namespace for program parameters with validation. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.md index 2d0d25e591d..e0c697fa55b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Base class for a program backend. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.md index b462c09179a..512857060dd 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Runtime job result decoder. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index 8a5e9254099..e022d27f3ed 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/utils.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index d205a239d3e..6f8d88c5be1 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/utils.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.md index 6b3d8e6abdd..e5ab60b09e4 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 4b396bba065..173f1e60ef7 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Class representing program metadata. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.md index 0820ced847a..03115353127 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Base class for handling communication with program users. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.seconds_to_duration.md index 04e201b515f..9f927e450ad 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.to_python_identifier.md index 0fe991dd894..aa2b030185b 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.update_qobj_config.md index 40615dad6b6..c6bcdeb25ce 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.utc_to_local.md index 5c53dbe6cd1..ce6362e610e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.validate_job_tags.md index 37d933fb7fb..2261cf47893 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.15/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.md index e4572e1e5d4..b759516cee8 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Backwards compat shim representing an abstract backend configuration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.md index 9a8f1d8c60d..e3a2c098234 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Class representing backend properties diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.md index 42b29a6511b..f3763390bfb 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Class representing Backend Status. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.Command.md b/docs/api/qiskit/0.28/qiskit.providers.models.Command.md index 027dffafd8e..072c6d3c2fb 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Class representing a Command. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.md index ed2083d7c75..91cb06c8a1e 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Gate Configuration diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.md index 3cc82247a95..122e74ca2c6 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Model for JobStatus. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md index bdc48b32d44..1be382635e3 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Static configuration state for an OpenPulse enabled backend. This contains information about the set up of the device which can be useful for building Pulse programs. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.md index 40d3ca916d5..8521a6c2c12 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Description of default settings for Pulse systems. These are instructions or settings that may be good starting points for the Pulse user. The user may modify these defaults for custom scheduling. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.md index 045b570ba2c..336153346ad 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a Qasm Backend Configuration. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.md index fb5cc456bc5..352823c8b34 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Class representing a U Channel LO diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md index 21ea12f0366..095bea6fbc5 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md index 977a37a7c01..4be0507766e 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Call.md b/docs/api/qiskit/0.28/qiskit.pulse.Call.md index 6595c906c46..46df91fa399 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Constant.md b/docs/api/qiskit/0.28/qiskit.pulse.Constant.md index 278d4e375ab..5ce4457446d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md index f14a27549b7..d0a411a3878 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Delay.md b/docs/api/qiskit/0.28/qiskit.pulse.Delay.md index 9ef9f53191d..900b2b7363d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Drag.md b/docs/api/qiskit/0.28/qiskit.pulse.Drag.md index 1d5c936f882..bd5125ee71e 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md index 3f799eff155..e8199f134b8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.md index 8e020d99a6c..436a32e83be 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.md index 88f94a287f9..b7fe4896768 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md index c5fdc1fdc59..447ce0aa778 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.md index 8b035d136f1..0c31e1eed8a 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: diff --git a/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md index 820bf6dbc2a..d3c07c6115c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md index 43c68c8f0e5..44ecba3d1dd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Play.md b/docs/api/qiskit/0.28/qiskit.pulse.Play.md index a7d6608fc9d..12438b398dd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.28/qiskit.pulse.PulseError.md index 2a5c60739e2..91aa8e0774f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md index 53e644cd0f5..d13ff26d7ce 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md index d4b3c13fc71..58f9c9fe1d4 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md index 57622395c54..3aeb6a1fa92 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. The relative position of the instructions is managed by the `context_alignment`. This allows `ScheduleBlock` to support instructions with a parametric duration and allows the lazy scheduling of instructions, i.e. allocating the instruction time just before execution. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md index d871e52fafd..8bb936e0094 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md index 4096d28927c..deff8293975 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md index abbbd4b3ac9..126961c9625 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md index 3c3db0d9d92..9d569347639 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md index 544862446e7..28dbad39471 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.28/qiskit.pulse.Waveform.md index 885c412b51e..0f35105b77a 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md index dc385ad2565..7f8e3dab77f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md index cb805c9a027..2a590206284 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.active_backend.md index 29546869ebf..ca6fd922e1f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 4e74842ec4f..16cbc35b5f1 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.active_transpiler_settings.md index f3a15baa159..32640b97eb2 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_equispaced.md index 2eafd030e14..69b77108c81 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_func.md index 8f40cef6bd0..00f6cb2de16 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_left.md index cbbb71aac73..fd6505616a3 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_right.md index 572951819b6..fb6aa7e45cd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_sequential.md index 0b1585565a3..8b9a24f84a2 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md index 867986f31fa..e46f0073c2f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.build.md index 6e9fef84af6..027f1148f27 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.call.md index d69592c6a61..582dcc9cd79 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.circuit_scheduler_settings.md index 657d3302d88..a65c3624e7e 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md index 6e70c1a7b14..8d49ffe047c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.cx.md index 7e02b9e1bb7..95a269bec64 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md index cef465980e1..c0180c48cfc 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.delay_qubits.md index b0f847d24e3..70add771a15 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md index 0954533412f..5325ea2b511 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md index ac1b318c989..3beb662bb81 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.inline.md index 5f57428166d..5b9fedec7e9 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md index ca9b35d9890..d08b27f33f8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md index 09df2e00f29..5962ef6b3da 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md index dc5bb0eeece..5619f19b241 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.num_qubits.md index 676d2ed6d40..701276b045b 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md index 19396d3b77b..609f39c56b4 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md index 4ac9536133e..f0f2e796d61 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md index 7aa1e665ae3..b5cd32d1cd8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md index d1c6c2b14ea..20ebb673e9f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.samples_to_seconds.md index b6d7fcda54f..dd76abd524f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.seconds_to_samples.md index d93f52c4470..79d53f9ed18 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md index 9a2adc4ac70..e72e4877b9c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md index 124c645d77d..6dc99b78c22 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md index 86f9c48e6ec..e5efb629d84 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md index 89bfc382db1..ee642d4a0fb 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.snapshot.md index e983009dc0b..5a5c3597646 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.transpiler_settings.md index f5fbba68e32..d55a51109be 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.u1.md index 9941efd5892..0372cd49e83 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.u2.md index 593b6b26057..1106180b726 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.u3.md index ec7e467dae9..a78e299a90d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.x.md index 0a4e7cc7f76..db5b0046e3d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.channels.md b/docs/api/qiskit/0.28/qiskit.pulse.channels.md index 5c4e6ebaf8b..5f127422cba 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.channels.md @@ -34,7 +34,7 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Acquire channels are used to collect data. @@ -119,7 +119,7 @@ Parameters which determine the channel index. -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -216,7 +216,7 @@ A shorthand string prefix for characterizing the channel type. -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Control channels provide supplementary control over the qubit to the drive channel. These are often associated with multi-qubit gate operations. They may not map trivially to a particular qubit index. @@ -301,7 +301,7 @@ Parameters which determine the channel index. -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Drive channels transmit signals to qubits which enact gate operations. @@ -386,7 +386,7 @@ Parameters which determine the channel index. -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Measure channels transmit measurement stimulus pulses for readout. @@ -471,7 +471,7 @@ Parameters which determine the channel index. -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Memory slot channels represent classical memory storage. @@ -556,7 +556,7 @@ Parameters which determine the channel index. -`PulseChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`PulseChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Base class of transmit Channels. Pulses can be played on these channels. @@ -641,7 +641,7 @@ Parameters which determine the channel index. -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Classical resister slot channels represent classical registers (low-latency classical memory). @@ -726,7 +726,7 @@ Parameters which determine the channel index. -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Snapshot channels are used to specify instructions for simulators. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md index ba9ff115e89..cd7750d154d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. instantiated with AcquireChannel(0), the Acquire command will trigger data collection for the channel associated with qubit 0 readout. This instruction also provides acquisition metadata: diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md index b07022f4c66..91943ad6982 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Pulse `Call` instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md index 3476ffb6741..8114024e685 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md index 6ee3d1381f1..0e17132a5fd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md index cd2667eeae1..7de65b60f51 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") This instruction is responsible for applying a pulse on a channel. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md index d18463d9593..ab342af3f6b 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Set the channel frequency. This instruction operates on `PulseChannel` s. A `PulseChannel` creates pulses of the form diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md index dd7fa1d7712..e9e58b41957 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md index 7579d41a2c0..9783f32d484 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Shift the channel frequency away from the current frequency. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md index 1c5e418fd25..a667e48e076 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md index 7d696d63e28..e09ce4c1de8 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") An instruction targeted for simulators, to capture a moment in the simulation. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.md index d8a44d2c407..525cc41e426 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") A simple constant pulse, with an amplitude value and a duration: diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.md index cf262760cef..bd734661852 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle$ - $|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.md index a4031a5e61c..6aca34494e5 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.md index e7be854181f..74a06273157 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") **A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.md index 6fc309fa605..5d77ace1b9f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md index 2bb30df0c46..d008ae84e3b 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md @@ -36,7 +36,7 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -60,7 +60,7 @@ $$ -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -86,7 +86,7 @@ $$ -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -121,7 +121,7 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -159,7 +159,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -186,7 +186,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -226,7 +226,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -274,7 +274,7 @@ plt.plot(range(duration), sawtooth_wave) -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -310,7 +310,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -337,7 +337,7 @@ i.e. the derivative of $\text{sech}$. -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -363,7 +363,7 @@ $$ -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -391,7 +391,7 @@ with the convention $\text{sign}(0) = 1$. -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). @@ -439,7 +439,7 @@ plt.plot(range(duration), triangle_wave) -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). diff --git a/docs/api/qiskit/0.28/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.28/qiskit.pulse.transforms.add_implicit_acquires.md index 4a6619928c2..0980cb98d6b 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.28/qiskit.pulse.transforms.align_measures.md index 912fbe3c1d7..e455aa7afbd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md index c4916807d12..e8c8f1c74b9 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.md index 5ca91142ff0..bdd620ab9fe 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.28/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.28/qiskit.qasm.Qasm.md index 6c12c283369..ae7750fdd04 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.28/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.28/qiskit.qasm.QasmError.md index 8cdd6f9a304..b3a88f0f9dc 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.28/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.md index 2b225860c22..dd3f1e573d8 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.28/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). diff --git a/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.md index 84118d57535..5e0e1b96dbb 100644 --- a/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.28/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.md index 0920b0d37ef..d3b11a68fd3 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.md index 5bf89dbb256..2db02dea567 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") An item in a pulse library. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.md index e9ee46f5577..444533a6db9 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.md index 23dbf9dd633..d11ad727929 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") A configuration for a Pulse Qobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.md index cee9bfc6920..c4100cd67e7 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") A Pulse Qobj Experiment. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.md index 1b2b11d3031..055e302e602 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") A config for a single Pulse experiment in the qobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.md index ea2221e4106..a541a89cc66 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") A class representing a single instruction in an PulseQobj Experiment. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.md index 82a19f9f972..2a870e0d610 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") A container for any calibrations data. The gates attribute contains a list of GateCalibrations. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.md index 8ed17f022b5..157a3473c09 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.md index 8d5be91f94b..05df31bc739 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") A configuration for a QASM Qobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.md index b0f6bad6169..4f767ec0177 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") A QASM Qobj Experiment. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.md index 02a7a579291..c1c8c5ec645 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Configuration for a single QASM experiment in the qobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.md index ff6c5626310..bc847587b35 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") A class representing a single instruction in an QasmQobj Experiment. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.28/qiskit.qobj.Qobj.md index 9f1ace7dd88..945ac2bea34 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") A backwards compat alias for QasmQobj. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.md index 0101cc150fa..77f5bf3444c 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") A class representing a header dictionary for a Qobj Experiment. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.md index 684a4111476..cb32a5165f3 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") A class used to represent a dictionary header in Qobj objects. diff --git a/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.md index fa8b1037721..4ec7ecea821 100644 --- a/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.28/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") An individual measurement option. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.md index 0d21b07644a..bfa6d33cb12 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") An N-qubit operator from the CNOT-Dihedral group. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.md index d280d14249a..6c8d5248939 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Pauli basis Chi-matrix representation of a quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.md index e1285b1522b..d7dd3cca4de 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Choi-matrix representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.md index 76f88ad89ff..179067e9ec9 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") An N-qubit unitary operator from the Clifford group. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.md index b6cc3d16db3..7bc06e77724 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") DensityMatrix class diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.md index 225bace9350..c58a608b7b8 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Kraus representation of a quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.md index 074b741fa49..0ab7a78815a 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") A class for decomposing 1-qubit unitaries into Euler angle rotations. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.md index 882c14c4e84..98ef992536f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Matrix operator class diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.md index a22672ec2c9..db5955039bf 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Pauli Transfer Matrix (PTM) representation of a Quantum Channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.md index 6704f1ffff1..24fbb95bea9 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") N-qubit Pauli operator. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.md index f7d8295ddb9..8861367144c 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") List of N-qubit Pauli operators. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.md index c3a1e50b49a..2d6ec24401f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Symplectic representation of a list Pauli matrices. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.md index 04a849c8a65..4e42c2fcd53 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") A class representing a Quaternion. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.md index 229765fc433..5a518e410be 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Scalar identity operator class. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.md index 4a93de4fd11..9e5cd6b19f4 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sparse N-qubit operator in a Pauli basis representation. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.md index 0b5cb7cd848..cdfd9383011 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.md index 41d55afba13..65f160ac345 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Symplectic representation of a list Stabilizer matrices. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.md index 40316bd9241..e5557a4721c 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Statevector class diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.md index a332734386f..69a06618bdf 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Stinespring representation of a quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.md index 683e0b4065d..a580244333b 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Superoperator representation of a quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 624b59c94fe..145f95fed05 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.28/qiskit.quantum_info.average_gate_fidelity.md index 7fb9a34233e..1b5652e7c30 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.28/qiskit.quantum_info.concurrence.md index c78b08178f3..687f9ae3338 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.28/qiskit.quantum_info.decompose_clifford.md index 6ca92850231..7d7e125d7df 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.28/qiskit.quantum_info.diamond_norm.md index 86f41fd7f25..a21fca61eb8 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.28/qiskit.quantum_info.entanglement_of_formation.md index ba0a5cf5d39..474efe05fef 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.28/qiskit.quantum_info.entropy.md index 972b7960c19..75988e6cee9 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.28/qiskit.quantum_info.gate_error.md index 2e21141eb7e..d0cc1eb2da5 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_distance.md index adfb9615a12..1efd2679b14 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_fidelity.md index 7630d314551..7af36f731c7 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.28/qiskit.quantum_info.mutual_information.md index e4a660de27e..255470a0614 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.28/qiskit.quantum_info.partial_trace.md index fcab650edfc..c35c456a54e 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_basis.md index 1013541d50e..67e47327c8d 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_group.md index 4e5d94cc6fe..f7f574ad41f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.28/qiskit.quantum_info.process_fidelity.md index 54dc69af792..0fe2d78fe1c 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.28/qiskit.quantum_info.purity.md index 2508d906b61..dfe63a28948 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_clifford.md index e397857937f..ebc9b143eca 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_cnotdihedral.md index 78482875122..7bf929ca519 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_density_matrix.md index 712a7a1eb2c..53f6e8e95a0 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_hermitian.md index 7822a9824b8..3a7c0fe6d7a 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli.md index bd5ff2607f8..1a1172b860f 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli_table.md index 137ca4d950e..6eafed31d9d 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_quantum_channel.md index 22449571abe..c74cf52ae83 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_stabilizer_table.md index 7b50b105331..3e9133f893d 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_statevector.md index ffd24a93345..c11755caa79 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.28/qiskit.quantum_info.random_unitary.md index fbfab7f787f..8ebc0cd56d2 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.28/qiskit.quantum_info.shannon_entropy.md index 3cffae817a1..d1f3ed5ceb7 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.28/qiskit.quantum_info.state_fidelity.md index a17bb1a7eeb..219305ec9d7 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.28/qiskit.result.Counts.md b/docs/api/qiskit/0.28/qiskit.result.Counts.md index ca92ad13cf7..cb82c1db037 100644 --- a/docs/api/qiskit/0.28/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.28/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") A class to store a counts result from a circuit execution. diff --git a/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.md index aac4fbd4b7b..ebd1e4e8f8c 100644 --- a/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") A generic dict-like class for probability distributions. diff --git a/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.md index 1ffc6f2cdee..cd0f589694b 100644 --- a/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.28/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") A dict-like class for representing qasi-probabilities. diff --git a/docs/api/qiskit/0.28/qiskit.result.Result.md b/docs/api/qiskit/0.28/qiskit.result.Result.md index 3ed6b579565..83d79e09247 100644 --- a/docs/api/qiskit/0.28/qiskit.result.Result.md +++ b/docs/api/qiskit/0.28/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Model for Results. diff --git a/docs/api/qiskit/0.28/qiskit.result.ResultError.md b/docs/api/qiskit/0.28/qiskit.result.ResultError.md index 88c48a58336..1c1f7844f3a 100644 --- a/docs/api/qiskit/0.28/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.28/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.28/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.28/qiskit.result.marginal_counts.md index 984ec18e675..4fbf937bd99 100644 --- a/docs/api/qiskit/0.28/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.28/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.md index 7a5a0defb78..61d5b1a9b37 100644 --- a/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.28/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. diff --git a/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md index f64450184c4..f7e574b2236 100644 --- a/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md @@ -23,7 +23,7 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat -`as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/methods/basic.py "view source code") +`as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. @@ -48,7 +48,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as late as -`as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/methods/basic.py "view source code") +`as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. diff --git a/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md index cd74fda7445..f92590a3021 100644 --- a/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md @@ -22,7 +22,7 @@ QuantumCircuit to Pulse scheduler. -`schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/schedule_circuit.py "view source code") +`schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. diff --git a/docs/api/qiskit/0.28/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.28/qiskit.tools.backend_monitor.md index 900dae82e23..8917e8199fd 100644 --- a/docs/api/qiskit/0.28/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.28/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.28/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.28/qiskit.tools.backend_overview.md index 957fb280a60..f988ef320c1 100644 --- a/docs/api/qiskit/0.28/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.28/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.28/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.28/qiskit.tools.job_monitor.md index 3d16ebac30c..92e57bda169 100644 --- a/docs/api/qiskit/0.28/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.28/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.28/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.28/qiskit.tools.parallel_map.md index 07db725f8f3..f232ba2823a 100644 --- a/docs/api/qiskit/0.28/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.28/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.md index 6ee195b5faf..b2743b01a48 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") An analysis pass: change property set, not DAG. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.md index cae94a8309e..846fa7c1852 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Directed graph specifying fixed coupling. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.md index aedfc392142..ed4c29d3f39 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") A dag circuit that cannot be modified (via remove\_op\_node) diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.md index 136a4111943..80c498d949e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") A property set that cannot be written (via \_\_setitem\_\_) diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.md index 32ca436e68e..3640e80956f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Base class for multiple types of working list. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.md index 40271631e9c..bf16fbe975a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Helper class to provide durations of instructions for scheduling. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.28/qiskit.transpiler.Layout.md index bb235bbebcc..d505d5a4178 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Two-ways dict to represent a Layout. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.md index e7103c345a2..81c459766e7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Manager for a set of Passes and their scheduling during transpilation. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.md index 684e9df2b56..db08e696481 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") Pass Manager Configuration. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.md index 54837a93757..6323c02a2d9 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") A default dictionary-like object diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.md index a696c502aba..08569ef1856 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") A transformation pass: change DAG, not property set. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.md index d5bdb848b56..a9bd66a217c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.md index ede8a941fd3..7f585ec0b79 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.md index 613ccd9f32b..cec647bcb9e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") ALAP Scheduling. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.md index 68f627f10b3..4b9ff89e556 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") ASAP Scheduling. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.md index 62a3558f858..4d130204338 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Measurement alignment. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.md index 848e275a986..1b979a9e569 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Transform a circuit with virtual qubits into a circuit with physical qubits. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.md index 958605bd114..2795816552d 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 970d4c19992..8798ae6c8d2 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Add a barrier before final measurements. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.md index e34878cc211..5c8459408bc 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.md index 50bb651acd3..1bc3ecfaf9b 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.md index 4ff3920863d..bd5fee2132d 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") If possible, chooses a Layout as a CSP, using backtracking. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.md index f17ed09247d..5652e847e50 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Cancel back-to-back cx gates in dag. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.md index 4ff573fd10a..b030aa75dd4 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.md index cbcfaaebb5a..73a2a3f06ed 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.md index 319caf59a2e..77991876e36 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Check if the two-qubit gates follow the right direction with respect to the coupling map. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.md index db98250f780..d6e1459ccb8 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Check if a DAG circuit is already mapped to a coupling map. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.md index 9de6263ea67..9a31526e481 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Collect sequences of uninterrupted gates acting on 2 qubits. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.md index 6de46d0ae2c..5a98e2b3a41 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Analysis pass to find commutation relations between DAG nodes. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.md index 95989e2609c..c91b4dc8fd7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Cancel the redundant (self-adjoint) gates through commutation relations. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.md index 194279923d0..377b6b3a135 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Replace each block of consecutive gates by a single Unitary node. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.md index 37ade48a627..b3c95e53b3a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Count the operations in a DAG circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.md index d158a3b0d4a..eeb33d453f9 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Count the operations on the longest path in a DAGcircuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index b39d0e0ea44..226c76d5d89 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Crosstalk mitigation through adaptive instruction scheduling. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.md index 39cec163c87..70f8635851f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Check if the DAG has reached a fixed point. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.md index 26761eac36e..04530b4275e 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Return the longest path in a DAGcircuit as a list of DAGNodes. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.md index 01faeb70426..493f4237f1c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Expand a gate in a circuit using its decomposition rules. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.md index 6080d5befb4..bd64398662b 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Choose a Layout by finding the most connected subset of qubits. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.md index 118d970d932..3810c998e56 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Calculate the depth of a DAG circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.md index a7b962a0e6e..7523eaa7b06 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.md index e54038edc0a..952fcbbf684 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Extend the dag with virtual qubits that are in layout but not in the circuit yet. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.md index 894ab692184..55f66f73d62 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Check if a property reached a fixed point. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.md index 16dfe0d4126..03993fdab2c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Allocate all idle nodes from the coupling map as ancilla on the layout. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.md index 0968bb64996..51092875c32 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Modify asymmetric gates to match the hardware coupling direction. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.md index f9eec63f57e..94bed849b67 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Evaluate how good the layout selection was. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.md index 6884bc60e24..de7f07cec79 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 0ef0ae08ea9..f114e2ce64f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Return a circuit with any adjacent barriers merged together. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index e02e5890cf4..db095664b3f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Choose a noise-adaptive Layout based on current calibration data for the backend. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.md index 10e4e68e36d..54599cf8aa5 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Calculate the number of tensor factors of a DAG circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.md index ac16817c34c..c1a13b08107 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index d5415695585..c39fcdcfe35 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Optimize chains of single-qubit gates by combining them into a single gate. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.md index d16a19f7853..d550dc93551 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in [https://arxiv.org/abs/2012.11660](https://arxiv.org/abs/2012.11660). diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 0a2e84ffd61..dba3d2a0ae3 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.md index ee3da43634e..a4ae6634687 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Return a circuit with any barrier removed. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 66daed1cbbe..41250a8bb3d 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Remove diagonal gates (including diagonal 2Q gates) before a measurement. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.md index c30f2b3a881..81e10bbb015 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Remove final measurements and barriers at the end of a circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.md index 5c74823264a..ea928eb889c 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Remove reset gate when the qubit is in zero state. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.md index b69cf109169..e1715dc7034 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Choose a Layout via iterative bidirectional routing of the input circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.md index b14632eee90..741d6f43050 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Map input circuit onto a backend topology via insertion of SWAPs. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.md index e6a256dc924..b50c9abbee4 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Set the `layout` property to the given layout. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.md index 0a3f474fdd0..feee1504f2b 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Calculate the size of a DAG circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.md index 7544d8191f2..089fc646802 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Map a DAGCircuit onto a coupling\_map adding swap gates. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.md index 8ad6789d347..21a1cceba9a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Class for the template optimization pass. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.md index c727ebc6803..87d36e3415f 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.md index 3a00927e03b..7c11fa4a5ae 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.md index a06233c7c3c..afd166b36b6 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Synthesize gates according to their basis gates. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.md index 5713e625243..ddcf067d9a0 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 9af96ef4d2b..81657c4f903 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Unrolls instructions with custom definitions. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.md index ea8b0f12a75..d36cf56a370 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Unroll a circuit to a given basis. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.md index afea74f1558..ed4093d8c5a 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Check custom gate length. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.md index e29e0f0b973..f8814beedc9 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Calculate the width of a DAG circuit. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index ce49450400a..e56210238e8 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 893991f1e1e..5fa14dacdf7 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 2a48a316b60..ad034c98bdb 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 67a6d205867..241fe8b08a2 100644 --- a/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.28/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.md index 2d286458848..00140d4c949 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.28/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Quantum Backend including execution setting. diff --git a/docs/api/qiskit/0.28/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.28/qiskit.utils.apply_prefix.md index 2017d1c6643..a28b67fdb37 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.28/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.28/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.28/qiskit.utils.deprecate_arguments.md index 8282d5f19c9..a828755849a 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.28/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.28/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.28/qiskit.utils.deprecate_function.md index 2b87a5fcc00..4f63f06df1f 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.28/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.28/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.28/qiskit.utils.get_entangler_map.md index 6cf74ea4af2..236fae021fb 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.28/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.28/qiskit.utils.has_aer.md b/docs/api/qiskit/0.28/qiskit.utils.has_aer.md index 189bf9bfc23..102a23afe92 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.28/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.28/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.28/qiskit.utils.has_ibmq.md index 60361543541..be11ff87ff7 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.28/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.28/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.28/qiskit.utils.is_main_process.md index fa2d188fc3a..0ea19e37f4f 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.28/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.28/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.28/qiskit.utils.local_hardware_info.md index 830ffd2cddc..3844e400dc4 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.28/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.28/qiskit.utils.name_args.md b/docs/api/qiskit/0.28/qiskit.utils.name_args.md index eaa2979d4a7..1b871d1ee39 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.28/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.28/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.28/qiskit.utils.summarize_circuits.md index a0271e0a592..80bf315381d 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.28/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.28/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.28/qiskit.utils.validate_entangler_map.md index 2b216c7bc49..88c3e19f384 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.28/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.md index aea5f3bad3a..5c735f64614 100644 --- a/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.28/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.28/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.28/qiskit.validation.jsonschema.validate_json_against_schema.md index 2a574f25167..0b6d588facc 100644 --- a/docs/api/qiskit/0.28/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.28/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.md index 1a7bb57cf13..7d9c9d316f0 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.28/qiskit.visualization.array_to_latex.md index 6be62f03dfb..6168a0bbc64 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.28/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.28/qiskit.visualization.circuit_drawer.md index db742e43a07..81c3dd05ba8 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.28/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.28/qiskit.visualization.dag_drawer.md index 6286a698ffc..71af4c54136 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.28/qiskit.visualization.pass_manager_drawer.md index df1f70d2634..06fff318385 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_multivector.md index 53dd6813e9f..bd4437ced93 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_vector.md index 76e76c2197b..3e9df177e40 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_circuit_layout.md index cd3b986c9ba..3a9659cca6e 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_error_map.md index 22cedefe7c4..b80950bc7d1 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_gate_map.md index 5d13bf73e84..4aaa9cd2c7a 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_histogram.md index ccb67695b8d..7b07b527f32 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_city.md index 4145748cba2..18171db8db8 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_hinton.md index f48a630c514..12bb7699aa5 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_paulivec.md index 8dc0cc3cc25..79fd06d25da 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_qsphere.md index 308670b3286..144a816ce6d 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.md index 4da5242c4e4..bd6fcd6d016 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Pulse stylesheet for pulse programmers. Show details of instructions. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.md index 86de3ab305d..384e5b33fd3 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Simple pulse stylesheet without channel notation. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.md index 4db22f1daea..1778735cf9b 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Standard pulse stylesheet. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md index a488c639322..be3e1db849f 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.md index 278b2813aa3..877903b6839 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") Creates a Default Style dictionary diff --git a/docs/api/qiskit/0.28/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.28/qiskit.visualization.timeline.draw.md index cb247d638d3..c6b74a1aa46 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.28/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.28/qiskit.visualization.visualize_transition.md index f799d8cd91f..bdd0cdda636 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 4a69c8f0ca2ca8441b0962264ffec71c9b1d3090 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:26:51 +0100 Subject: [PATCH 10/41] Regenerate qiskit 0.29.1 --- docs/api/qiskit/0.29/execute.md | 2 +- docs/api/qiskit/0.29/logging.md | 2 +- .../0.29/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.29/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.29/qiskit.algorithms.Grover.md | 8 +- .../0.29/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.29/qiskit.algorithms.HHL.md | 6 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- .../0.29/qiskit.algorithms.LinearSolver.md | 4 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.algorithms.NumPyLinearSolver.md | 4 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.29/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.29/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.29/qiskit.algorithms.Shor.md | 8 +- .../0.29/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.29/qiskit.algorithms.VQE.md | 20 +- .../0.29/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.29/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.29/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.29/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.29/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.29/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 6 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.29/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.29/qiskit.algorithms.optimizers.SPSA.md | 10 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- .../0.29/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.29/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.29/qiskit.aqua.QuantumInstance.md | 16 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 6 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 4 +- ...ua.algorithms.AmplitudeEstimationResult.md | 4 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 4 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 4 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 4 +- .../qiskit/0.29/qiskit.aqua.algorithms.EOH.md | 4 +- .../qiskit.aqua.algorithms.Eigensolver.md | 6 +- ...iskit.aqua.algorithms.EigensolverResult.md | 4 +- .../0.29/qiskit.aqua.algorithms.Grover.md | 10 +- .../qiskit.aqua.algorithms.GroverResult.md | 4 +- .../qiskit/0.29/qiskit.aqua.algorithms.HHL.md | 10 +- .../0.29/qiskit.aqua.algorithms.HHLResult.md | 4 +- .../0.29/qiskit.aqua.algorithms.IQPE.md | 6 +- ...algorithms.IterativeAmplitudeEstimation.md | 4 +- ...thms.IterativeAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.LinearsolverResult.md | 4 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 6 +- ...imumLikelihoodAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 6 +- ...qua.algorithms.MinimumEigensolverResult.md | 4 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 4 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.29/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.29/qiskit.aqua.algorithms.QGAN.md | 10 +- .../qiskit/0.29/qiskit.aqua.algorithms.QPE.md | 6 +- .../0.29/qiskit.aqua.algorithms.QSVM.md | 24 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 6 +- .../0.29/qiskit.aqua.algorithms.Shor.md | 6 +- .../0.29/qiskit.aqua.algorithms.Simon.md | 4 +- .../0.29/qiskit.aqua.algorithms.SklearnSVM.md | 12 +- .../qiskit/0.29/qiskit.aqua.algorithms.VQC.md | 24 +- .../qiskit/0.29/qiskit.aqua.algorithms.VQE.md | 18 +- .../qiskit/0.29/qiskit.aqua.circuits.CNF.md | 4 +- .../qiskit/0.29/qiskit.aqua.circuits.DNF.md | 4 +- .../qiskit/0.29/qiskit.aqua.circuits.ESOP.md | 4 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 4 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 4 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 10 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 10 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 8 +- ...aqua.components.feature_maps.FeatureMap.md | 8 +- ...omponents.feature_maps.RawFeatureVector.md | 4 +- ...t.aqua.components.initial_states.Custom.md | 4 +- ....components.initial_states.InitialState.md | 4 +- ....components.initial_states.VarFormBased.md | 4 +- ...kit.aqua.components.initial_states.Zero.md | 4 +- ...mponents.multiclass_extensions.AllPairs.md | 8 +- ...lticlass_extensions.ErrorCorrectingCode.md | 8 +- ...lticlass_extensions.MulticlassExtension.md | 10 +- ...ts.multiclass_extensions.OneAgainstRest.md | 8 +- ...s.neural_networks.DiscriminativeNetwork.md | 12 +- ...nents.neural_networks.GenerativeNetwork.md | 12 +- ...ents.neural_networks.NumPyDiscriminator.md | 14 +- ...ts.neural_networks.PyTorchDiscriminator.md | 16 +- ...onents.neural_networks.QuantumGenerator.md | 14 +- .../qiskit.aqua.components.optimizers.ADAM.md | 12 +- .../qiskit.aqua.components.optimizers.AQGD.md | 6 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 6 +- .../qiskit.aqua.components.optimizers.CG.md | 6 +- ...iskit.aqua.components.optimizers.COBYLA.md | 6 +- .../qiskit.aqua.components.optimizers.CRS.md | 4 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 4 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 4 +- .../qiskit.aqua.components.optimizers.ESCH.md | 4 +- .../qiskit.aqua.components.optimizers.GSLS.md | 14 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 6 +- ...qiskit.aqua.components.optimizers.ISRES.md | 4 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 6 +- ....aqua.components.optimizers.NELDER_MEAD.md | 6 +- .../qiskit.aqua.components.optimizers.NFT.md | 6 +- ...it.aqua.components.optimizers.Optimizer.md | 16 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 6 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 6 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 6 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 6 +- .../qiskit.aqua.components.optimizers.SPSA.md | 6 +- .../qiskit.aqua.components.optimizers.TNC.md | 6 +- ....components.oracles.CustomCircuitOracle.md | 4 +- ...ponents.oracles.LogicalExpressionOracle.md | 6 +- .../qiskit.aqua.components.oracles.Oracle.md | 4 +- ...qua.components.oracles.TruthTableOracle.md | 6 +- ...qua.components.reciprocals.LongDivision.md | 6 +- ...a.components.reciprocals.LookupRotation.md | 6 +- ....aqua.components.reciprocals.Reciprocal.md | 6 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 4 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 6 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 4 +- ...els.MultivariateVariationalDistribution.md | 6 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 4 +- ....uncertainty_models.UniformDistribution.md | 8 +- ...certainty_models.UnivariateDistribution.md | 6 +- ...odels.UnivariateVariationalDistribution.md | 6 +- ...ncertainty_problems.MultivariateProblem.md | 8 +- ...uncertainty_problems.UncertaintyProblem.md | 4 +- ...lems.UnivariatePiecewiseLinearObjective.md | 8 +- ....uncertainty_problems.UnivariateProblem.md | 8 +- ...nents.variational_forms.VariationalForm.md | 8 +- .../qiskit.aqua.operators.OperatorBase.md | 36 +-- ...qua.operators.converters.AbelianGrouper.md | 6 +- ...qua.operators.converters.CircuitSampler.md | 8 +- ...aqua.operators.converters.ConverterBase.md | 4 +- ...a.operators.converters.DictToCircuitSum.md | 4 +- ...a.operators.converters.PauliBasisChange.md | 22 +- ...aqua.operators.evolutions.EvolutionBase.md | 4 +- ...a.operators.evolutions.EvolutionFactory.md | 4 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 30 +-- ...ua.operators.evolutions.MatrixEvolution.md | 4 +- ...rators.evolutions.PauliTrotterEvolution.md | 8 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 4 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 4 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 4 +- ...rators.evolutions.TrotterizationFactory.md | 4 +- ...rators.expectations.AerPauliExpectation.md | 6 +- ....operators.expectations.CVaRExpectation.md | 6 +- ....operators.expectations.ExpectationBase.md | 6 +- ...erators.expectations.ExpectationFactory.md | 4 +- ...perators.expectations.MatrixExpectation.md | 6 +- ...operators.expectations.PauliExpectation.md | 6 +- ...qua.operators.gradients.CircuitGradient.md | 4 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 4 +- ...aqua.operators.gradients.DerivativeBase.md | 8 +- ...iskit.aqua.operators.gradients.Gradient.md | 6 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 6 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 4 +- .../qiskit.aqua.operators.gradients.QFI.md | 4 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 16 +- ...it.aqua.operators.legacy.MatrixOperator.md | 24 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 10 +- ....operators.legacy.WeightedPauliOperator.md | 50 ++--- ...skit.aqua.operators.legacy.Z2Symmetries.md | 14 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 14 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 46 ++-- ...qiskit.aqua.operators.list_ops.SummedOp.md | 18 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 10 +- ....aqua.operators.primitive_ops.CircuitOp.md | 30 +-- ...t.aqua.operators.primitive_ops.MatrixOp.md | 28 +-- ...it.aqua.operators.primitive_ops.PauliOp.md | 34 +-- ...qua.operators.primitive_ops.PrimitiveOp.md | 46 ++-- ...qua.operators.state_fns.CVaRMeasurement.md | 30 +-- ...aqua.operators.state_fns.CircuitStateFn.md | 36 +-- ...it.aqua.operators.state_fns.DictStateFn.md | 24 +- ...qua.operators.state_fns.OperatorStateFn.md | 24 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 40 ++-- ....aqua.operators.state_fns.VectorStateFn.md | 26 +-- .../0.29/qiskit.aqua.utils.CircuitFactory.md | 26 +-- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.29/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.29/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.29/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.29/qiskit.aqua.utils.name_args.md | 2 +- .../0.29/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.29/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.29/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.29/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.29/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.29/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.29/qiskit.assembler.disassemble.md | 2 +- .../0.29/qiskit.chemistry.BosonicOperator.md | 8 +- .../qiskit.chemistry.FermionicOperator.md | 18 +- .../qiskit/0.29/qiskit.chemistry.MP2Info.md | 6 +- .../qiskit/0.29/qiskit.chemistry.QMolecule.md | 24 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 6 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 4 +- ...chemistry.algorithms.EigensolverFactory.md | 4 +- ...try.algorithms.ExcitedStatesEigensolver.md | 4 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 4 +- ...istry.algorithms.GroundStateEigensolver.md | 8 +- ....chemistry.algorithms.GroundStateSolver.md | 8 +- ...ry.algorithms.MinimumEigensolverFactory.md | 6 +- ...stry.algorithms.NumPyEigensolverFactory.md | 4 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 6 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 6 +- .../0.29/qiskit.chemistry.algorithms.QEOM.md | 4 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 8 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 6 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 6 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 4 +- ...s.pes_samplers.DifferentialExtrapolator.md | 4 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 12 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 12 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 6 +- ...gorithms.pes_samplers.HarmonicPotential.md | 24 +- ....algorithms.pes_samplers.MorsePotential.md | 24 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 4 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 4 +- ...y.algorithms.pes_samplers.PotentialBase.md | 8 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 4 +- ...thms.pes_samplers.VibronicStructureBase.md | 10 +- ...orithms.pes_samplers.WindowExtrapolator.md | 4 +- ...applications.MolecularGroundStateEnergy.md | 6 +- ...y.components.bosonic_bases.BosonicBasis.md | 4 +- ....components.bosonic_bases.HarmonicBasis.md | 4 +- ...y.components.initial_states.HartreeFock.md | 4 +- ...hemistry.components.initial_states.VSCF.md | 4 +- ...mistry.components.variational_forms.CHC.md | 4 +- ...stry.components.variational_forms.UCCSD.md | 22 +- ...istry.components.variational_forms.UVCC.md | 8 +- ...qiskit.chemistry.core.ChemistryOperator.md | 6 +- .../0.29/qiskit.chemistry.core.Hamiltonian.md | 4 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 6 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 4 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 6 +- ...iskit.chemistry.drivers.FermionicDriver.md | 4 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 4 +- ....chemistry.drivers.GaussianForcesDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogResult.md | 4 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 4 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.29/qiskit.chemistry.drivers.Molecule.md | 14 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 4 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 4 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 4 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 4 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 6 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 10 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 10 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 10 +- .../0.29/qiskit.circuit.AncillaQubit.md | 2 +- .../0.29/qiskit.circuit.AncillaRegister.md | 2 +- .../0.29/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.29/qiskit.circuit.Clbit.md | 2 +- .../0.29/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.29/qiskit.circuit.Delay.md | 12 +- .../0.29/qiskit.circuit.EquivalenceLibrary.md | 12 +- docs/api/qiskit/0.29/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.29/qiskit.circuit.Instruction.md | 28 +-- .../0.29/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.29/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.29/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 30 +-- .../0.29/qiskit.circuit.ParameterVector.md | 6 +- .../0.29/qiskit.circuit.QuantumCircuit.md | 206 +++++++++--------- .../0.29/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.29/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.29/qiskit.circuit.Reset.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.AND.md | 2 +- .../0.29/qiskit.circuit.library.Barrier.md | 8 +- .../0.29/qiskit.circuit.library.C3SXGate.md | 4 +- .../0.29/qiskit.circuit.library.C3XGate.md | 6 +- .../0.29/qiskit.circuit.library.C4XGate.md | 6 +- .../0.29/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.29/qiskit.circuit.library.CHGate.md | 4 +- .../0.29/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.29/qiskit.circuit.library.CRXGate.md | 4 +- .../0.29/qiskit.circuit.library.CRYGate.md | 4 +- .../0.29/qiskit.circuit.library.CRZGate.md | 4 +- .../0.29/qiskit.circuit.library.CSXGate.md | 2 +- .../0.29/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.29/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.29/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.29/qiskit.circuit.library.CUGate.md | 4 +- .../0.29/qiskit.circuit.library.CXGate.md | 6 +- .../0.29/qiskit.circuit.library.CYGate.md | 4 +- .../0.29/qiskit.circuit.library.CZGate.md | 4 +- .../0.29/qiskit.circuit.library.DCXGate.md | 2 +- .../0.29/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.29/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.GRZ.md | 2 +- .../0.29/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.29/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.29/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.29/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.29/qiskit.circuit.library.MCMT.md | 6 +- .../0.29/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.29/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.29/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.29/qiskit.circuit.library.MSGate.md | 2 +- .../0.29/qiskit.circuit.library.Measure.md | 4 +- .../0.29/qiskit.circuit.library.NLocal.md | 12 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.29/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.29/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.29/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.29/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.29/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.29/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.29/qiskit.circuit.library.RGate.md | 4 +- .../0.29/qiskit.circuit.library.RVGate.md | 6 +- .../0.29/qiskit.circuit.library.RXGate.md | 6 +- .../0.29/qiskit.circuit.library.RXXGate.md | 4 +- .../0.29/qiskit.circuit.library.RYGate.md | 6 +- .../0.29/qiskit.circuit.library.RYYGate.md | 4 +- .../0.29/qiskit.circuit.library.RZGate.md | 6 +- .../0.29/qiskit.circuit.library.RZXGate.md | 4 +- .../0.29/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.29/qiskit.circuit.library.Reset.md | 4 +- .../0.29/qiskit.circuit.library.SGate.md | 4 +- .../0.29/qiskit.circuit.library.SXGate.md | 6 +- .../0.29/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.29/qiskit.circuit.library.SdgGate.md | 4 +- .../0.29/qiskit.circuit.library.SwapGate.md | 6 +- .../0.29/qiskit.circuit.library.TGate.md | 4 +- .../0.29/qiskit.circuit.library.TdgGate.md | 4 +- .../0.29/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.29/qiskit.circuit.library.U1Gate.md | 6 +- .../0.29/qiskit.circuit.library.U2Gate.md | 4 +- .../0.29/qiskit.circuit.library.U3Gate.md | 6 +- .../0.29/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.UniformDistribution.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.29/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.29/qiskit.circuit.library.XOR.md | 2 +- .../0.29/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.29/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.29/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.29/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.29/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.29/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.29/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.29/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.29/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.qpy_serialization.dump.md | 2 +- .../qiskit.circuit.qpy_serialization.load.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.29/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.29/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.29/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.29/qiskit.compiler.transpile.md | 2 +- .../0.29/qiskit.converters.ast_to_dag.md | 2 +- .../0.29/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.29/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.29/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.29/qiskit.dagcircuit.DAGCircuit.md | 126 +++++------ .../0.29/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.29/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.29/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../qiskit/0.29/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.29/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.29/qiskit.extensions.Initialize.md | 8 +- .../qiskit/0.29/qiskit.extensions.Snapshot.md | 8 +- .../0.29/qiskit.extensions.UnitaryGate.md | 16 +- .../0.29/qiskit.finance.QiskitFinanceError.md | 2 +- ....uncertainty_problems.EuropeanCallDelta.md | 8 +- ...inty_problems.EuropeanCallExpectedValue.md | 8 +- ...ainty_problems.FixedIncomeExpectedValue.md | 10 +- ...finance.data_providers.BaseDataProvider.md | 16 +- ...nce.data_providers.DataOnDemandProvider.md | 4 +- ...nce.data_providers.ExchangeDataProvider.md | 4 +- ...nance.data_providers.RandomDataProvider.md | 4 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 4 +- ...inance.data_providers.YahooDataProvider.md | 4 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.29/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.29/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 6 +- .../0.29/qiskit.ignis.verification.BConfig.md | 18 +- .../qiskit.ignis.verification.CNOTDihedral.md | 34 +-- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.29/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.29/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 6 +- .../0.29/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.29/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.29/qiskit.ml.datasets.digits.md | 2 +- .../0.29/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.29/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.29/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.29/qiskit.opflow.OperatorBase.md | 40 ++-- .../qiskit/0.29/qiskit.opflow.OpflowError.md | 2 +- .../0.29/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.29/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.29/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.29/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.29/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.29/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.29/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.29/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 4 +- .../0.29/qiskit.opflow.gradients.QFI.md | 4 +- .../0.29/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.29/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.29/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.29/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.29/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +-- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 38 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +-- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.29/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +-- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 76 +++---- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 6 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 6 +- ....optimization.algorithms.CplexOptimizer.md | 8 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 6 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 4 +- ...zation.algorithms.MinimumEigenOptimizer.md | 6 +- ...mization.algorithms.MultiStartOptimizer.md | 4 +- ...zation.algorithms.OptimizationAlgorithm.md | 8 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 6 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 6 +- ....optimization.algorithms.SolutionSample.md | 2 +- ...ization.converters.InequalityToEquality.md | 6 +- ...optimization.converters.IntegerToBinary.md | 6 +- ...tion.converters.LinearEqualityToPenalty.md | 6 +- ...on.converters.QuadraticProgramConverter.md | 6 +- ...ation.converters.QuadraticProgramToQubo.md | 10 +- ...qiskit.optimization.problems.Constraint.md | 4 +- ....optimization.problems.LinearConstraint.md | 4 +- ....optimization.problems.LinearExpression.md | 10 +- ...timization.problems.QuadraticConstraint.md | 4 +- ...timization.problems.QuadraticExpression.md | 10 +- ...ptimization.problems.QuadraticObjective.md | 6 +- ....optimization.problems.QuadraticProgram.md | 76 +++---- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 4 +- .../qiskit/0.29/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.29/qiskit.providers.BackendV1.md | 16 +- .../0.29/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.29/qiskit.providers.BaseJob.md | 24 +- .../0.29/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.29/qiskit.providers.Job.md | 2 +- .../qiskit/0.29/qiskit.providers.JobError.md | 2 +- .../qiskit/0.29/qiskit.providers.JobStatus.md | 2 +- .../0.29/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.29/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.29/qiskit.providers.Options.md | 6 +- .../qiskit/0.29/qiskit.providers.Provider.md | 2 +- .../0.29/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.29/qiskit.providers.aer.AerError.md | 2 +- .../0.29/qiskit.providers.aer.AerJob.md | 14 +- .../0.29/qiskit.providers.aer.AerProvider.md | 6 +- .../0.29/qiskit.providers.aer.AerSimulator.md | 12 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 8 +- ...skit.providers.aer.StatevectorSimulator.md | 2 +- .../qiskit.providers.aer.UnitarySimulator.md | 2 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 28 +-- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.29/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 10 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.29/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.29/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.29/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.29/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...skit.providers.ibmq.random.CQCExtractor.md | 10 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 6 +- ...providers.ibmq.random.IBMQRandomService.md | 6 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 24 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.29/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.29/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- docs/api/qiskit/0.29/qiskit.pulse.Acquire.md | 4 +- .../0.29/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.29/qiskit.pulse.Call.md | 8 +- docs/api/qiskit/0.29/qiskit.pulse.Constant.md | 6 +- .../0.29/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.29/qiskit.pulse.Delay.md | 4 +- docs/api/qiskit/0.29/qiskit.pulse.Drag.md | 6 +- .../qiskit/0.29/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.29/qiskit.pulse.Gaussian.md | 6 +- .../0.29/qiskit.pulse.GaussianSquare.md | 6 +- .../qiskit/0.29/qiskit.pulse.Instruction.md | 22 +- .../qiskit.pulse.InstructionScheduleMap.md | 20 +- .../0.29/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.29/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.29/qiskit.pulse.Play.md | 6 +- .../qiskit/0.29/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.29/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.29/qiskit.pulse.Schedule.md | 30 +-- .../qiskit/0.29/qiskit.pulse.ScheduleBlock.md | 30 +-- .../qiskit/0.29/qiskit.pulse.SetFrequency.md | 4 +- docs/api/qiskit/0.29/qiskit.pulse.SetPhase.md | 4 +- .../0.29/qiskit.pulse.ShiftFrequency.md | 4 +- .../qiskit/0.29/qiskit.pulse.ShiftPhase.md | 4 +- docs/api/qiskit/0.29/qiskit.pulse.Snapshot.md | 4 +- docs/api/qiskit/0.29/qiskit.pulse.Waveform.md | 6 +- .../0.29/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.29/qiskit.pulse.builder.align_func.md | 2 +- .../0.29/qiskit.pulse.builder.align_left.md | 2 +- .../0.29/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.29/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.delay.md | 2 +- .../0.29/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.29/qiskit.pulse.builder.inline.md | 2 +- .../0.29/qiskit.pulse.builder.measure.md | 2 +- .../0.29/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.29/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.pad.md | 2 +- .../0.29/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.29/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.29/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.29/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.29/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.29/qiskit.pulse.builder.x.md | 2 +- .../0.29/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.29/qiskit.pulse.instructions.Call.md | 8 +- .../0.29/qiskit.pulse.instructions.Delay.md | 4 +- .../qiskit.pulse.instructions.Instruction.md | 22 +- .../0.29/qiskit.pulse.instructions.Play.md | 6 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.29/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.29/qiskit.pulse.library.Drag.md | 6 +- .../0.29/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.29/qiskit.pulse.library.Waveform.md | 6 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.29/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.29/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.29/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.29/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.29/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.29/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.29/qiskit.qobj.GateCalibration.md | 6 +- .../0.29/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.md | 6 +- .../0.29/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.29/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.29/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.29/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.29/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.29/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.29/qiskit.qobj.Qobj.md | 2 +- .../0.29/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.29/qiskit.qobj.QobjHeader.md | 2 +- .../0.29/qiskit.qobj.QobjMeasurementOption.md | 6 +- .../0.29/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.29/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.29/qiskit.quantum_info.Choi.md | 12 +- .../0.29/qiskit.quantum_info.Clifford.md | 32 +-- .../0.29/qiskit.quantum_info.DensityMatrix.md | 38 ++-- .../qiskit/0.29/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.29/qiskit.quantum_info.Operator.md | 26 +-- .../qiskit/0.29/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.29/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.29/qiskit.quantum_info.PauliList.md | 50 ++--- .../0.29/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.29/qiskit.quantum_info.Quaternion.md | 14 +- .../0.29/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.29/qiskit.quantum_info.SparsePauliOp.md | 32 +-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.29/qiskit.quantum_info.Statevector.md | 38 ++-- .../0.29/qiskit.quantum_info.Stinespring.md | 14 +- .../0.29/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.29/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.29/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.29/qiskit.quantum_info.entropy.md | 2 +- .../0.29/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.29/qiskit.quantum_info.partial_trace.md | 2 +- .../0.29/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.29/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.29/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.29/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.29/qiskit.result.Counts.md | 8 +- .../0.29/qiskit.result.ProbDistribution.md | 6 +- .../0.29/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.29/qiskit.result.Result.md | 16 +- .../qiskit/0.29/qiskit.result.ResultError.md | 2 +- .../0.29/qiskit.result.marginal_counts.md | 2 +- .../0.29/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.29/qiskit.tools.backend_monitor.md | 2 +- .../0.29/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.29/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.29/qiskit.tools.parallel_map.md | 2 +- .../0.29/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.29/qiskit.transpiler.CouplingMap.md | 36 +-- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.29/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- .../qiskit/0.29/qiskit.transpiler.Layout.md | 30 +-- .../0.29/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.29/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.29/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.29/qiskit.transpiler.passes.CheckMap.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- .../0.29/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.29/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.29/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.29/qiskit.transpiler.passes.Unroller.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.29/qiskit.transpiler.passes.Width.md | 4 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.29/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.29/qiskit.utils.apply_prefix.md | 2 +- .../0.29/qiskit.utils.deprecate_arguments.md | 2 +- .../0.29/qiskit.utils.deprecate_function.md | 2 +- .../0.29/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.29/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.29/qiskit.utils.has_ibmq.md | 2 +- .../0.29/qiskit.utils.is_main_process.md | 2 +- .../0.29/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.29/qiskit.utils.name_args.md | 2 +- .../0.29/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.29/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1217 files changed, 3870 insertions(+), 3870 deletions(-) diff --git a/docs/api/qiskit/0.29/execute.md b/docs/api/qiskit/0.29/execute.md index 8755b9240c2..3b45799405a 100644 --- a/docs/api/qiskit/0.29/execute.md +++ b/docs/api/qiskit/0.29/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.29/logging.md b/docs/api/qiskit/0.29/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.29/logging.md +++ b/docs/api/qiskit/0.29/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.md index 8ca3e9ac38e..70247e04092 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.md index eda68be3b99..05f5a8abf08 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.md index 8b58f5f16f7..a35b05d675b 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.md index 0ea6cb88896..6a34c5b5e0d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.md index bd82b5983d1..c3d0fd6bca9 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.md index d9fbb41272f..850ab74790c 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.md index a7d3692f34c..d543bb3f8af 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.md index 9e8af705568..54f056bb323 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.md index 0fa85780d22..e4c1693fee6 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.md index 64a52fe413b..b43b87c52ae 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7e80483cdc3..13261c39680 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.29/qiskit.algorithms.Grover.md index 09619cab3ad..66afc42fcbf 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -109,7 +109,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -135,7 +135,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.md index 0d3262e9fe5..546a9de563a 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.29/qiskit.algorithms.HHL.md index 7b070d712b6..a58db83d55d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -88,7 +88,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4d3d66e1511..ff05137ad29 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index ffd8680ce2a..dac975d8447 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.md index 4e0525435b7..c1a5caaf0a8 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 786a28ca73f..cc26a05cb50 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.md index 734f5435191..9a5338b4e40 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.md index b467025bb12..95cc165d6df 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.md index e94e8c97d93..6bdc92cbd2d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 672d1632cf8..9b52579c968 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index a4549d470bf..07d3d3a29bb 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.md index 1fa59d6cbab..6efe690ec1c 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.md index 434d8f1b250..f461d953178 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.md index 9bbfcc4d1e1..53d3a4858fc 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.md index 40aedeb0213..94ac1589c69 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.md index a468cd4132d..6ac7e2745a0 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.md index 5646cc39b02..828dc7a48c8 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.md index 9b7c64c8742..8264f0cdd4d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.md index 6b02367ef38..0607e4db3f0 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.md index 3b6a7acc155..d4d3337a5a8 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.29/qiskit.algorithms.Shor.md index 943abc13d66..d02bc90d794 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.md index 301ee26f92b..aadac8890b7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.29/qiskit.algorithms.VQE.md index 85c5f13cd0b..ae0803868a7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -51,7 +51,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -93,7 +93,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -148,7 +148,7 @@ dict -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -175,7 +175,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -187,7 +187,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -199,7 +199,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -227,7 +227,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -243,7 +243,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.md index 91320d37127..67bde1016da 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -121,7 +121,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -159,7 +159,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.md index 9eb6256f9ba..72f65b1b1c7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.md index 6db1b85881e..36824db4a70 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.md index e4899ab96e1..fd95ce853d8 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.md index 85f09e4e59c..55db3a940b3 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.md index f52e1dd72f6..7fee2cbbfb1 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.md index dccc95dd453..8f7466e1deb 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5a424cb5965..5ef96d11579 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.md index d6e70b8e91a..e3a883d3222 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.md index 8f47f9e5d2c..f1bae1797c3 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -172,7 +172,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -196,7 +196,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.md index 3932cff062c..a6b80c6390f 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.md index 499edc4598c..0b65a1220ed 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.md index c3a40820c6b..d9140d08e01 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.md index 7da978ade93..3a2c93d82f2 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.md index f24e582865f..89b376cb8a7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.md index cce399c08cb..8613db5a039 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.md index f3e2efd0371..8aa53bca58d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 948f5158c5f..980594e2fe5 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.md index 2e38bcf0b6a..2107f37d0c3 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.md index 98dd1037f06..4837f9b9422 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.md index 826b2d5dd6c..72ccf9f6e8d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -119,7 +119,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.md index a630c804619..30a2c283d1d 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.md index 3f7ed381506..86c66895db7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.md index a5555c44b15..30993b5e0fa 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -101,7 +101,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -136,7 +136,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -148,7 +148,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -179,7 +179,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.md index 72a75110049..6de668be969 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.md index 1f76b2e70b7..559898217d7 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.29/qiskit.aqua.AquaError.md index c2c87a14da5..b4579f16ed6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.md index a6654a15886..ae091b23fe5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.md index 4b2f505ac55..604dfb78a3a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") assemble circuits @@ -64,7 +64,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -84,7 +84,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -109,7 +109,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -129,7 +129,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Reset execution results @@ -141,7 +141,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -149,7 +149,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :type circuits: `Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]] :param circuits: circuits to transpile diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.md index b10e0ebc8ca..ccb94b46591 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -56,7 +56,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -82,7 +82,7 @@ The (1 - alpha) confidence interval of the specified kind. -`AmplitudeEstimation.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 2a74e74f268..0111c5beb77 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 214b669ba8c..9c38c01fbd8 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.md index bdf6a6a2030..1f8bd38fd94 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -29,7 +29,7 @@ The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jo -`BernsteinVazirani.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 3a85fe02cfa..d471a48f4d1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for Classical Algorithms. -`ClassicalAlgorithm.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Execute the classical algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.md index f5ad0c57f4e..b2d1ddbef94 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.md index 40b26aa0800..8a4fe2dbd30 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`DeutschJozsa.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.md index 6005a5c125b..ac96edbb4e6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -35,7 +35,7 @@ EOH provides the lower-level building blocks for simulating universal quantum sy -`EOH.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.md index 36a981429d0..c135dc4ece6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.md index 03e2bee0c4e..5fd16785333 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static EigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`static EigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.md index 05f0ff863d5..206dce3fd08 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -100,7 +100,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.construct_circuit(power=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(power=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -121,7 +121,7 @@ the QuantumCircuit object for the constructed circuit -`Grover.is_good_state(bitstr)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.is_good_state(bitstr)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Check whether a provided bitstring is a good state or not. @@ -141,7 +141,7 @@ True if the measurement is a good state, False otherwise. -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. @@ -162,7 +162,7 @@ The optimal number of iterations for Grover’s algorithm to succeed. -`Grover.post_processing(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.post_processing(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Do the post-processing to the measurement result diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.md index 27e2ed48c8b..0621bf4ee5e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static GroverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static GroverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.md index 104509eb4dc..3d4e71cd17c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -61,7 +61,7 @@ See also [https://arxiv.org/abs/0811.3171](https://arxiv.org/abs/0811.3171) -`HHL.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -81,7 +81,7 @@ the QuantumCircuit object for the constructed circuit -`static HHL.expand_to_hermitian(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_hermitian(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. @@ -102,7 +102,7 @@ the expanded matrix, the expanded vector -`static HHL.expand_to_powerdim(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_powerdim(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. @@ -123,7 +123,7 @@ the expanded matrix, the expanded vector -`static HHL.matrix_resize(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.matrix_resize(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Resizes matrix if necessary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.md index bacb695ea73..14d8c1fa1a3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static HHLResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHLResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.md index 2acf9246296..3ec9bf228b6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -41,7 +41,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -62,7 +62,7 @@ MinimumEigensolverResult -`IQPE.construct_circuit(k=None, omega=0, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.construct_circuit(k=None, omega=0, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index f55ec87a6b6..b41888a8ef7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -58,7 +58,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Construct the circuit Q^k A |0>. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index 46017326c36..ece986b79ca 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static IterativeAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`static IterativeAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.md index f9932eafc75..579de6c101c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static LinearsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`static LinearsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index d2fa6b6ec8f..bfe70b347c7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -47,7 +47,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -75,7 +75,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 834bf66fa9f..98c4ae01b1b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.md index 113932d3d9f..0e6660fc029 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.md index e69567d581a..a0a2e3e8146 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MinimumEigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`static MinimumEigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.md index abaf7014801..14fb63b3ae9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ dict -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.md index 869a22babd1..e82deb99e27 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 48320e33e2d..325dc0c2e7b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static NumPyLSsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`static NumPyLSsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index 7e31abd12a8..e9e0330c118 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -28,7 +28,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -65,7 +65,7 @@ dict -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.md index c76832ae833..567c8be2c20 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.md index cba3dfb07e5..9cdb44a756c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -52,7 +52,7 @@ These networks are trained in alternating optimization steps, where the discrimi -`QGAN.get_rel_entr()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.get_rel_entr()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Get relative entropy between target and trained distribution @@ -101,7 +101,7 @@ Sets backend with configuration. -`QGAN.set_discriminator(discriminator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_discriminator(discriminator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize discriminator. @@ -113,7 +113,7 @@ Initialize discriminator. -`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize generator. @@ -132,7 +132,7 @@ Initialize generator. -`QGAN.train()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.train()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Train the qGAN diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.md index 7cd80d2324f..b59e0f51ace 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -36,7 +36,7 @@ QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two -`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -57,7 +57,7 @@ MinimumEigensolverResult -`QPE.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.md index ecf1e8d533a..3dd3054fa81 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/1804.11326](https://arxiv.org/abs/1804.11326) -`QSVM.construct_circuit(x1, x2, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_circuit(x1, x2, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Generate inner product of x1 and x2 with the given feature map. @@ -68,7 +68,7 @@ constructed circuit -`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -98,7 +98,7 @@ numpy.ndarray -`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -126,7 +126,7 @@ numpy.ndarray -`QSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Load a model from a file path. @@ -138,7 +138,7 @@ Load a model from a file path. -`QSVM.predict(data, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.predict(data, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Predict using the svm. @@ -188,7 +188,7 @@ dict -`QSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Save the model to a file path. @@ -212,7 +212,7 @@ Sets backend with configuration. -`QSVM.setup_datapoint(datapoints)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_datapoint(datapoints)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup data points, if the data were there, they would be overwritten. @@ -224,7 +224,7 @@ Setup data points, if the data were there, they would be overwritten. -`QSVM.setup_test_data(test_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_test_data(test_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup test data, if the data were there, they would be overwritten. @@ -236,7 +236,7 @@ Setup test data, if the data were there, they would be overwritten. -`QSVM.setup_training_data(training_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_training_data(training_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup training data, if the data were there, they would be overwritten. @@ -248,7 +248,7 @@ Setup training data, if the data were there, they would be overwritten. -`QSVM.test(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.test(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Test the svm. @@ -274,7 +274,7 @@ float -`QSVM.train(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.train(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Train the svm. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.md index 6469b629d9f..1b4df2b01a5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`QuantumAlgorithm.run(quantum_instance=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.run(quantum_instance=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Execute the algorithm with selected backend. @@ -49,7 +49,7 @@ dict -`QuantumAlgorithm.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.md index 906bf8324e1..c70d9dd55e0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Construct circuit. @@ -64,7 +64,7 @@ Quantum circuit. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.md index 468f6eedbaf..a664949467d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`Simon.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.md index 114b49cd1b4..ea286eea4e7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` @@ -38,7 +38,7 @@ Internally, this algorithm will run the binary classification or multiclass clas -`SklearnSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Load a model from a file path. @@ -50,7 +50,7 @@ Load a model from a file path. -`SklearnSVM.predict(data)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.predict(data)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Predict using the SVM @@ -86,7 +86,7 @@ dict -`SklearnSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Save the model to a file path. @@ -98,7 +98,7 @@ Save the model to a file path. -`SklearnSVM.test(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.test(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Test the SVM @@ -119,7 +119,7 @@ float -`SklearnSVM.train(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.train(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Train the SVM diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.md index 17badab47c3..5b669ef12f5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -50,7 +50,7 @@ Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), -`VQC.batch_data(data, labels=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.batch_data(data, labels=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") batch data @@ -66,7 +66,7 @@ set parameterized circuits to None -`VQC.construct_circuit(x, theta, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.construct_circuit(x, theta, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Construct circuit based on data and parameters in variational form. @@ -120,7 +120,7 @@ dict -`VQC.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal circuit @@ -128,7 +128,7 @@ get optimal circuit -`VQC.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal cost @@ -136,7 +136,7 @@ get optimal cost -`VQC.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal vector @@ -160,7 +160,7 @@ get probabilities for counts -`VQC.is_gradient_really_supported()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.is_gradient_really_supported()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") returns is gradient really supported @@ -168,7 +168,7 @@ returns is gradient really supported -`VQC.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") load model @@ -176,7 +176,7 @@ load model -`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data. @@ -224,7 +224,7 @@ dict -`VQC.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") save model @@ -244,7 +244,7 @@ Sets backend with configuration. -`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data, and test against with ground truth labels. @@ -268,7 +268,7 @@ float -`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Train the models, and save results. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.md index 177f46fdf74..ec982849070 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -56,7 +56,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -77,7 +77,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -97,7 +97,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -149,7 +149,7 @@ dict -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -161,7 +161,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -173,7 +173,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -201,7 +201,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -254,7 +254,7 @@ Sets backend with configuration. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.md index 48fc6aa2731..f96e6e94ef1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.md index f45e1493fbd..55ada47cc05 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.md index cf2e01fee26..10d86130fc8 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 9b19c13d7f0..988178c03dc 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Quantum Phase Estimation Circuit. -`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Construct the Phase Estimation circuit diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.md index b93db01a246..51752d3e454 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Constructor. -`StateVectorCircuit.construct_circuit(circuit=None, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit.construct_circuit(circuit=None, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Construct the circuit representing the desired state vector. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.md index f03b31602d8..53f485efc6f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -35,7 +35,7 @@ Computes the weighted sum controlled by state qubits -`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`static WeightedSumOperator.get_required_sum_qubits(weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`static WeightedSumOperator.get_required_sum_qubits(weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") get required sum qubits @@ -152,7 +152,7 @@ get required sum qubits -`WeightedSumOperator.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") required ancillas @@ -160,7 +160,7 @@ required ancillas -`WeightedSumOperator.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.md index a33e8c8187a..e0c4d55bcfe 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Eigenvalues.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the eigenvalue estimation quantum circuit. @@ -49,7 +49,7 @@ object for the eigenvalue estimation circuit. -`Eigenvalues.construct_inverse(mode, circuit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues.construct_inverse(mode, circuit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the inverse eigenvalue estimation quantum circuit. @@ -77,7 +77,7 @@ circuit. -`abstract Eigenvalues.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get register sizes @@ -85,7 +85,7 @@ get register sizes -`abstract Eigenvalues.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get scaling diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.md index 2e3a140aed7..c5b9e1d0c41 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` @@ -36,7 +36,7 @@ Specifically, this class is based on PhaseEstimationCircuit with no measurements -`EigsQPE.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Construct the eigenvalues estimation using the PhaseEstimationCircuit @@ -89,7 +89,7 @@ circuit. -`EigsQPE.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get register sizes @@ -97,7 +97,7 @@ get register sizes -`EigsQPE.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get scaling diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.md index 0cbf5d6c13b..9319bd9c2eb 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Construct the variational form, given its parameters. @@ -46,7 +46,7 @@ a quantum circuit. -`static FeatureMap.get_entangler_map(map_type, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.get_entangler_map(map_type, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") get entangle map @@ -54,7 +54,7 @@ get entangle map -`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 409c3da2478..bb3b603b8a6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` @@ -28,7 +28,7 @@ The Raw Feature Vector can be directly used as a feature map, where the raw feat -`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Construct the second order expansion based on given data. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.md index 4517c472243..57ae062836a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -43,7 +43,7 @@ The custom initial state will be set from the *circuit*, the *state\_vector*, or -`Custom.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.md index c73507555a2..8cd086c95d1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract InitialState.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`abstract InitialState.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.md index e35c15f2541..04386860f9f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutoria -`VarFormBased.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.md index 2e66ab01606..b37e7959a31 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ This is suitable for those situations in which the all-zeros state is the desire -`Zero.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.md index 4e56d2102d5..9cbddbab79c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a -`AllPairs.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`AllPairs.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`AllPairs.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 603a21c221f..92f4f3b54bb 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -38,7 +38,7 @@ The table above shows a 6-bit ECC for a 3-class problem. Each class is assigned -`ErrorCorrectingCode.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Applying multiple estimators for prediction. @@ -70,7 +70,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`ErrorCorrectingCode.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -91,7 +91,7 @@ float -`ErrorCorrectingCode.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 4e5bfee3b20..c58a47d8259 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract MulticlassExtension.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Applying multiple estimators for prediction. @@ -36,7 +36,7 @@ Applying multiple estimators for prediction. -`MulticlassExtension.set_estimator(estimator_cls, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension.set_estimator(estimator_cls, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Called internally to set `Estimator` and parameters :type estimator\_cls: `Callable`\[\[`List`], `Estimator`] :param estimator\_cls: An `Estimator` class :type params: `Optional`\[`List`] :param params: Parameters for the estimator @@ -48,7 +48,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`abstract MulticlassExtension.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -61,7 +61,7 @@ Testing multiple estimators each for distinguishing a pair of classes. -`abstract MulticlassExtension.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99912cbdeaa..5746e6c21ed 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM cla -`OneAgainstRest.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`OneAgainstRest.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`OneAgainstRest.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index 8598a8a962c..27dff35e801 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module but raise an exception if a required co -`abstract DiscriminativeNetwork.get_label(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.get_label(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Apply quantum/classical neural network to the given input sample and compute the respective data label @@ -40,7 +40,7 @@ Apply quantum/classical neural network to the given input sample and compute the -`abstract DiscriminativeNetwork.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Loss function used for optimization @@ -62,7 +62,7 @@ Loss w\.r.t to the generated data points. -`abstract DiscriminativeNetwork.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Save discriminator model @@ -78,7 +78,7 @@ Save discriminator model -`abstract DiscriminativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Set seed. @@ -94,7 +94,7 @@ Set seed. -`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 87525ae962a..5cafb9ee98b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module, but raise an exception if a required c -`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Apply quantum/classical neural network to given input and get the respective output @@ -46,7 +46,7 @@ Neural network output -`abstract GenerativeNetwork.loss()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.loss()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Loss function used for optimization @@ -54,7 +54,7 @@ Loss function used for optimization -`abstract GenerativeNetwork.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set discriminator network. @@ -70,7 +70,7 @@ Set discriminator network. -`abstract GenerativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set seed. @@ -86,7 +86,7 @@ Set seed. -`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 508e3037633..51189161446 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -27,7 +27,7 @@ Discriminator based on NumPy -`NumPyDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -48,7 +48,7 @@ numpy.ndarray -`NumPyDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Load discriminator model @@ -60,7 +60,7 @@ Load discriminator model -`NumPyDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Loss function :param x: sample label (equivalent to discriminator output) :type x: numpy.ndarray :param y: target label :type y: numpy.ndarray :param weights: customized scaling for each sample (optional) :type weights: numpy.ndarray @@ -76,7 +76,7 @@ float -`NumPyDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Save discriminator model @@ -88,7 +88,7 @@ Save discriminator model -`NumPyDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Set seed. :param seed: seed :type seed: int @@ -96,7 +96,7 @@ Set seed. :param seed: seed :type seed: int -`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index 914d5fad9e0..09ec0d6fa91 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -31,7 +31,7 @@ Discriminator based on PyTorch -`PyTorchDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -52,7 +52,7 @@ torch.Tensor -`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Compute gradient penalty for discriminator optimization @@ -75,7 +75,7 @@ torch.Tensor -`PyTorchDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Load discriminator model @@ -87,7 +87,7 @@ Load discriminator model -`PyTorchDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Loss function @@ -109,7 +109,7 @@ torch.Tensor -`PyTorchDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Save discriminator model @@ -121,7 +121,7 @@ Save discriminator model -`PyTorchDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 11da90e6808..5b063c0b256 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` @@ -38,7 +38,7 @@ The quantum generator is a parametrized quantum circuit which can be trained wit -`QuantumGenerator.construct_circuit(params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.construct_circuit(params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Construct generator circuit. @@ -58,7 +58,7 @@ construct the quantum circuit and return as gate -`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Get classical data samples from the generator. Running the quantum generator circuit results in a quantum state. To train this generator with a classical discriminator, we need to sample classical outputs by measuring the quantum state and mapping them to feature space defined by the training data. @@ -80,7 +80,7 @@ list -`QuantumGenerator.loss(x, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.loss(x, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Loss function for training the generator’s parameters. @@ -101,7 +101,7 @@ float -`QuantumGenerator.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set discriminator network. @@ -117,7 +117,7 @@ Set discriminator network. -`QuantumGenerator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`QuantumGenerator.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.md index 1642282382a..c1aa6dbfde6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -48,7 +48,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -79,7 +79,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -95,7 +95,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -117,7 +117,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -155,7 +155,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.md index 82687ee457d..cb07e980296 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -45,7 +45,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Support level dictionary @@ -86,7 +86,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.md index 8a986e3c761..17ffb681269 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.md index 588d71e1e95..8389e09586c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize CG. For further detail, please refer to [https://do -`CG.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.md index 16da45b4d73..a0337c770a4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.minimize COBYLA. For further detail, please refer to [https: -`COBYLA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Return support level dictionary @@ -64,7 +64,7 @@ grad -`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.md index 771ae3eec74..c18de079b05 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.md index 3e2c4524bea..8128d75bb13 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index ae5dfe2e7b4..9cf5fd1788b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.md index f72728b4531..e18b87cecd3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.md index 40b08824745..e45cf06aa95 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -39,7 +39,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Return support level dictionary. @@ -55,7 +55,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -103,7 +103,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Run the line search optimization. @@ -131,7 +131,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Perform optimization. @@ -169,7 +169,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -193,7 +193,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.md index 503b45666d6..f96aa6e9508 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.md index 2307be651a4..dd96bbeb6a3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.md index 47d39c3177a..225aa2a83a7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -38,7 +38,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`L_BFGS_B.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Return support level dictionary @@ -69,7 +69,7 @@ grad -`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.md index b0a6d556988..951d36f56bd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize Nelder-Mead. For further detail, please refer to Se -`NELDER_MEAD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Return support level dictionary @@ -68,7 +68,7 @@ grad -`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.md index 8d818bbdf2f..e541f8173b4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -43,7 +43,7 @@ K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization fo -`NFT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") return support level dictionary @@ -74,7 +74,7 @@ grad -`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.md index 80e98a1d35c..c6705741607 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index 63d60f8c139..8c787fe12f7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.md index 74d8f777c17..bc33b3646a3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize Powell. For further detail, please refer to See [ht -`POWELL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.md index 9f7e665caea..fa6cfb71f22 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`P_BFGS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") return support level dictionary @@ -64,7 +64,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.md index d4cf3418d3a..271594803ec 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -36,7 +36,7 @@ Uses scipy.optimize.minimize SLSQP. For further detail, please refer to See [htt -`SLSQP.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Return support level dictionary @@ -67,7 +67,7 @@ grad -`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.md index c12fdcc6f6e..ba81d9e236b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.md index 9ea7dcf9cbe..57b9cda4881 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -51,7 +51,7 @@ For further details, please refer to [https://arxiv.org/pdf/1704.05018v2.pdf#sec -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") return support level dictionary @@ -82,7 +82,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.md index 86a951cf3ff..5ce0ad96d08 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize TNC For further detail, please refer to See [https: -`TNC.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") return support level dictionary @@ -68,7 +68,7 @@ grad -`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 95a27575e64..71443988da0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ This class is provided for easy creation of oracles using custom circuits. It is -`CustomCircuitOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index af31497f164..a17dc76baa0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -58,7 +58,7 @@ By default, the Logical Expression oracle will not try to apply any optimization -`LogicalExpressionOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") construct circuit @@ -66,7 +66,7 @@ construct circuit -`LogicalExpressionOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") evaluate classically diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.md index bc8909a4dd2..6f3f2f313a4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ This method should initialize the module and use an exception if a component of -`abstract Oracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`abstract Oracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.md index 83f64fb7476..d75f233bad4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ Regarding circuit optimization and mct usages, the truth table oracle is similar -`TruthTableOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") construct circuit @@ -54,7 +54,7 @@ construct circuit -`TruthTableOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") evaluate classical diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.md index ba457478c4f..5a4caa52a33 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -36,7 +36,7 @@ It finds the reciprocal with long division method and rotates the ancillary qubi -`LongDivision.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Construct the Long Division Rotation circuit. @@ -62,7 +62,7 @@ containing the Long Division Rotation circuit. -`LongDivision.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.md index d8db023f7f4..21c0acbde68 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -35,7 +35,7 @@ A calculation of reciprocals of eigenvalues is performed and controlled rotation -`LookupRotation.construct_circuit(mode, inreg)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.construct_circuit(mode, inreg)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Construct the Lookup Rotation circuit. @@ -60,7 +60,7 @@ NotImplementedError: mode not supported -`LookupRotation.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.md index fe08d1e0579..8c0ba818e7d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Construct the initial state circuit. @@ -42,7 +42,7 @@ The reciprocal circuit. -`abstract Reciprocal.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 545dc579533..a761e167b55 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 91cc535509c..748f3c73eab 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -35,7 +35,7 @@ Dependency between individual risk variables and latent variable is approximated -`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index c8f212d4df1..4355ff2fc65 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 6b9bc9c32d7..dda3b6f9e05 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -29,7 +29,7 @@ This module contains the definition of a base class for multivariate distributio -`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") ### build\_controlled @@ -129,7 +129,7 @@ returns number of qubits controlled -`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") pdf to probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index b0da929a0d1..0c92d70e77c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 56b5c191c73..9b1ad691dd2 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index e9517faa06b..0c07823fa19 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ Although this just results in a Hadamard gate on all involved qubits, the lower -`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index 82225843582..8b611c1f0c4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ The Multivariate Variational Distribution. -`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") ### build\_controlled @@ -154,7 +154,7 @@ returns required ancillas controlled -`MultivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index 574d76b9062..816a8c3ebc0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 3d78ef0f430..0efcb0c9223 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -22,7 +22,7 @@ The abstract Uncertainty Model -`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Adds corresponding sub-circuit to given circuit diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 7cca0f927c4..db8ec72852d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ Uniform distribution is defined by the number of qubits that should be used to r -`UniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") ### build\_controlled @@ -153,7 +153,7 @@ list -`UniformDistribution.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas @@ -161,7 +161,7 @@ returns required ancillas -`UniformDistribution.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index a7f59c743ae..098a1402e22 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -33,7 +33,7 @@ This module contains the definition of a base class for univariate distributions -`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") ### build\_controlled @@ -133,7 +133,7 @@ returns number of qubits controlled -`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 040089b5059..c5acc1805cb 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ The Univariate Variational Distribution. -`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") ### build\_controlled @@ -169,7 +169,7 @@ returns required ancillas controlled -`UnivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 7601ab629f2..d7d33f0762c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`MultivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`MultivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 250bbe128ad..88b518dfb92 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -147,7 +147,7 @@ returns required ancillas controlled -`UncertaintyProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 63199cf7444..0252c577e63 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -42,7 +42,7 @@ $$ -`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") ### build\_controlled @@ -142,7 +142,7 @@ returns number of qubits controlled -`UnivariatePiecewiseLinearObjective.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") requires ancillas @@ -158,7 +158,7 @@ returns required ancillas controlled -`UnivariatePiecewiseLinearObjective.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") value to estimation diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index 795745b2220..2cee7d25a27 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`UnivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`UnivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.md index 56c44d14c26..a6f628f93f6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract VariationalForm.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`abstract VariationalForm.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Construct the variational form, given its parameters. @@ -45,7 +45,7 @@ A quantum circuit. -`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") returns entangler map @@ -53,7 +53,7 @@ returns entangler map -`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.md index 78d926e0bb7..52f300b1ca7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -140,7 +140,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -162,7 +162,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -182,7 +182,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -198,7 +198,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Permutes the qubits of the operator. @@ -222,7 +222,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -242,7 +242,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -258,7 +258,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -270,7 +270,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -294,7 +294,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -314,7 +314,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -336,7 +336,7 @@ The `LegacyBaseOperator` representing this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.md index b6368fa370e..08c02698d7b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.md index e9783f821f1..1d28761a3f7 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -35,7 +35,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -60,7 +60,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. @@ -85,7 +85,7 @@ The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. -`CircuitSampler.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.md index 2107b6a1d2d..804264fbf74 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.md index 87540049609..dce2cbcb935 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.md index fbc3778b8d2..be149136d09 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TBP stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.md index 217601fddc1..f4b3fe51472 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.md index 54f196a9083..efede772208 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.md index 9fb3de17e9c..1cffa046041 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -95,7 +95,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -123,7 +123,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -143,7 +143,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -177,7 +177,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to the negation of self. -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -269,7 +269,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -285,7 +285,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -301,7 +301,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -403,7 +403,7 @@ The `LegacyBaseOperator` representing this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -419,7 +419,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.md index 67bc05bd33f..3304c4c1bb2 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index 8e276a706ab..f176beedf72 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.md index a3c8f15543f..5ad24fd7bff 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.md index 2b2083745e9..1235021c257 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.md index 6ac9cd1ce64..3fb5b235bb3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.md index aca978cce4a..1357669efc6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index a211e007991..e557805d407 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.md index 4a47649405a..88d453f3f7d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.md index eb85fc18bfa..67f3bef26cd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.md index d4ebaffdd5d..ca8eaabee5c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.md index 899b706f36e..f145817d2da 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.md index 1ed2fe426da..6b0d349e38b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.md index 115a7fef8a6..baa3f571a7c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.md index a902b5ae962..3665bc06a86 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.md index 2c755ac3ec0..5409b312c4f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.md index b8978323d97..9a156503c79 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -74,7 +74,7 @@ callable(param\_values) -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.md index 9a3aef0c97e..64476eeaabf 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.md index 55ab93c2325..cd419722bd4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.md index 31aa592b695..2484984c874 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.md index b1f14fb3936..0ad4946a2d5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.md index 6d7b8d64b4a..3a552c00d70 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.md index e11efc85ae5..96c2f27fc2f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.md index 1231b401a6e..e82979d6745 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 0a325af00ff..e163e07a261 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Bases: `abc.ABC` @@ -24,13 +24,13 @@ Constructor. -`abstract LegacyBaseOperator.chop(threshold, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.chop(threshold, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") ### construct\_evaluation\_circuit -`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Build circuits to compute the expectation w\.r.t the wavefunction. @@ -38,7 +38,7 @@ Build circuits to compute the expectation w\.r.t the wavefunction. -`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. @@ -46,7 +46,7 @@ Consume the result from the quantum computer to build the expectation, will be o -`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Time evolution, exp^(-jt H). @@ -54,7 +54,7 @@ Time evolution, exp^(-jt H). -`abstract LegacyBaseOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Check Operator is empty or not @@ -62,7 +62,7 @@ Check Operator is empty or not -`abstract LegacyBaseOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") print details @@ -70,7 +70,7 @@ print details -`abstract LegacyBaseOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Convert to new Operator format. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.md index d24a16a9769..ae1ad60213e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -34,13 +34,13 @@ Operators relevant for quantum applications -`MatrixOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### chop -`MatrixOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Eliminate the real and imagine part of coeff in each pauli by threshold. If pauli’s coeff is less then threshold in both real and imagine parts, the pauli is removed. To align the internal representations, all available representations are chopped. The chopped result is stored back to original property. Note: if coeff is real-only, the imag part is skipped. @@ -61,7 +61,7 @@ self or copy -`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Construct the circuits for evaluation. @@ -86,7 +86,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`MatrixOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Get a copy of self. @@ -94,7 +94,7 @@ Get a copy of self. -`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Use the executed result with operator to get the evaluated value. @@ -121,7 +121,7 @@ float -`MatrixOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Parameters** @@ -143,7 +143,7 @@ float -`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -172,7 +172,7 @@ numpy.array -`MatrixOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Check Operator is empty or not. @@ -188,7 +188,7 @@ bool -`MatrixOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Returns** @@ -202,13 +202,13 @@ str -`MatrixOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### to\_opflow -`MatrixOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.md index 58edb0b9a98..43ff09e9970 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 65630538d2f..bf4012a9ea0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` @@ -373,7 +373,7 @@ bool -`TPBGroupedWeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Perform self \* other. @@ -395,7 +395,7 @@ the multiplied operator -`TPBGroupedWeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -472,7 +472,7 @@ the simplified operator -`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Largest-Degree First Coloring for grouping paulis. @@ -550,7 +550,7 @@ to op flow -`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Greedy and unsorted grouping paulis. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 4130ae96338..4d1f948fa31 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -30,7 +30,7 @@ Weighted Pauli Operator -`WeightedPauliOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self + other. @@ -51,7 +51,7 @@ operator -`WeightedPauliOperator.anticommute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.anticommute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Anti commutes with @@ -59,7 +59,7 @@ Anti commutes with -`WeightedPauliOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminate the real and imagine part of weight in each pauli by threshold. If pauli’s weight is less then threshold in both real and imaginary parts, the pauli is removed. @@ -86,7 +86,7 @@ the operator is mutated. -`WeightedPauliOperator.commute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.commute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Commutes with @@ -94,7 +94,7 @@ Commutes with -`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Construct the circuits for evaluation, which calculating the expectation \. @@ -129,7 +129,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`WeightedPauliOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self @@ -137,7 +137,7 @@ Get a copy of self -`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.WeightedPauliOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. @@ -166,7 +166,7 @@ float -`WeightedPauliOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -188,7 +188,7 @@ float -`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -212,7 +212,7 @@ dict -`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -242,7 +242,7 @@ The constructed circuit. -`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -271,7 +271,7 @@ The constructed QuantumCircuit. -`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: @@ -308,7 +308,7 @@ the operator created from the input dictionary. -`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis in a file to construct an Operator. @@ -329,7 +329,7 @@ the loaded operator. -`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Create a WeightedPauliOperator via a pair of list. @@ -355,7 +355,7 @@ operator -`WeightedPauliOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check Operator is empty or not. @@ -371,7 +371,7 @@ bool -`WeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self \* other, and the phases are tracked. @@ -391,7 +391,7 @@ the multiplied operator -`WeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -407,7 +407,7 @@ str -`WeightedPauliOperator.reorder_paulis()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.reorder_paulis()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Reorder the paulis based on the basis and return the reordered paulis. @@ -423,7 +423,7 @@ the ordered paulis based on the basis. -`WeightedPauliOperator.rounding(decimals, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.rounding(decimals, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Rounding the weight. @@ -444,7 +444,7 @@ operator -`WeightedPauliOperator.simplify(copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.simplify(copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. @@ -468,7 +468,7 @@ the simplified operator -`WeightedPauliOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self - other. @@ -489,7 +489,7 @@ operator -`WeightedPauliOperator.to_dict()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_dict()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a dict in pauli representation. @@ -505,7 +505,7 @@ dict -`WeightedPauliOperator.to_file(file_name)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_file(file_name)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a file in pauli representation. @@ -517,7 +517,7 @@ Save operator to a file in pauli representation. -`WeightedPauliOperator.to_opflow(reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_opflow(reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.md index 07bd6621292..fad511f194a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ TaperedWeightedPauliOperator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self. @@ -73,7 +73,7 @@ copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -89,7 +89,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check the z2\_symmetries is empty or not. @@ -105,7 +105,7 @@ bool -`Z2Symmetries.taper(operator, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.taper(operator, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -132,7 +132,7 @@ list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`static Z2Symmetries.two_qubit_reduction(operator, num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`static Z2Symmetries.two_qubit_reduction(operator, num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.md index 2a15f7437f5..400e3845c24 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -96,7 +96,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -232,7 +232,7 @@ An `OperatorBase` equivalent to the negation of self. -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -308,7 +308,7 @@ A set of strings describing the primitives contained within the Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -368,7 +368,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.md index 234d33c0976..a21d9e5c3c4 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -105,7 +105,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -133,7 +133,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ListOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -241,7 +241,7 @@ An `OperatorBase` equivalent to the negation of self. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -265,7 +265,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -285,7 +285,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -301,7 +301,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -317,7 +317,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -341,7 +341,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -361,7 +361,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -373,7 +373,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -395,7 +395,7 @@ The `LegacyBaseOperator` representing this Operator. -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -411,7 +411,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -423,7 +423,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -435,7 +435,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -451,7 +451,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.md index 0d44bd127d9..41ccfd150e1 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -146,7 +146,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -328,7 +328,7 @@ A set of strings describing the primitives contained within the Operator. -`SummedOp.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Print out the operator in details. :returns: a formatted string describes the operator. :rtype: str @@ -336,7 +336,7 @@ Print out the operator in details. :returns: a formatted string describes the op -`SummedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -398,7 +398,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parametrized PrimitiveOps (in that case, AquaError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -431,7 +431,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`SummedOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -469,7 +469,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.md index 50a67ce9a69..ed9579963e6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -292,7 +292,7 @@ A set of strings describing the primitives contained within the Operator. -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -308,7 +308,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -352,7 +352,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0845d8186f3..972105875c3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -270,7 +270,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -286,7 +286,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -302,7 +302,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -346,7 +346,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -358,7 +358,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -370,7 +370,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -404,7 +404,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c06b5d15c6f..db393ba67f0 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -274,7 +274,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -306,7 +306,7 @@ The reduced `OperatorBase`. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -374,7 +374,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -386,7 +386,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -408,7 +408,7 @@ The `LegacyBaseOperator` representing this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -424,7 +424,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.md index 0e779e37344..0a29af1539e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -99,7 +99,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PauliOp.commutes(other_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.commutes(other_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns whether self commutes with other\_op. @@ -119,7 +119,7 @@ A bool equaling whether self commutes with other\_op -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -147,7 +147,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -167,7 +167,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -189,7 +189,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -249,7 +249,7 @@ An `OperatorBase` equivalent to the negation of self. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -293,7 +293,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -325,7 +325,7 @@ The reduced `OperatorBase`. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -393,7 +393,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -405,7 +405,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -427,7 +427,7 @@ The `LegacyBaseOperator` representing this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -455,7 +455,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -467,7 +467,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 06bb537c7b0..c29f249d801 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -97,7 +97,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -125,7 +125,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -145,7 +145,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -167,7 +167,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -179,7 +179,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -191,7 +191,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -227,7 +227,7 @@ An `OperatorBase` equivalent to the negation of self. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -251,7 +251,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -271,7 +271,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -287,7 +287,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -303,7 +303,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -327,7 +327,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -347,7 +347,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -359,7 +359,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -371,7 +371,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -383,7 +383,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -405,7 +405,7 @@ The `LegacyBaseOperator` representing this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -421,7 +421,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -433,7 +433,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 8fb7e91a1a3..15616f8ab35 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -136,7 +136,7 @@ An Operator equivalent to the function composition of self and other. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -185,7 +185,7 @@ A bool equal to the equality of self and other. -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -231,7 +231,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -257,7 +257,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -365,7 +365,7 @@ The reduced `OperatorBase`. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -387,7 +387,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -431,7 +431,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -443,7 +443,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -477,7 +477,7 @@ The `LegacyBaseOperator` representing this Operator. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -489,7 +489,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -501,7 +501,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.md index a6291c4b3ea..2acb13e731d 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -168,7 +168,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -188,7 +188,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -244,7 +244,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -284,7 +284,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -300,7 +300,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -316,7 +316,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -328,7 +328,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -372,7 +372,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -384,7 +384,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -396,7 +396,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -408,7 +408,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -438,7 +438,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.md index c7f657ffc46..7753ab1914e 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -204,7 +204,7 @@ An `OperatorBase` equivalent to the negation of self. -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -244,7 +244,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -298,7 +298,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -342,7 +342,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -354,7 +354,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -400,7 +400,7 @@ The `LegacyBaseOperator` representing this Operator. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -436,7 +436,7 @@ A VectorStateFn equivalent to self. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.md index d00c5e512aa..1e96869be1f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -384,7 +384,7 @@ The `LegacyBaseOperator` representing this Operator. -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -410,7 +410,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.md index 511b06e8ac4..f200f3a35ce 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -102,7 +102,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -128,7 +128,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -206,7 +206,7 @@ An `OperatorBase` equivalent to the negation of self. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -226,7 +226,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -246,7 +246,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -262,7 +262,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -278,7 +278,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -300,7 +300,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -324,7 +324,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -344,7 +344,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -368,7 +368,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -390,7 +390,7 @@ The `LegacyBaseOperator` representing this Operator. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -406,7 +406,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -426,7 +426,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.md index 1557aa5d657..afab35e8a34 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -374,7 +374,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -412,7 +412,7 @@ The `LegacyBaseOperator` representing this Operator. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -428,7 +428,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.md index 17e5fc4f133..34b0a0e40f6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for CircuitFactories -`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding sub-circuit to given circuit @@ -37,7 +37,7 @@ Adds corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding controlled sub-circuit to given circuit @@ -53,7 +53,7 @@ Adds corresponding controlled sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled inverse of corresponding sub-circuit to given circuit @@ -69,7 +69,7 @@ Adds controlled inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -77,7 +77,7 @@ Adds controlled, inverse, power of corresponding circuit. May be overridden if a -`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -85,7 +85,7 @@ Adds controlled power of corresponding circuit. May be overridden if a more effi -`CircuitFactory.build_inverse(qc, q, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse(qc, q, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse of corresponding sub-circuit to given circuit @@ -99,7 +99,7 @@ Adds inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -107,7 +107,7 @@ Adds inverse power of corresponding circuit. May be overridden if a more efficie -`CircuitFactory.build_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -115,7 +115,7 @@ Adds power of corresponding circuit. May be overridden if a more efficient imple -`CircuitFactory.get_num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits @@ -123,7 +123,7 @@ returns number of qubits -`CircuitFactory.get_num_qubits_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits controlled @@ -131,7 +131,7 @@ returns number of qubits controlled -`CircuitFactory.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas @@ -139,7 +139,7 @@ returns required ancillas -`CircuitFactory.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.29/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.29/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.29/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.md index f08a8c2467f..db0fe7be543 100644 --- a/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.29/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.29/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.29/qiskit.assembler.assemble_circuits.md index 0b7badfe8e7..91302eba922 100644 --- a/docs/api/qiskit/0.29/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.29/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.29/qiskit.assembler.assemble_schedules.md index 174896e6b6b..25ff21249a3 100644 --- a/docs/api/qiskit/0.29/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.29/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.29/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.29/qiskit.assembler.disassemble.md index acbe0abbd5d..d27cfe3c9e2 100644 --- a/docs/api/qiskit/0.29/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.29/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.md index d2285896e8f..362e19bbb2c 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ The Bosonic operator in this class is written in the n-mode second quantization -`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Filters out the states of irrelevant symmetries @@ -57,7 +57,7 @@ True if the state is has one and only one modal occupied per mode meaning that t -`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Maps a bosonic operator into a qubit operator. @@ -82,7 +82,7 @@ A qubit operator -`BosonicOperator.number_occupied_modals_per_mode(mode)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.number_occupied_modals_per_mode(mode)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A bosonic operator which can be used to evaluate the number of occupied modals in a given mode diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.md index 8852f24734c..88871eb1517 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ The [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") class -`FermionicOperator.fermion_mode_elimination(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_elimination(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Eliminate modes. @@ -72,7 +72,7 @@ Fermionic Hamiltonian -`FermionicOperator.fermion_mode_freezing(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_freezing(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Freezing modes and extracting its energy. @@ -94,7 +94,7 @@ tuple([FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.F -`FermionicOperator.mapping(map_type, threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.mapping(map_type, threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Map fermionic operator to qubit operator. @@ -121,7 +121,7 @@ create an Operator object in Paulis form. -`FermionicOperator.particle_hole_transformation(num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.particle_hole_transformation(num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") The ‘standard’ second quantized Hamiltonian can be transformed in the particle-hole (p/h) picture, which makes the expansion of the trail wavefunction from the HF reference state more natural. In fact, for both trail wavefunctions implemented in q-lib (‘heuristic’ hardware efficient and UCCSD) the p/h Hamiltonian improves the speed of convergence of the VQE algorithm for the calculation of the electronic ground state properties. For more information on the p/h formalism see: P. Barkoutsos, arXiv:1805.04340([https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340)). @@ -141,7 +141,7 @@ tuple -`FermionicOperator.total_angular_momentum()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_angular_momentum()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Total angular momentum. @@ -159,7 +159,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_magnetization()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_magnetization()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the magnetization of the given eigenstate. @@ -175,7 +175,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_particle_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_particle_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the number of particle of the given eigenstate. @@ -191,7 +191,7 @@ Fermionic Hamiltonian -`FermionicOperator.transform(unitary_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.transform(unitary_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Transform the one and two body term based on unitary\_matrix. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.md index 7767ac98360..a2386ddd296 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Bases: `object` @@ -41,7 +41,7 @@ A utility class for MP2 info -`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") With a reduced active space the set of used excitations can be less than allowing all available excitations. Given a (sub)set of excitations in the space this will return a list of correlation coefficients and a list of correlation energies ordered as per the excitation list provided. @@ -67,7 +67,7 @@ Tuple(list, list) -`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Gets the set of MP2 terms for the molecule taking into account index adjustments due to frozen core and/or other orbital reduction diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.md index e979a66297d..a35cd660fc7 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Bases: `object` @@ -28,13 +28,13 @@ This class provides methods to save it and load it again from an HDF5 file -`QMolecule.Z(natom)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.Z(natom)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ### has\_dipole\_integrals -`QMolecule.has_dipole_integrals()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.has_dipole_integrals()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Check if dipole integrals are present. @@ -42,7 +42,7 @@ Check if dipole integrals are present. -`QMolecule.load()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.load()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") loads info saved. @@ -50,7 +50,7 @@ loads info saved. -`QMolecule.log()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.log()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") log properties @@ -58,7 +58,7 @@ log properties -`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert one-body MO integrals to spin orbital basis @@ -82,7 +82,7 @@ numpy.ndarray -`static QMolecule.oneeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.oneeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts one-body integrals from AO to MO basis @@ -105,7 +105,7 @@ numpy.ndarray -`QMolecule.remove_file(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.remove_file(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") remove file @@ -113,7 +113,7 @@ remove file -`QMolecule.save(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.save(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Saves the info from the driver. @@ -121,7 +121,7 @@ Saves the info from the driver. -`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert two-body MO integrals to spin orbital basis @@ -146,7 +146,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts two-body integrals from AO to MO basis @@ -169,7 +169,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.md index 44ca4ce3362..1e48cd816ea 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.md index acff494f47e..cc29e688ef5 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.md index 4a12aea1ebf..2c9ac46295f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -51,7 +51,7 @@ The expectation value of the given operator(s). The return type will be identica -`AdaptVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -63,7 +63,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`AdaptVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Computes the ground state. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.md index 7f9d388d608..b20341d7dc0 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.md index 254c2c52a7a..e9d6ee9646a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a eigensolver based on a qubit operator transformation. -`abstract EigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`abstract EigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Returns a eigensolver, based on the qubit operator transformation. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index 7dad604602c..3ce3db48c4e 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via an Eigensolver algorithm -`ExcitedStatesEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Compute Ground and Excited States properties. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index e91e7836bc5..663ed080638 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The excited states calculation interface -`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Compute the excited states energies of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 02f4dbe380a..18e83d40eed 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` @@ -27,7 +27,7 @@ Ground state computation using a minimum eigensolver. -`GroundStateEigensolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Evaluates additional operators at the given state. @@ -48,7 +48,7 @@ The expectation value of the given operator(s). The return type will be identica -`GroundStateEigensolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -60,7 +60,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`GroundStateEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.md index 101256b9a3a..45cab346ef3 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ The ground state calculation interface -`abstract GroundStateSolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Evaluates additional operators at the given state. @@ -47,7 +47,7 @@ The expectation value of the given operator(s). The return type will be identica -`abstract GroundStateSolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Whether this class returns only the ground state energy or also the ground state itself. @@ -63,7 +63,7 @@ True, if this class also returns the ground state in the results object. False o -`abstract GroundStateSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index db1be79349d..eb9e42dbd54 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a minimum eigensolver based on a qubit operator transform -`abstract MinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns a minimum eigensolver, based on the qubit operator transformation. @@ -42,7 +42,7 @@ A minimum eigensolver suitable to compute the ground state of the molecule trans -`abstract MinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index e915859b2a4..c5759900f38 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` @@ -29,7 +29,7 @@ A factory to construct a NumPyEigensolver. -`NumPyEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Returns a NumPyEigensolver with the desired filter diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index f9cc83c2cc8..0587bb64afa 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -27,7 +27,7 @@ A factory to construct a NumPyMinimumEigensolver. -`NumPyMinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the `transformation`. @@ -47,7 +47,7 @@ A NumPyMinimumEigensolver suitable to compute the ground state of the molecule t -`NumPyMinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 0a0362652d0..1507f8c4edd 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -57,7 +57,7 @@ The expectation value of the given operator(s). The return type will be identica -`OrbitalOptimizationVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -69,7 +69,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`OrbitalOptimizationVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.md index 73920f5628b..2647a4e4f81 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via the qEOM algorithm -`QEOM.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Run the excited-states calculation. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.md index a80b38b913e..6e661775e3d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.md index 3bdfaeaae9a..caac0014a78 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.md index 25460147fc0..06e893291e1 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -79,7 +79,7 @@ dict -`VQEAdapt.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal circuit @@ -87,7 +87,7 @@ get optimal circuit -`VQEAdapt.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal cost @@ -95,7 +95,7 @@ get optimal cost -`VQEAdapt.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal vector diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 8d20352d9dc..134cd6fbcdd 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -35,7 +35,7 @@ A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. -`VQEUCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns a VQE with a UCCSD wavefunction ansatz, based on `transformation`. This works only with a `FermionicTransformation`. @@ -59,7 +59,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index db186bdd442..fe9d34414fd 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -31,7 +31,7 @@ A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction -`VQEUVCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns a VQE with a UVCCSD wavefunction ansatz, based on `transformation`. This works only with a `BosonicTransformation`. @@ -51,7 +51,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUVCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 9c6a5773253..7fd983696f2 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 6e977f009de..ebb790bcde3 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`DifferentialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Each parameter list and list of numerical gradients is treated as a single point in vector space. The regression model tries to fit a Hamiltonian that describes the evolution from one parameter set (and its gradient features) at point r, to another parameter set at point, r + epsilon. The regression model is then used to predict the parameter set at the point of interest. Note that this extrapolation technique does not explicitly use the spacing of the points (step size) but rather infers it from the list of parameter values. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index 8d04afed4fd..eda9274f2b4 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` @@ -26,7 +26,7 @@ This allows for fitting BOPES sampler results or potential energy surfaces. -`EnergySurface1DSpline.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -46,7 +46,7 @@ Value of surface fit in point x. -`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Fits surface to data. @@ -65,7 +65,7 @@ Fits surface to data. -`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. :type scaling: `float` :param scaling: scaling factor @@ -81,7 +81,7 @@ equilibrium geometry -`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. :type scaling: `float` :param scaling: scaling factor @@ -97,7 +97,7 @@ minimum energy -`EnergySurface1DSpline.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 589d66f534e..ecb8e7b2446 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a potential energy surface -`abstract EnergySurfaceBase.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -42,7 +42,7 @@ value of surface in point x -`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Fits surface to data @@ -61,7 +61,7 @@ Fits surface to data -`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the equilibrium energy. @@ -83,7 +83,7 @@ equilibrium geometry -`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the minimal energy. @@ -105,7 +105,7 @@ minimum energy -`abstract EnergySurfaceBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index 12098ea57e2..79f3c17b80d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ There are two types of Extrapolators: external/wrapper and internal. The externa -`abstract Extrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`abstract Extrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Abstract method to extrapolate point(s) of interest. @@ -47,7 +47,7 @@ Dictionary of variational parameters for extrapolated point(s). -`static Extrapolator.factory(mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`static Extrapolator.factory(mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Factory method for constructing extrapolators. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index 7916ddc3e05..5c81143c12a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -32,7 +32,7 @@ Input units are Angstroms (distance between the two atoms), and output units are -`HarmonicPotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the estimated dissociation energy for the current fit. @@ -52,7 +52,7 @@ estimated dissociation energy -`HarmonicPotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -72,7 +72,7 @@ value of potential in point x -`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Fits a potential to computed molecular energies. @@ -91,7 +91,7 @@ Fits a potential to computed molecular energies. -`static HarmonicPotential.fit_function(x, k, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`static HarmonicPotential.fit_function(x, k, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Functional form of the potential. @@ -114,7 +114,7 @@ harmonic potential functional form -`HarmonicPotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -130,7 +130,7 @@ fundamental frequency for the current fit -`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -170,7 +170,7 @@ maximum\_trusted\_level setted -`HarmonicPotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -214,7 +214,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`classmethod HarmonicPotential.process_fit_data(xdata, ydata)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`classmethod HarmonicPotential.process_fit_data(xdata, ydata)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() @@ -237,7 +237,7 @@ the processed data that fit better to a harmonic potential -`HarmonicPotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Updates the underlying molecule. @@ -257,7 +257,7 @@ Updates the underlying molecule. -`HarmonicPotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -277,7 +277,7 @@ vibrational energy level for the current fit -`HarmonicPotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 39f5a6ac5fd..f00c34443a6 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -34,7 +34,7 @@ Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algor -`MorsePotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the calculated dissociation energy for the current fit. @@ -54,7 +54,7 @@ calculated dissociation energy for the current fit -`MorsePotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -74,7 +74,7 @@ value of surface in point x -`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Fits a potential to computed molecular energies. @@ -93,7 +93,7 @@ Fits a potential to computed molecular energies. -`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Functional form of the potential. @@ -117,7 +117,7 @@ potential functional form -`MorsePotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -133,7 +133,7 @@ fundamental frequency for the current fit -`MorsePotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -153,7 +153,7 @@ interatomic distance corresponding to minimal energy -`MorsePotential.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. @@ -173,7 +173,7 @@ maximum\_trusted\_level estimated -`MorsePotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -217,7 +217,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`MorsePotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Updates the underlying molecule. @@ -237,7 +237,7 @@ Updates the underlying molecule. -`MorsePotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -257,7 +257,7 @@ vibrational energy level for the current fit -`MorsePotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index b9c05c60048..826a345addf 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -34,7 +34,7 @@ Constructor. -`PCAExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. This method transforms the parameters in PCA space before performing the internal extrapolation. The parameters are transformed back to regular space after extrapolation. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 67bf8bd84fa..3e3cb04837b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -30,7 +30,7 @@ Constructor. -`PolynomialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Extrapolation is based on a polynomial function/spline fitting with a user-specified degree. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 27e02c06513..362ee9caa30 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` @@ -22,7 +22,7 @@ Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of fr -`abstract PotentialBase.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract PotentialBase.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the dissociation energy (scaled by ‘scaling’) @@ -137,7 +137,7 @@ minimum energy -`PotentialBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") This (1D) potential represents a single vibrational mode @@ -149,7 +149,7 @@ This (1D) potential represents a single vibrational mode -`PotentialBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. Redefine in derived classes if needed. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index 2f59b46bb2c..4e0858f71f4 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -31,7 +31,7 @@ Constructor. -`SieveExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method finds a cutoff distance based on the maximum average distance or ‘gap’ between the average values of the variational parameters. This cutoff distance is used as a criteria to divide the parameters into two clusters by setting all parameters that are below the cutoff distance to zero. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index 6a795448f01..23343a3d42a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a molecular vibronic structure providing access to vibrational mod -`VibronicStructureBase.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. Default value of 100. Redefined where needed (see e.g. Morse). @@ -42,7 +42,7 @@ maximum\_trusted\_level setted -`abstract VibronicStructureBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the number of vibrational modes for the molecule. @@ -58,7 +58,7 @@ the number of vibrational modes -`VibronicStructureBase.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Wipe state if molecule changes, and check validity of molecule for potential. @@ -78,7 +78,7 @@ molecule used -`abstract VibronicStructureBase.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the n-th vibrational energy level for a given mode. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 681fb8420fb..434ae7bed14 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`WindowExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method defines the data window before performing the internal extrapolation. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index 3d7e0169b30..705c3b2b0c3 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Molecular ground state energy chemistry application -`MolecularGroundStateEnergy.compute_energy(callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy.compute_energy(callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver @@ -57,7 +57,7 @@ A molecular ground state result -`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index efe575f1e23..42af0c7e1c5 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Basis to express a second quantization Bosonic Hamiltonian. -`BosonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 36779a993cf..ef39732a053 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` @@ -34,7 +34,7 @@ This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) -`HarmonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.md index 2ffac17ec3c..d9d4dcec315 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -35,7 +35,7 @@ A Hartree-Fock initial state. -`HartreeFock.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.md index 2e0c0af3104..522b7cc0aa5 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ Creates an occupation number vector as defined in Ollitrault Pauline J., Chemica -`VSCF.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.md index 357ad749e4b..d1ef9c870cd 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -37,7 +37,7 @@ The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science -`CHC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.md index e709b18e9e7..c6cb6f62aa5 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -66,7 +66,7 @@ Constructor. -`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Computes single and double excitation lists. @@ -98,7 +98,7 @@ list -`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. @@ -119,7 +119,7 @@ list -`UCCSD.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Construct the variational form, given its parameters. @@ -152,7 +152,7 @@ returns entangler map -`static UCCSD.group_excitations(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. @@ -173,7 +173,7 @@ tuple -`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. @@ -194,7 +194,7 @@ list -`UCCSD.manage_hopping_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.manage_hopping_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Triggers the adaptive behavior of this UCCSD instance. This function is used by the Adaptive VQE algorithm. It stores the full list of available hopping operators in a so called “excitation pool” and clears the previous list to be empty. Furthermore, the depth is asserted to be 1 which is required by the Adaptive VQE algorithm. @@ -202,7 +202,7 @@ Triggers the adaptive behavior of this UCCSD instance. This function is used by -`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. @@ -223,7 +223,7 @@ list -`UCCSD.pop_hopping_operator()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.pop_hopping_operator()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pops the hopping operator that was added last. @@ -231,7 +231,7 @@ Pops the hopping operator that was added last. -`UCCSD.push_hopping_operator(excitation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.push_hopping_operator(excitation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pushes a new hopping operator. @@ -243,7 +243,7 @@ Pushes a new hopping operator. -`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Regroups the excitations that involve same spatial orbitals for example, with labeling. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.md index bee952ab726..f5d200aca47 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -34,7 +34,7 @@ This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Doub -`static UVCC.compute_excitation_lists(basis, degrees)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`static UVCC.compute_excitation_lists(basis, degrees)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Compute the list with all possible excitation for given orders @@ -59,7 +59,7 @@ List of excitation indexes in terms of modes and modals -`UVCC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Construct the variational form, given its parameters. @@ -85,7 +85,7 @@ Quantum Circuit a quantum circuit with given parameters -`UVCC.excitations_in_qubit_format()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.excitations_in_qubit_format()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") #### Gives the list of excitation indexes in terms of qubit indexes rather diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.md index 878f1ea509f..4061b4093bb 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for ChemistryOperator. -`ChemistryOperator.process_algorithm_result(algo_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator.process_algorithm_result(algo_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Takes the algorithm result and processes it as required, e.g. by combination of any parts that were classically computed, for the final result. @@ -42,7 +42,7 @@ Final chemistry result computed from the algorithm result -`abstract ChemistryOperator.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`abstract ChemistryOperator.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.md index c03444567c8..eb31d2657af 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` @@ -55,7 +55,7 @@ Final chemistry result computed from the algorithm result -`Hamiltonian.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") run method diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.md index 32e2f1c0875..a8f9f08f3e0 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.md index fd533f4dcab..e6b07622e9b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.md index 1302c42392b..2c4cd73fc6b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` @@ -68,7 +68,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`MolecularGroundStateResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether dipole moment is present in result or not @@ -80,7 +80,7 @@ Returns whether dipole moment is present in result or not -`MolecularGroundStateResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.md index bfb15314061..6ac9c24805a 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.md index d5c63c9d4f0..228ffac5f39 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.md index 39426cd2514..47f776191ca 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.md index b5df8909308..7f58d2463e8 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.md index 4da4e20d1af..8ec3e686c63 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry bosonic drivers. -`abstract BosonicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`abstract BosonicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.md index d79f936dd16..23caf4fba8b 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -39,7 +39,7 @@ A determinant based full configuration interaction program, Computer Physics Com -`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Convenience method to produce an FCIDump output file. @@ -58,7 +58,7 @@ Convenience method to produce an FCIDump output file. -`FCIDumpDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Constructs a QMolecule instance out of a FCIDump file. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.md index 174374675eb..3a4d06230a7 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry fermionic drivers. -`abstract FermionicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`abstract FermionicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.md index fe1cff4b4bf..37f1b1a1b71 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -37,7 +37,7 @@ This driver uses the Gaussian open-source Gaussian 16 interfacing code in order -`GaussianDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.md index 5b04ce5ae68..0f66d0991e1 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` @@ -34,7 +34,7 @@ Gaussian™ 16 forces driver. -`GaussianForcesDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.md index 5fc824ad1b9..6b7177cfdb7 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -36,7 +36,7 @@ This driver does not use Gaussian 16 interfacing code, as certain data such as f -`GaussianLogDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Runs the driver to produce a result given the supplied job control file. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.md index 40d7a5481cd..0e112c3acbd 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This result allows access to selected data from the log file that is not availab -`GaussianLogResult.get_watson_hamiltonian(normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult.get_watson_hamiltonian(normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Get the force constants as a WatsonHamiltonian diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.md index 9582539afdb..64e565da608 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -28,7 +28,7 @@ The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiski -`HDF5Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.md index 6289aa7eb45..928663b500f 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.md index 410096c76a9..3de633535df 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.md index ec18e83e10f..5796d2cf1bf 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ This module implements an interface for a driver-independent, i.e. generic molec -`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -56,7 +56,7 @@ end geometry -`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -76,7 +76,7 @@ end geometry -`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -96,7 +96,7 @@ end geometry -`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -116,7 +116,7 @@ end geometry -`classmethod Molecule.relative_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -136,7 +136,7 @@ end geometry -`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.md index d0a06fbbb14..ddb4af9d64d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -35,7 +35,7 @@ See [http://www.psicode.org/](http://www.psicode.org/) -`PSI4Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.md index 16d9f65e178..caea9901606 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -40,7 +40,7 @@ See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante -`PyQuanteDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.md index f4c64cdc041..55b44e98b06 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -42,7 +42,7 @@ See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) -`PySCFDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.md index 469b40c1e2a..6b4dc597ca3 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.md index 67d1f416cb9..1fb4cf470c9 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Creates an new instance of the result. :type points: `List`\[`float`] :param poi -`BOPESSamplerResult.point_results(point)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult.point_results(point)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") returns all results for a specific point. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.md index 767ebecf173..7a864fe5ae2 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.md index 71c4ad2f861..8a0b96613b1 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` @@ -66,7 +66,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`ElectronicStructureResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether dipole moment is present in result or not @@ -78,7 +78,7 @@ Returns whether dipole moment is present in result or not -`ElectronicStructureResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.md index cddb6391c36..cc2af141495 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.md index ce3d3d3d772..38002efdb4d 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.md index 3127a618daa..f908cca5d33 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -29,7 +29,7 @@ A vibronic Hamiltonian operator representing the energy of the nuclei in the mol -`BosonicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") **Parameters** @@ -47,7 +47,7 @@ Dict of hopping operators, dict of commutativity types and dict of excitation in -`BosonicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. In the fermionic case the default filter ensures that the number of particles is being preserved. @@ -59,7 +59,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`BosonicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -79,7 +79,7 @@ An vibronic structure result. -`BosonicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Transformation to qubit operator from the driver diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.md index bb6afdb8bce..58c401fa05c 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3ef9d847003..7b4deefdc79 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.md index 10bb4baa0fe..600ab26cb11 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -35,7 +35,7 @@ A transformation from a fermionic problem, represented by a driver, to a qubit o -`FermionicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -55,7 +55,7 @@ A tuple containing the hopping operators, the types of commutativities and the e -`FermionicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -69,7 +69,7 @@ In the fermionic case the default filter ensures that the number of particles is -`FermionicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -89,7 +89,7 @@ An electronic structure result. -`FermionicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.md index 2ae6f6416e7..fffc7533ce6 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.md index db32514f369..57e0ad41d45 100644 --- a/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.29/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for transformation to qubit operators for chemistry problems -`abstract Transformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -40,7 +40,7 @@ Returns: -`Transformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -52,7 +52,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`abstract Transformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -72,7 +72,7 @@ An “interpreted” eigenstate result. -`abstract Transformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.md index 8cd7b485d02..d3b4f754286 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.md index 634b2bed559..e53e9a58a06 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.md index bf25a7cff82..6bd13e1cfce 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.29/qiskit.circuit.Clbit.md index cf55bda3d15..43a6f8a46bd 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.md index eb392cf3a31..092856d8c38 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -220,7 +220,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Delay.md b/docs/api/qiskit/0.29/qiskit.circuit.Delay.md index 4c0eed62094..ad694b6169a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Add classical condition on register or cbit classical and value val. @@ -91,7 +91,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -199,7 +199,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -215,7 +215,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.md index e05c34fb48b..02ce8f97850 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Gate.md b/docs/api/qiskit/0.29/qiskit.circuit.Gate.md index 59769962af3..2f5a5fba5e6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -110,7 +110,7 @@ Add classical condition on register or cbit classical and value val. -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -208,7 +208,7 @@ reversed. -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -306,7 +306,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -326,7 +326,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.29/qiskit.circuit.Instruction.md index 56dcacff5ea..df48ee72209 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add classical condition on register or cbit classical and value val. @@ -83,7 +83,7 @@ Add classical condition on register or cbit classical and value val. -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -105,7 +105,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -129,7 +129,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -137,7 +137,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") DEPRECATED: use instruction.reverse\_ops(). @@ -155,7 +155,7 @@ reversed. -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -165,7 +165,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -189,7 +189,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -209,7 +209,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -229,7 +229,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.md index 26139092e55..99238e090d4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -34,7 +34,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add condition on classical register to all instructions. @@ -42,7 +42,7 @@ Add condition on classical register to all instructions. -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Measure.md b/docs/api/qiskit/0.29/qiskit.circuit.Measure.md index 700d91f1abc..a57e26f4f61 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.29/qiskit.circuit.Parameter.md index 999790ae31b..da59ceeb105 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -175,7 +175,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.md index 1d8ee50f6ce..235fa17e288 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.md index f927e45c737..7828c4cbc07 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.md index fdf5ea52213..1c43b15d172 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla_0: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -135,7 +135,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -154,7 +154,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -162,7 +162,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -189,7 +189,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -290,7 +290,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is None, applies to all. @@ -298,7 +298,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`QuantumCircuit.bind_parameters(values, value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values, value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -326,7 +326,7 @@ copy of self with assignment substitution. -`static QuantumCircuit.cast(value, _type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, _type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -334,7 +334,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -354,7 +354,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -362,7 +362,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -370,7 +370,7 @@ Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -378,7 +378,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -386,7 +386,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -394,7 +394,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -422,7 +422,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -477,7 +477,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -503,7 +503,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -523,7 +523,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -539,7 +539,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -547,7 +547,7 @@ Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.C -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -555,7 +555,7 @@ Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -563,7 +563,7 @@ Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -571,7 +571,7 @@ Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -579,7 +579,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -587,7 +587,7 @@ Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -595,7 +595,7 @@ Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -603,7 +603,7 @@ Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -611,7 +611,7 @@ Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -619,7 +619,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -627,7 +627,7 @@ Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -635,7 +635,7 @@ Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -643,7 +643,7 @@ Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate -`QuantumCircuit.decompose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -659,7 +659,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -685,7 +685,7 @@ qiskit.Instruction -`QuantumCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’. @@ -732,7 +732,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -806,7 +806,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -814,7 +814,7 @@ Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -842,7 +842,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -850,7 +850,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -870,7 +870,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -890,7 +890,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -910,7 +910,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -926,7 +926,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -946,7 +946,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -954,7 +954,7 @@ Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1080,7 +1080,7 @@ circuit.draw() -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1186,7 +1186,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1194,7 +1194,7 @@ Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSw -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1264,7 +1264,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1272,7 +1272,7 @@ Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1280,7 +1280,7 @@ Apply `MCU1Gate`. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1315,7 +1315,7 @@ qiskit.Instruction -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -1337,7 +1337,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured. @@ -1359,7 +1359,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). @@ -1367,7 +1367,7 @@ Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -1387,7 +1387,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -1397,7 +1397,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1409,7 +1409,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1417,7 +1417,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -1425,7 +1425,7 @@ Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.Pha -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -1433,7 +1433,7 @@ Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.Pau -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -1460,7 +1460,7 @@ A circuit implementing this circuit raised to the power of `power`. -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -1487,7 +1487,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -1507,7 +1507,7 @@ List(tuple) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1527,7 +1527,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1554,7 +1554,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1581,7 +1581,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -1589,7 +1589,7 @@ Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -1597,7 +1597,7 @@ Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XG -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -1605,7 +1605,7 @@ Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXG -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurement on all qubits if they are present. Deletes the ClassicalRegister that was used to store the values from these measurements if it is idle. @@ -1627,7 +1627,7 @@ Returns circuit with measurements removed when inplace = False. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -1655,7 +1655,7 @@ Reset q. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -1701,7 +1701,7 @@ the circuit with reversed bit order. -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -1745,7 +1745,7 @@ the reversed circuit. -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -1753,7 +1753,7 @@ Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -1761,7 +1761,7 @@ Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -1769,7 +1769,7 @@ Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -1777,7 +1777,7 @@ Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -1785,7 +1785,7 @@ Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -1793,7 +1793,7 @@ Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -1801,7 +1801,7 @@ Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -1809,7 +1809,7 @@ Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -2182,7 +2182,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -2336,7 +2336,7 @@ with attached instruction. -`QuantumCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of gate operations in circuit. @@ -2557,7 +2557,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -2565,7 +2565,7 @@ Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapG -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -2573,7 +2573,7 @@ Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -2581,7 +2581,7 @@ Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgG -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -2589,7 +2589,7 @@ Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -2597,7 +2597,7 @@ Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -2650,7 +2650,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -2671,7 +2671,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -2692,7 +2692,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -2700,7 +2700,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -2708,7 +2708,7 @@ Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -2716,7 +2716,7 @@ Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -2724,7 +2724,7 @@ Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -2853,7 +2853,7 @@ Apply unitary gate to q. -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -2869,7 +2869,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -2877,7 +2877,7 @@ Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -2885,7 +2885,7 @@ Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.md index 631b64d0b63..722180a95cc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.29/qiskit.circuit.Qubit.md index fd6ea387a2e..19f2145d2f9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.Reset.md b/docs/api/qiskit/0.29/qiskit.circuit.Reset.md index db36821fa59..d5ad125a0fa 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.md index 5575c46c0c3..cdc8153858e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -154,7 +154,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -302,7 +302,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -344,7 +344,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.md index ae94f80d436..fc8063c3c3d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -114,7 +114,7 @@ Add classical condition on register or cbit classical and value val. -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -298,7 +298,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -320,7 +320,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -356,7 +356,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 85a2a4729a6..690b52b4c36 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index c691288c43f..b79995d471d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.29/qiskit.circuit.library.AND.md index 648a2389ca2..7f2677e8362 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.md index 4a06432d594..4ab5adee456 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new barrier instruction. -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -45,7 +45,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Add classical condition on register or cbit classical and value val. @@ -53,7 +53,7 @@ Add classical condition on register or cbit classical and value val. -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.md index 23c145e9e74..b81d851ee9e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -36,7 +36,7 @@ Create a new 3-qubit controlled sqrt-X gate. -`C3SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C3X is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.md index 4f5eb579f84..dab626ac268 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.md index 0038fd79bca..53b513d6f96 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.md index f9854e01b74..d753960e13f 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.md index ea639de97f0..eeb3a99ef58 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.md index 1ae89788fea..68c0fecf9f9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -71,7 +71,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.md index 82f2112954e..d7d969d902e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.md index 0e942b081ea..d5ed8c39cb4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.md index 292afa15c6c..c381a22dfd4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.md index 56c6b377137..a847c538920 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.md index 98942079f30..5276c1ecf8d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.md index 1202f7eeba0..a21a2548b47 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.md index da4776b973c..7970d7e8a25 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.md index 17ef47f3306..a5743476752 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.md index 43b3ad8715d..906ec5cb3ce 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.md index 7b91c381efd..36131fed814 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.md index a378b4b80a7..c4b531b53e8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.md index 52efb1bfa37..24b88e1940c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.md index e7e2290cfc7..a9d87e54627 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.md index 2e490ea940e..69c00e1915b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.md index a953a4e9416..39b77eced97 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.md index 46381f1c63b..1840acc87f7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.md index 148ac42d178..d85c1f18dd6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.md index f7a3859659a..70d9c94e621 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.md index 4bcb1e1beac..1e1629743b4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.md index f4e892c337c..5ca272dd016 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.md index 4d2d9169916..2587327f214 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.md index 5a745088e3c..0efc064dc8a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GR.md index 7209ecc0e08..88471addd14 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.md index 71aa083afec..d71317a0cd6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.md index 6cc06a24d47..af1b23cd589 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.md index 8466600f053..d664f0e14c8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.md index 3a9588f99c8..2508e7ae1f6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.md index f7bf6ce118e..f4e6f51982c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.md index d24f0a4df5b..35169041b9c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.md index 500b209d60c..941dfdc7e08 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.md index 1f5fe56e5ea..9349598046e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.md index ab0a4176c1d..3f44eb54c23 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.md index 37103aa3e00..619c574b9ee 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.md index 2c236db1c10..10d4c612562 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.md index 3d904625192..dafb19123ec 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.md index 9bc4122037a..17aae70d925 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.md index 74928b7d27a..42a3793e589 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.md index 3a1185f373c..a73e1a3c7ba 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.md index 426d49f6834..a1f966647ea 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.md index aeeda9cf0d0..cad9befc265 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.md index bc67b7ca908..09bff9dc82a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.md index 74b06fd9380..ed6c036caa1 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -56,7 +56,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.md index 18d5c37cb29..7e4aa6039f7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.md index 8dcdd3807ad..a89c06d33c9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.md index 935f91d10df..22d510c1ec4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.md index 0f11bf418ed..dc14bf47721 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.md index 00c1ed0cbf3..78cd4e05a36 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new measurement instruction. -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.md index def9356edec..d732503ade4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.md index 488a4caa893..6487b4a9504 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.29/qiskit.circuit.library.OR.md index f3ee7c97b11..aaf0af23333 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.md index 5c5e6f8db3b..f21509e9eb3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.md index 8a71080853b..e57682cb532 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.md index 7119daf7f7a..43289d23126 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.md index f02a91c195c..bd0c8751174 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.md index 9a8009546db..f5a7b24e9d6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.md index fd53a6d8cab..32f9efd9359 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.md index 58771a39d73..166d3fa0577 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.md index aacb6989131..5ac94578f32 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 94a1cfd492e..2ae019ee8ba 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 20b10508163..93cf5d80a58 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.md index 2ada624c39e..764103c3df9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.md index cafd21b595a..fa44d5455a8 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.md index 932311cba70..ebad93bf9dc 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.md index 4545b2500a6..eda2a66ffb5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.md index 82acbe403a6..cc11c43f312 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.md index 0e3f7bac634..b425c7d26d2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.md index 0db3218bc97..88734afdf67 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.md index eab5fe55fe1..9579e5419c2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.md index 6e023f33c0f..83948311cde 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.md index 128c18dcf46..bd51856b2e0 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.md index 2b46955c44e..88fd78628f6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.md index ef77affdaac..987786012e5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.md index 2f2035eae69..1f6ba208e32 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.md index fa44339fb50..0c6126f7086 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.md index e8244085f6b..30d6950547c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.md index 4cfbee61b1f..4593c6a22a4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.md index d38c6c1667b..3e2bbbcb12d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.md index 989de416035..2d3490388db 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.md index c20563ec423..6dd72cc2346 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new reset instruction. -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.md index c6a7b1e06cd..eedca638845 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.md index c657f0ee852..536757393e2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.md index a829101a023..8518ed4751c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.md index d913f0e62cd..2d08b505e5b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.md index f11d7eb6216..cc6e058caa2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.md index b8035708015..db12e700fda 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.md index d03585524b0..f611ea7a707 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.md index e3dbaeb72dd..80e87fb56a1 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.md index 4f10c56dc2b..a78f7f2c8e2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.md index a9e5a1e7145..3e8ada96707 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.md index d908894c93e..20690138ae9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.md index 09a37c12208..b5a4cf7ed64 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.md index 07bb23f2d15..0c4ca373ef7 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.md index 25157118440..d89c12cca70 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.md index 7d5b28937ca..dd6717b85a0 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.md index f18f5ae21b2..d07a7109f78 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.md index 43e734f066e..c4211df1578 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.md index 21f9a64cd0c..a82778ecd28 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.md index c576b3ad645..f979263538b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.md index d1e1747e332..5d76044f233 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.md index df1ea433e53..2f1552e5317 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_1.md index 42cf538c532..22bd668f91f 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_2.md index 5bf66e9f98c..f2c5dd8fc10 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_3.md index 927f19fa200..94d8dfa34f4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_4.md index 8b16e2825d6..b22af4fca25 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_3_1.md index 2c09082d230..4fba3a33436 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_1.md index 07b3612de9c..ecf6ae0b847 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_2.md index 36856209e49..3c8360c05de 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_3.md index d0f5a22555e..b383502f2b2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_4.md index 57ae97f2a84..d05d911fcf2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_5_1.md index 570f78364e6..a13af44ea44 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_1.md index a9b3cb55224..ab33af8a64c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_2.md index 0a9966bb05d..5300850cc44 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_3.md index c979ff290d7..9d98315d660 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_4.md index e48a68c9e45..b60dac07ece 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_5.md index 69364d28f8d..04add82fbe3 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_1.md index 4e11397bbef..5023943cd35 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_2.md index 0485bc05efe..ced38daade6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_3.md index feaaa81f23c..caa0eaa3b81 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.md index 6b4367232a1..22826237cef 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_cy.md index bae210512c6..5cee06c07dd 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_xz.md index 6111e4b6d65..41579dc8e27 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_yz.md index f5feb56c245..a09251daecb 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz1.md index f8a2218bc4b..cae37878081 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz2.md index d4d76d03eb4..4771308c6ef 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz3.md index 9ab0e123a91..92dcb301fc6 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index fccc60c5901..6901ced3335 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index bc9dfac625c..79f50d36359 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 9a0f1d6e2e0..8275bd14b9d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index a099d56f93c..6a139dddd79 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 199b0ba73fb..af90757559d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index d8f119d2cde..6a7e2cbba0e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 645f993d038..64eb9dbc638 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index b29f66cbbd3..7d5f16134f9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index cdfab95456d..28a9def5e19 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 42e44c71ccb..38eb6fe0f01 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f2bf2fb8ffd..bfa2880e791 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f5857f8be6d..7bc7fb49e7f 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 54d796c48ea..3c958322aef 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 497c7f651c8..d7857911c5c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 05dd1473bf2..500c3f9542b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index bf4346c45e9..506e1f4c1e5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 143ce700b60..575584da1f5 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index bddea475821..c21c0e0b10b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 1d23abdcba1..dfdf7f93c5e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 5e04b1587b2..31a4609876c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7f827c64901..ad51542d5c9 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 5fd5601a5c9..e8b1fd4612d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index c8b3b9b383b..d6a37940f1a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 5e36d6a1208..86f78e9c92a 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 1340401a8c0..88220d5de36 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 7d6a80af75b..b0ac097f194 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 9d72c54ca1a..19994762b62 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index cfb20db8ead..4e172dfcd3c 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8f053052c41..bf49584b47e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 0dbc8a78f8c..406a990948d 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 767dfc0dc71..4af3a1e4799 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index fbf1fac3a16..cbb0b73f437 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index e00e9a09031..d026edef43f 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 51fafdebc96..e2d6bdcc984 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 7c6acba7de7..9bd4b84a326 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 23417772375..736756f7008 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 1f41755ea0a..4bd9eac06cd 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index f66ad8c3ec1..d55f4e85b13 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 42e65f18b74..7d348ef65a4 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index dcdd118e19e..5c506c0d1a2 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 2eae01bb124..10b935ea263 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 4038dc3d507..83a8fd11254 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 705eded25a9..d07c214552b 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4c845969dab..68996fb600e 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index d55538e6a62..80d5f36a9d0 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 4865ff7af80..ca902b97814 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 03d25edc1ff..f2a903e2504 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.dump.md b/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.dump.md index 6e832dbf55e..b5c5db7be06 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.dump.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.dump -`dump(circuits, file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`dump(circuits, file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.load.md b/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.load.md index 5df021c72c7..f3b81e96362 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.load.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.qpy_serialization.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.load -`load(file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`load(file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.29/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.29/qiskit.circuit.random.random_circuit.md index e576833a4b9..e1d1a04d628 100644 --- a/docs/api/qiskit/0.29/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.29/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.29/qiskit.compiler.assemble.md b/docs/api/qiskit/0.29/qiskit.compiler.assemble.md index 5ca3ef24c10..4fe7956f99a 100644 --- a/docs/api/qiskit/0.29/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.29/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.29/qiskit.compiler.schedule.md b/docs/api/qiskit/0.29/qiskit.compiler.schedule.md index 8e7a6cffa9f..6788dfb4f20 100644 --- a/docs/api/qiskit/0.29/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.29/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.29/qiskit.compiler.sequence.md b/docs/api/qiskit/0.29/qiskit.compiler.sequence.md index 5bfaf303b8b..4fceaa00aab 100644 --- a/docs/api/qiskit/0.29/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.29/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.29/qiskit.compiler.transpile.md b/docs/api/qiskit/0.29/qiskit.compiler.transpile.md index 3102cf09b2e..485f96f1b66 100644 --- a/docs/api/qiskit/0.29/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.29/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.29/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.29/qiskit.converters.ast_to_dag.md index fc456d3cb1a..c7a3ca6a5d6 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.29/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dag.md index 993a843e38b..6b47c2ad6ed 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dagdependency.md index 15a315afab9..ea1f2e076ca 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_gate.md index 9ec3011bd18..4ec8eb91504 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_instruction.md index 3b51d1479e3..6b9caca0aad 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.29/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.29/qiskit.converters.dag_to_circuit.md index 9fd5e9df0d5..e87a0827eee 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.29/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.29/qiskit.converters.dag_to_dagdependency.md index 1659bc658dd..40903d9c45a 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.29/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_circuit.md index 8bc14e76d3b..a95b2c1d722 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_dag.md index 340e3d702ef..87bb9458172 100644 --- a/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.29/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.md index 494a5dfc982..54c4c701d79 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -112,7 +112,7 @@ the current max node -`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -139,7 +139,7 @@ the current max node -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -147,7 +147,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -155,7 +155,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -167,7 +167,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -200,7 +200,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.compose_back(input_circuit, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose_back(input_circuit, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: use DAGCircuit.compose() instead. @@ -208,7 +208,7 @@ DEPRECATED: use DAGCircuit.compose() instead. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -218,7 +218,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -228,7 +228,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -240,7 +240,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGNodes. @@ -248,7 +248,7 @@ Returns set of the descendants of a node as DAGNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -272,7 +272,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -294,7 +294,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.extend_back(dag, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.extend_back(dag, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: Add dag at the end of self, using edge\_map. @@ -302,7 +302,7 @@ DEPRECATED: Add dag at the end of self, using edge\_map. -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -329,7 +329,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -337,7 +337,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -353,7 +353,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -361,7 +361,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -377,7 +377,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -385,7 +385,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -393,7 +393,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -407,7 +407,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGNodes. @@ -415,7 +415,7 @@ Returns the longest path in the dag as a list of DAGNodes. -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -423,7 +423,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -431,7 +431,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -439,7 +439,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -459,7 +459,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -471,7 +471,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -492,7 +492,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -500,7 +500,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -508,7 +508,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -516,7 +516,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -537,7 +537,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGNodes. @@ -545,7 +545,7 @@ Returns iterator of the predecessors of a node as DAGNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -553,7 +553,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as DAGNodes. @@ -569,7 +569,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -577,7 +577,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -585,7 +585,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -593,7 +593,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -609,7 +609,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -619,7 +619,7 @@ Add edges from predecessors to successors. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -635,7 +635,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -645,7 +645,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -653,7 +653,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a DAGNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -680,7 +680,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -698,7 +698,7 @@ Replace one node with dag. -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGNodes. @@ -706,7 +706,7 @@ Returns iterator of the successors of a node as DAGNodes. -`DAGCircuit.threeQ_or_more_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.threeQ_or_more_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3-or-more-qubit gates: (id, data). @@ -714,7 +714,7 @@ Get list of 3-or-more-qubit gates: (id, data). -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -722,7 +722,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -738,7 +738,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.topological_op_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -754,7 +754,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.twoQ_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.twoQ_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. @@ -762,7 +762,7 @@ Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -770,7 +770,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.md index bb21501298e..5a90ee6e808 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.md index bcd32521e05..a1b007467cd 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.md index fa2fb46df2b..3b7a6b442e9 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.md index f1bc71320da..8347f948010 100644 --- a/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.29/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.md index 6e95a5df69a..12f758d29b9 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.29/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -121,7 +121,7 @@ Add classical condition on register or cbit classical and value val. -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -177,7 +177,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -327,7 +327,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -335,7 +335,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.29/qiskit.extensions.Initialize.md index b853a50324b..90caafc8c78 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.29/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -60,7 +60,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -111,7 +111,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. @@ -251,7 +251,7 @@ bool -`Initialize.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Initialize instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.md index d83db85713b..cc5cd584b18 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.29/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Add classical condition on register or cbit classical and value val. @@ -103,7 +103,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.md index b465d1acd69..a77284cbebb 100644 --- a/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.29/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -120,7 +120,7 @@ Add classical condition on register or cbit classical and value val. -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -128,7 +128,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -177,7 +177,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -327,7 +327,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -335,7 +335,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.md index ab5c5a443aa..ed05ecd5593 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.29/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 05de4ab6cb8..19f5413aa81 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -33,7 +33,7 @@ Constructor. -`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Adds corresponding sub-circuit to given circuit @@ -142,7 +142,7 @@ returns number of qubits controlled -`EuropeanCallDelta.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas @@ -150,7 +150,7 @@ returns required ancillas -`EuropeanCallDelta.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index 392aea5a2ca..9f5b6d2a1bb 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -35,7 +35,7 @@ Constructor. -`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`EuropeanCallExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") returns required ancillas @@ -160,7 +160,7 @@ returns required ancillas controlled -`EuropeanCallExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 316c8b5f2a0..e04857292ee 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.29/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -36,7 +36,7 @@ Constructor. -`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -145,7 +145,7 @@ returns number of qubits controlled -`FixedIncomeExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas @@ -153,7 +153,7 @@ returns required ancillas -`FixedIncomeExpectedValue.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas controlled @@ -161,7 +161,7 @@ returns required ancillas controlled -`FixedIncomeExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.md index fb1cdeb326d..5540c469166 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ To use the subclasses, please see [https://github.com/Qiskit/qiskit-tutorials/bl -`BaseDataProvider.get_coordinates()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_coordinates()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns random coordinates for visualisation purposes. @@ -38,7 +38,7 @@ Returns random coordinates for visualisation purposes. -`BaseDataProvider.get_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns the covariance matrix. @@ -58,7 +58,7 @@ an asset-to-asset covariance matrix. -`BaseDataProvider.get_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -78,7 +78,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -98,7 +98,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -118,7 +118,7 @@ a per-asset mean vector. -`BaseDataProvider.get_similarity_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_similarity_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns time-series similarity matrix computed using dynamic time warping. @@ -138,7 +138,7 @@ an asset-to-asset similarity matrix. -`abstract BaseDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`abstract BaseDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Loads data. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.md index 94753becaed..ad9fb1dd4b5 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -144,7 +144,7 @@ an asset-to-asset similarity matrix. -`DataOnDemandProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.md index e1cc0617a79..d67f4ff88e0 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -143,7 +143,7 @@ an asset-to-asset similarity matrix. -`ExchangeDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.md index 1bcbc4c4948..4d6bbfd435a 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -140,7 +140,7 @@ an asset-to-asset similarity matrix. -`RandomDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Generates data pseudo-randomly, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.md index 52aba5452c7..4828fddcb3f 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.md index f19acad7323..54b205c6808 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`WikipediaDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.md index 2ee584d5c10..f205961b05b 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.29/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`YahooDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.md index dd9d483900a..35f05b36244 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.md index d0f88c08567..0d3fdafef06 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.md index 90e5c8b58f0..7aec65b5119 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.md index fd940e7ee8c..d5e4b734fc6 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.md index c71f6cc0b9a..8d56ebaf63c 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.md index 1cec73b08a3..419df9ac5b1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.md index 2242b5d8764..c057d7d091d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.md index d02ec6dd010..a155df678ed 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.md index c18ff34c92c..2ffb7fe61bb 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.md index 46efe0157ed..5a997c28987 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.md index b7627d45203..b011b738b4d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.md index 3a8aa5098ec..ae5f847fa56 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.29/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.md index 3922362b0f9..b41fdc9b1dc 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.md index 033560eff61..56e9976dfe2 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.md index 54364b12efc..c695dc4b508 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.md index 8584a3a690f..49fe9e2c3c1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.md index 40d7957630a..4b6c2e26112 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.md index ba4bd514893..387f010961b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 3d6f722a7e0..452e3277c6d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.md index 93de99f8d05..eba4d8a9ad6 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 334088e40ef..d3bcce556c0 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0ca0b7b67c0..b3cb9710f5c 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.md index 0f3bba86927..d072e158644 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 57a69ef51fa..2f83a375cb5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.md index 4bc47d26b5b..a69d4e77ba6 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 49e3ba02622..15cd48b959a 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.md index 2b0a1ce3bd7..d4b3fe51512 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.md index a4bb48a9b8e..ed39147d0d5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index 4f615d257b6..79e994c4744 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.md index 5dc44ca0492..2b8d0b699ec 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -55,7 +55,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.md index 4d41f6e5e23..0577877a3bf 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence @@ -36,7 +36,7 @@ This function computes the bound on variation distance based and the confidence -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single protocol run of accreditation protocol on simul backend diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.md index 01718a5447a..854522ad63e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.md index 7f5ca421e29..ccacdd777f0 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` @@ -29,7 +29,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate transpose of the CNOTDihedral element @@ -37,7 +37,7 @@ Return the conjugate transpose of the CNOTDihedral element -`CNOTDihedral.cnot(i, j)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.cnot(i, j)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. @@ -45,7 +45,7 @@ Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the composed operator. @@ -76,7 +76,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate of the CNOTDihedral element. @@ -92,7 +92,7 @@ Make a deep copy of current operator. -`CNOTDihedral.dot(other, qargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.dot(other, qargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the right multiplied operator self \* other. @@ -118,7 +118,7 @@ The operator self \* other. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: other tensor self. @@ -138,7 +138,7 @@ the tensor product operator: other tensor other. -`CNOTDihedral.flip(i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.flip(i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply X to this element. Left multiply the element by X\_i. @@ -146,7 +146,7 @@ Apply X to this element. Left multiply the element by X\_i. -`CNOTDihedral.from_circuit(circuit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.from_circuit(circuit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -178,7 +178,7 @@ Return tuple of input dimension for specified subsystems. -`CNOTDihedral.is_cnotdihedral()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.is_cnotdihedral()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return True if input is a CNOTDihedral element. @@ -194,7 +194,7 @@ Return tuple of output dimension for specified subsystems. -`CNOTDihedral.phase(k, i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.phase(k, i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply an k-th power of T to this element. Left multiply the element by T\_i^k. @@ -252,7 +252,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: self tensor other. @@ -272,7 +272,7 @@ the tensor product operator: self tensor other. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -297,7 +297,7 @@ Decompose 1 and 2-qubit CNOTDihedral elements. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -305,7 +305,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -313,7 +313,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert to an Operator object. @@ -321,7 +321,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the transpose of the CNOT-Dihedral element. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 754b7eacb30..8b2163e96d9 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.md index b18f6f79193..d7854d7e13b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.md index 62ed38a919d..cb084321e40 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. @@ -56,7 +56,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -76,7 +76,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -96,7 +96,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -120,7 +120,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.md index e82966c03c0..5be47257523 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.md index 3d42ae904cb..087a91924f8 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.md index b74bafa3b11..41820f2d520 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.md index 751d05ee71f..92bd314c40e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.md index 1454540bb20..55810cc5d2f 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.md index 397eae2c7c4..d43065093ae 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.md index a7421af715c..9c90d276cbf 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -47,7 +47,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -71,7 +71,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -79,7 +79,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(reset=True, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(reset=True, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -92,7 +92,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.md index 69e323d90d6..80681d4d48a 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.md index 9ec254be6af..8a8b513d769 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.gates_per_clifford.md index 05f4a549a58..4f9986929b5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.md index a567e8397bc..e0c1b505584 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.29/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -123,7 +123,7 @@ a handle to the instruction that was just added -`RawFeatureVector.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Call the initialize instruction. @@ -139,7 +139,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`RawFeatureVector.bind_parameters(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.bind_parameters(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bind parameters. diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.29/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.29/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.29/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.29/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.md index 56fc97fec81..0773653dca8 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -194,7 +194,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -210,7 +210,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -234,7 +234,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -250,7 +250,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -262,7 +262,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -286,7 +286,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -306,7 +306,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -318,7 +318,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -334,7 +334,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -346,7 +346,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.md index 28c74b79a54..815ea7ecdde 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.29/qiskit.opflow.anti_commutator.md index 3898db790be..85f54d4274f 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.commutator.md b/docs/api/qiskit/0.29/qiskit.opflow.commutator.md index fee5b93b02a..d2172385ff8 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.md index a00d134ed2c..7ef1f6a17ab 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.md index f2d2e759eed..0a26367547b 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.md index e3684e8963c..ff8184df7d4 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.md index 72f672de34f..573cf535bb1 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.md index 325cb11c1d4..a0e53dbd895 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.md index 93a5e86999e..f2e0bf2a7d2 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.29/qiskit.opflow.double_commutator.md index 4bdc73dda07..b683221f214 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.md index bba55129dca..4fa5d784a81 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.md index ae71ca2719c..54addd5040b 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.md index 4e93b0b8f51..0600758b9f7 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.md index 8993a5179ad..a155c64b246 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c8094df0d06..7be00afa27c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.md index 78ae73fad20..acf94d9f7f3 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.md index e846c732386..2f1524def39 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.md index e781c2e76c8..a33d03b8132 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.md index 95c23779df5..ca6f0b7f2ca 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.md index 161563dd794..dd6c75a56ac 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.md index 79cea305c20..b1225040f62 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.md index 5975abbdf52..5e9dfcf4211 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.md index 33966301d47..b5a981655a4 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.md index afcaea6d4a0..3a013bc4cdd 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.md index f6b8202b43d..79427656c9e 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.md index c07db9f3256..c0b89e29978 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.md index d6afd8ebc0b..0d9fc2a38a1 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.md index f375c3475b6..6b3474abd7c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.md index 598fc181127..20bfc03a64d 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.md index 850df331191..0e6796aed84 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.md index 8d79589afe0..75514ddeefd 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.md index 352d43dd268..3b55901f378 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.md index f4ac8a832c8..e81a6901eab 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.md index 11e541cabb8..78c8e24e3e3 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.md index 08944253b50..68b117566d3 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.md index 407fe1b1b01..15e5bb9139f 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.md index 03cc0694b50..2fcddfb0d4e 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.md index 7f1a289097d..2b91bd07914 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.md index 1d21cfa23b8..107a83d4489 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.md index 773dac11de7..a9b207588fd 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.md index 38ff1eda070..2d0c23c165a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.md index 2b3d38ad8d7..462397fa0d4 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.md index a6a95e2a19d..1b5d915c986 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.md index 27e7660a535..f34c50c98a2 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backend by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -183,7 +183,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -205,7 +205,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -249,7 +249,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -265,7 +265,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -286,7 +286,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -310,7 +310,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -322,7 +322,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -338,7 +338,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -350,7 +350,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.md index adc7134555c..82498bf1023 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index e79d5a51100..2cab71b234e 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.md index 7b5e72bf7c5..5d5d896f45c 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -65,7 +65,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -81,7 +81,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -89,7 +89,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.md index e4d35b103db..4f8ca4cb019 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.md index e1dd3b4e91f..0f322c553c8 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.md index 9206389fb7c..d8cf52cf557 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.md index 33a6664f407..94f60abcd8a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.md index 5e032defd82..039a65f1aed 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.md index 315df2f89ad..a61562894fe 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.md index 5e6a01d2378..d8f21000943 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.md index 9372d7fff09..8fe6bc0d377 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.md index bdaf05c904f..0dc04028355 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 3c0ddee770b..52040836598 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.md index 8c263ce4d89..16b8400a0a4 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -36,7 +36,7 @@ Optimization on Classical and Quantum Computers. arXiv preprint arXiv:2001.02069 -`ADMMOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -80,7 +80,7 @@ Returns True if the problem is compatible, False otherwise. -`ADMMOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Tries to solves the given problem using ADMM algorithm. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.md index 023564a13d5..d3f3337be92 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.md index 1ce1e212854..9175824d009 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.md index 49ea17d7f80..284d526dbdf 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -49,7 +49,7 @@ This initializer takes the algorithmic parameters of COBYLA and stores them for -`CobylaOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -112,7 +112,7 @@ The result of the multi start algorithm applied to the problem. -`CobylaOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.md index 56cf574ed45..b07f8629871 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -45,7 +45,7 @@ Initializes the CplexOptimizer. -`CplexOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -87,7 +87,7 @@ Returns True if the problem is compatible, False otherwise. -`static CplexOptimizer.is_cplex_installed()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`static CplexOptimizer.is_cplex_installed()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Returns True if cplex is installed @@ -95,7 +95,7 @@ Returns True if cplex is installed -`CplexOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.md index f8bec039b40..4f2e129b671 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.md index fdf1e811782..fa887f88aa1 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -34,7 +34,7 @@ Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. -`GroverOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -76,7 +76,7 @@ Returns True if the problem is compatible, False otherwise. -`GroverOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Tries to solves the given problem using the grover optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.md index c3841732628..7172485413c 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index 0c583aca782..9ede7545b9d 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` @@ -32,7 +32,7 @@ Minimum Eigen Optimizer Result. -`MinimumEigenOptimizationResult.get_correlations()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult.get_correlations()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Get \ correlation matrix from samples. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 7b6b8077e7c..54fc420dd2e 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -53,7 +53,7 @@ This initializer takes the minimum eigen solver to be used to approximate the gr -`MinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -95,7 +95,7 @@ Returns True if the problem is compatible, False otherwise. -`MinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.md index 858b2d9f97a..cf70df4393e 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` @@ -69,7 +69,7 @@ Returns True if the problem is compatible, False otherwise. -`MultiStartOptimizer.multi_start_solve(minimize, problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer.multi_start_solve(minimize, problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Applies a multi start method given a local optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 3a5a2cd46a1..a9163ab5585 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for optimization algorithms in Qiskit’s optimization module. -`abstract OptimizationAlgorithm.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -42,7 +42,7 @@ Returns the incompatibility message. If the message is empty no issues were foun -`OptimizationAlgorithm.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -62,7 +62,7 @@ Returns True if the problem is compatible, False otherwise. -`abstract OptimizationAlgorithm.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.md index a6aa4c989d0..014e77d6c41 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.md index 8bf9832d57f..21613d9ecb6 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index 24c7b4a162f..12d0272ee2d 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index b292156eee5..99c4d5f3534 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -64,7 +64,7 @@ This initializer takes a `MinimumEigenOptimizer`, the parameters to specify unti -`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -106,7 +106,7 @@ Returns True if the problem is compatible, False otherwise. -`RecursiveMinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Tries to solve the given problem using the recursive optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 34ca60acc3c..f8cd40fe775 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.md index d6d8d5db9ae..7136c317531 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -62,7 +62,7 @@ This initializer takes the algorithmic parameters of SLSQP and stores them for l -`SlsqpOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -125,7 +125,7 @@ The result of the multi start algorithm applied to the problem. -`SlsqpOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.md index b4da60e7fe8..f494851b386 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.md index e35345c4ba8..3818968c838 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -47,7 +47,7 @@ To chose the type of slack variables. There are 3 options for mode. -`InequalityToEquality.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a problem with inequality constraints into one with only equality constraints. @@ -73,7 +73,7 @@ The converted problem, that contain only equality constraints. -`InequalityToEquality.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a result of a converted problem into that of the original problem. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.md index e4a3c3ccc94..6c224c3b544 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -41,7 +41,7 @@ Annealers. arxiv.org:1706.01945. -`IntegerToBinary.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert an integer problem into a new problem with binary variables. @@ -65,7 +65,7 @@ The converted problem, that contains no integer variables. -`IntegerToBinary.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert back the converted problem (binary variables) to the original (integer variables). diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.md index b71a8baad93..202c4ef38d3 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -26,7 +26,7 @@ Convert a problem with only equality constraints to unconstrained with penalty t -`LinearEqualityToPenalty.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with equality constraints into an unconstrained problem. @@ -50,7 +50,7 @@ The converted problem, that is an unconstrained problem. -`LinearEqualityToPenalty.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert the result of the converted problem back to that of the original problem diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.md index 7eda37a7c99..f2077921bc9 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for converters of quadratic programs in Qiskit’s optimizatio -`abstract QuadraticProgramConverter.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Convert a QuadraticProgram into another form and keep the information required to interpret the result. @@ -34,7 +34,7 @@ Convert a QuadraticProgram into another form and keep the information required t -`abstract QuadraticProgramConverter.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Interpret a result into another form using the information of conversion diff --git a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.md index 630ff285c33..d602667802d 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -37,7 +37,7 @@ Convert a given optimization problem to a new problem that is a QUBO. -`QuadraticProgramToQubo.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a problem with linear equality constraints into new one with a QUBO form. @@ -61,7 +61,7 @@ The problem converted in QUBO format. -`static QuadraticProgramToQubo.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`static QuadraticProgramToQubo.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -83,7 +83,7 @@ A message describing the incompatibility. -`QuadraticProgramToQubo.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a result of a converted problem into that of the original problem. @@ -103,7 +103,7 @@ The result of the original problem. -`QuadraticProgramToQubo.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.md index 6aaa1e61bcd..f07e10ec8f4 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ Initializes the constraint. -`abstract Constraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`abstract Constraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Evaluate left-hand-side of constraint for given values of variables. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.md index b1fa58edc45..8b2d46fded4 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -30,7 +30,7 @@ Representation of a linear constraint. -`LinearConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.md index c4afeea8ae0..e778ec5c833 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The linear expression can be defined via an array, a list, a sparse matrix, or a -`LinearExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the linear expression for given variables. @@ -51,7 +51,7 @@ The value of the linear expression given the variable values. -`LinearExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the gradient of the linear expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient of the linear expression given the variable values. -`LinearExpression.to_array()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_array()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as array. @@ -87,7 +87,7 @@ An array with the coefficients corresponding to the linear expression. -`LinearExpression.to_dict(use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_dict(use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as dictionary, either using variable names or indices as keys. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.md index 880f9867257..1424ae8c13a 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -33,7 +33,7 @@ Constructs a quadratic constraint, consisting of a linear and a quadratic term. -`QuadraticConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.md index 9ec54d30e0e..4b406447014 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The quadratic expression can be defined via an array, a list, a sparse matrix, o -`QuadraticExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the quadratic expression for given variables: x \* Q \* x. @@ -51,7 +51,7 @@ The value of the quadratic expression given the variable values. -`QuadraticExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the gradient of the quadratic expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient quadratic expression given the variable values. -`QuadraticExpression.to_array(symmetric=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_array(symmetric=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as array. @@ -91,7 +91,7 @@ An array with the coefficients corresponding to the quadratic expression. -`QuadraticExpression.to_dict(symmetric=False, use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_dict(symmetric=False, use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as dictionary, either using tuples of variable names or indices as keys. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.md index d572d67bf56..f566abbc987 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -32,7 +32,7 @@ Constructs a quadratic objective function. -`QuadraticObjective.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the quadratic objective for given variable values. @@ -52,7 +52,7 @@ The value of the quadratic objective given the variable values. -`QuadraticObjective.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the gradient of the quadratic objective for given variable values. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.md index 331b06a13ea..58a09ecaa2f 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.md index f819786e881..6a652de761a 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.md index 224ffcab330..dd93ab6a778 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -38,7 +38,7 @@ The variables is exposed by the top-level QuadraticProgram class in QuadraticPro -`Variable.as_tuple()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable.as_tuple()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Returns a tuple corresponding to this variable. diff --git a/docs/api/qiskit/0.29/qiskit.providers.Backend.md b/docs/api/qiskit/0.29/qiskit.providers.Backend.md index 8f8b2617abf..5d43bc5af2e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.29/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.md index 624c3efa4ac..37527a2e10f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.29/qiskit.providers.BackendV1.md index 7982b298902..c1d3b6527a0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.29/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.md index de4e1e24d13..c2724f27642 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.29/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.29/qiskit.providers.BaseJob.md index 84da9924fa4..b915fd12e9f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.md index 5a3be2cefee..2823a2f7486 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.29/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.29/qiskit.providers.Job.md b/docs/api/qiskit/0.29/qiskit.providers.Job.md index 63659a6fffd..f3bbce8abc6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.29/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobError.md b/docs/api/qiskit/0.29/qiskit.providers.JobError.md index c451db25471..34cdf601cd6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.29/qiskit.providers.JobStatus.md index 5b2f11fd019..c234d5ec2ff 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.29/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.md index 5cd9186bd93..e190fbd84cd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.29/qiskit.providers.JobV1.md b/docs/api/qiskit/0.29/qiskit.providers.JobV1.md index 8a10a273119..9e8e5d7ee99 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.29/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.29/qiskit.providers.Options.md b/docs/api/qiskit/0.29/qiskit.providers.Options.md index ac32ae67834..006e6291d63 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.29/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Bases: `types.SimpleNamespace` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.29/qiskit.providers.Provider.md b/docs/api/qiskit/0.29/qiskit.providers.Provider.md index 968e515262f..bfcea8694aa 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.29/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.md index 2b87bbfd5ec..2e5188b77e3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.md index ed7ccfe563b..5e7acf5c172 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.md index 5ce096828b1..119e870e7c2 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.md b/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.md index 5f05701cd44..d697b38e607 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerJob -`AerJob(backend, job_id, fn, qobj, *args)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, *args)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -40,7 +40,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -48,7 +48,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Attempt to cancel the job. @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.md index 81fb664dab4..855d0bd5779 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.md index 000fea0a888..94b06b9c992 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -153,7 +153,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -177,7 +177,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -211,7 +211,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -219,7 +219,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -308,7 +308,7 @@ This method should be extended by sub classes to update special option values. -`AerSimulator.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/aer_simulator.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.md index f25fe1a5ff3..4c89153799f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -147,7 +147,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -205,7 +205,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, *args, backend_options=None, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, *args, backend_options=None, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.md index 7894bfeb877..ee4bf1e6d9c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -147,7 +147,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -181,7 +181,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -286,7 +286,7 @@ This method should be extended by sub classes to update special option values. -`QasmSimulator.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.md index 33e962f398e..a7508919725 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.md index 3758651f906..e2023eb2070 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.md index 8b589405a5e..4e7ee9be13c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -103,7 +103,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -111,7 +111,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 2f38ed064d5..be014218cf9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index a5d73a9b03b..3f2e2db244a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.md index c935e7dc05d..ec1fa80cea6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 145fc297654..a16a516159a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.md index 8c770327a44..de50d6ff738 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.md index a5154918f95..8c5ea345a6b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.md index f5d46a0c100..62748e95513 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.md index 7a37aa2645e..43869a2b504 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.md index 640dad3fb80..ba7157bd8d9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 0c9b930e435..52b25ebce18 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.md index ef026948e8f..a96785a901b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.md index 74d8417efa6..64ef4466fc7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.md index f2b80b70038..96bc54dee94 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.md index 551b691f73e..04c0c3fd5be 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.md index 874d8abcb5c..5a195e9f152 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.md index c74c22f784b..da0ea209a0c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.md index 42035f77cd1..5651e7d1bd9 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.md index 2201e4d4362..8eb95dd1f18 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.md index 31e4537f8e2..8b64db1b5dd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.md index 4a6a60925ed..c14c474b30e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.md index 151272e62bf..72f76804f34 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.md index 44f82bc33f3..a8027602be3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.md index bcfb7f46b6c..9b6e7e0f352 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.md index 01e2b51ac65..844f4d95f7c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.md index f1743868295..f573385fc3f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes.md index 0b669b04105..c34cc5ee857 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes_squared.md index 79bb40eff0c..fdac25ecd47 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_density_matrix.md index 74cc65ec146..1e650bd5b06 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value.md index 2f0af0f1bc9..7d4ffada7f8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value_variance.md index dd1ed4ef639..b591246f76c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_matrix_product_state.md index e77c2db58c1..4db8d3ff042 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities.md index 606b66af4ea..a2eaecff1b7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities_dict.md index 16ae2c687ca..086ffe552f5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_stabilizer.md index d01c85e1c12..3e086d79eaf 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_state.md index 07e5c762060..5cd6ad9855d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector.md index 482606c1893..5dc73b693ee 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector_dict.md index a1f1dc7b1e3..367fbad5b48 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_unitary.md index 73d179e5f2e..06fe9ae787d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_density_matrix.md index bee816e1bb8..51fec524b7e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_matrix_product_state.md index 2db259b4d51..6c1f7c0873a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_stabilizer.md index 31c78105b09..e31c686988f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_statevector.md index 63b8fb72b15..166311867bd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_superop.md index 28725784533..a2acde4da8a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_unitary.md index 3755cd50221..0549bfa7dae 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.md index 1c2a2c54320..06ecbbf983a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model. @@ -150,7 +150,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -173,7 +173,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -195,7 +195,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -259,7 +259,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -283,7 +283,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -291,7 +291,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -299,7 +299,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.md index efd6a317a3c..99fdf9cc24a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel other \* self. @@ -85,7 +85,7 @@ The composition error channel. -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -93,7 +93,7 @@ Make a copy of current QuantumError. -`QuantumError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel self \* other. @@ -118,7 +118,7 @@ The composition error channel. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -143,7 +143,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -167,7 +167,7 @@ the tensor product error channel other ⊗ self. -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if current error object is an identity @@ -175,7 +175,7 @@ Return True if current error object is an identity -`QuantumError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the compose of a error channel with itself n times. @@ -199,7 +199,7 @@ the n-times composition error channel. -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -207,7 +207,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -215,7 +215,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -239,7 +239,7 @@ the tensor product error channel self ⊗ other. -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -247,7 +247,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -255,7 +255,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.md index f9a12491edf..68dfc640689 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -81,7 +81,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -89,7 +89,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -114,7 +114,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -138,7 +138,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -146,7 +146,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -170,7 +170,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -178,7 +178,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -186,7 +186,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -210,7 +210,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -218,7 +218,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.amplitude_damping_error.md index 0305f120e20..1fc12ab472e 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.coherent_unitary_error.md index de1107669a4..aa2837fad3b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.depolarizing_error.md index 2505d42afae..a0face8dffa 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index bc242d7510e..b7c298bd8e5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index c62af1cd229..3821d29c4e8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_error_values.md index 2b1bc8469bf..7b65ff11d8f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_length_values.md index be7ea78eba1..69721d2f87d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_param_values.md index e657b1665df..9c81011bd27 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.readout_error_values.md index 97d13adc45c..18730236d34 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index dd116379a5f..18946d6a22b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.kraus_error.md index a35fecba148..4585336fd09 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.mixed_unitary_error.md index 0669b855ab3..69625c92fe6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.pauli_error.md index c92b7ceed49..cdec5fd9b84 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index b76a0b6f054..9d1fedfdf22 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_damping_error.md index 29082f182c5..571f69680b8 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.reset_error.md index d44921cd510..c9c5a2c0aa1 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.thermal_relaxation_error.md index 09ab8cb4351..5625c43ea4d 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.md index 2c6feb113dd..7a0047eb239 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.duffing_system_model.md index c880b5f09ee..11af83e0ecf 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.md index d191591270c..e3cc7abde37 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Transforms one quantum channel to another based on a specified criteria. -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_noise_model.md index 2f5e3d6397b..014084327f7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_quantum_error.md index 621da3e103e..6182b1978a7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.insert_noise.md index f907d1624eb..ba98e295c3c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.remap_noise_model.md index 02927d984ec..1ac257dc970 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.29/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.md index 1a9600d9787..274cabb8be7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.md index 6b901b10024..a1a30ea5642 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.md index dbdc2b1476c..32a5b314e49 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.md index 933a7deb632..2c5d6fe17c3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.md index dc2fded523b..698c76540f4 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.md index a75d9051fba..14c43d97a79 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.29/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.md index 4344bb2e5cb..7e3ed1777f2 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.md index ca761e46dff..af2d883e17c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index cec4fc42466..2ee0be8c182 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 79af09762a4..e591719edca 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 449019be974..ec1e890b4b6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index e46178b9eef..c861952d391 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.md index af17e0db07d..61bbe741a1f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index ec4f905db80..e32f5b1ed50 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.md index be873e03180..f7721361b3c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -475,7 +475,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.md index 44fc5a3efc3..abc7002f7c7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index e0a13181d11..a458969e0bb 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.md index fcba3e1a657..2ca562e58e6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.md index 9327d29ea98..f9b897d46d2 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -159,7 +159,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -175,7 +175,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.md index 037d67d23f9..688f3811ebf 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.md index a7e204ec3f6..b9d74788f50 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.md index 01ddd5b7006..18339de39e3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.md index 644b1b68ab9..f8de9e2c040 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.md index 624528d03b4..b47c5c445df 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.md index ad3307c4e13..6e656824dfc 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.md index d60cb444c0e..01071a482fd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 647eae1a554..4f9a9b4815c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 3f0dd9e7ec1..19f0da305cb 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.md index 9ee42782350..a1afb8b755b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index c0b8d4ef509..8f51705054a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index 6431153f5c8..32c9cc9a320 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.md index ad0313c9c8a..c6cc11b7cfe 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 3c727bf7209..9563c0861f6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -258,7 +258,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -290,7 +290,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -314,7 +314,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -338,7 +338,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -363,7 +363,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -387,7 +387,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -413,7 +413,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -493,7 +493,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -520,7 +520,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -542,7 +542,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -570,7 +570,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -615,7 +615,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.md index 0bbf974c710..1190f984155 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.md index f281293da41..f6195f25602 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.md index 207791c1b94..cfb66ace3ce 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.md index b9344955f03..e2f9c4f619a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.md index e48c8971f18..ca1f808bd83 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index a727797656b..b9977038acc 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index f35cfcbaef8..cf44eaed545 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.md index 28a38bd7e9d..581c93cf40f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.job_monitor.md index ee8b745104e..dd2fdcb3763 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.least_busy.md index edd2b10418d..4aa14f40398 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.md index 212b2bc7e0d..70f0139468f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 00d3e7a0aa0..35ae7fcf8cd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index fdf6b78f09e..58ce03df4d6 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index a82c0055676..544d01fc368 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 67a33878a32..c4658b1a63f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index a9c04f26edf..c0d48ca651b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 15e13ac66f2..3d1ac65151b 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.md index 9f10b5bcd7a..2a40ccd12bd 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.md index cc10166e22f..a3d4266727a 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.md index c3cbb54f4d9..e270d54bbbb 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.md index 0b9bda90a4a..17470e86e6f 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` @@ -49,7 +49,7 @@ BaseRandomService constructor. -`CQCExtractor.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Retrieve a previously submitted job. @@ -69,7 +69,7 @@ A `CQCExtractorJob` instance. -`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Process input data synchronously. @@ -95,7 +95,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the first extractor asynchronously. @@ -122,7 +122,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the second extractor asynchronously. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.md index c361511ac71..0fc73da8a08 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ CQCExtractorJob constructor. -`CQCExtractorJob.block_until_ready(timeout=None, wait=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.block_until_ready(timeout=None, wait=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Wait for the job to finish and return the result. @@ -70,7 +70,7 @@ Extractor output. -`CQCExtractorJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Query the server for the latest job status. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.md index 38d16e02439..bcab27e67da 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ IBMQRandomService constructor. -`IBMQRandomService.get_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.get_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return the random number service with the given name. @@ -60,7 +60,7 @@ Service with the given name. -`IBMQRandomService.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return all random number services available to this account. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 490b359f225..c9a85d885a5 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -162,7 +162,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -180,7 +180,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -196,7 +196,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -224,7 +224,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -246,7 +246,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -283,7 +283,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -305,7 +305,7 @@ Sets a program’s visibility. -`IBMRuntimeService.upload_program(data, metadata=None, name=None, max_execution_time=None, description=None, version=None, backend_requirements=None, parameters=None, return_values=None, interim_results=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None, name=None, max_execution_time=None, description=None, version=None, backend_requirements=None, parameters=None, return_values=None, interim_results=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 1baa09f210c..c5242b903f3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(params)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(params)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.md index b2514045a61..5118a383641 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.md index 64e9a2dedec..0879e146e24 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index b2cbda219da..ef0ab3ab931 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index c22f600387f..a311a1f4a90 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.md index c0bfc2940e1..87f09246ae4 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -54,7 +54,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -70,7 +70,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -87,7 +87,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -99,7 +99,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -115,7 +115,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -131,7 +131,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -155,7 +155,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -181,7 +181,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -197,7 +197,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -224,7 +224,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 9188c5c94c2..4612f139b27 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -75,7 +75,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.md index b85acf7fdcd..c92663f50d1 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.seconds_to_duration.md index 0bd2b10b6d7..c8a8e87a466 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.to_python_identifier.md index 2dfbfed663d..3fdcd9b46a3 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.update_qobj_config.md index 92a68f9f19a..bf644e78ed0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.utc_to_local.md index 669e2de5b50..f07c209fbf7 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.validate_job_tags.md index 79b9de18509..a9908753502 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.29/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.md index 1194041a160..a98f84d7d25 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.md index 95a5a196fdd..23cc125a1dc 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Create a new Gate object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.md index 2a77cb0018c..c8310dbaea0 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.Command.md b/docs/api/qiskit/0.29/qiskit.providers.models.Command.md index d59f62fa357..0064c29ba84 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.md index f2567400f56..84751abd71c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.md index fec2e864f50..00e71ba5b63 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.md index 6c8cbdaf67b..2b7d9d81202 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.md index 5b451249c5b..3d849f6b642 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.md index 03a572c07fa..dc79f529a51 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.md index c5e76ea2756..8a7866e606c 100644 --- a/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.29/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.29/qiskit.pulse.Acquire.md index e81c9ad04e6..ddbc145a70a 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.md index c0c426ea242..29f34ba6a0f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Call.md b/docs/api/qiskit/0.29/qiskit.pulse.Call.md index 7799d85e74d..5984caf0764 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Constant.md b/docs/api/qiskit/0.29/qiskit.pulse.Constant.md index 4d938607047..02184ee1aa7 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.md index b4dba6f160f..2b778a25c38 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Delay.md b/docs/api/qiskit/0.29/qiskit.pulse.Delay.md index 5b1c53a52df..a14b028f5ee 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Drag.md b/docs/api/qiskit/0.29/qiskit.pulse.Drag.md index 43b41cc3adb..c88bb9a600e 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.md index e76436c993a..195322c688f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.md index e702d836cdd..41a84546aec 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.md index 7f8a3a3f7fd..f3631d07c9b 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.29/qiskit.pulse.Instruction.md index ed76521b1e2..f15a0f63b7c 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.md index 1151ecd4dfb..ffd9fd4586f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -170,7 +170,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -192,7 +192,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -216,7 +216,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.md index 37f7f62aa03..01fcf813f1a 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.md index 9ac277595cf..63bf5b6d97b 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Play.md b/docs/api/qiskit/0.29/qiskit.pulse.Play.md index da5ab8a6b88..74c3dc0b374 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.29/qiskit.pulse.PulseError.md index 4a3cdeb7c7e..2bcf25644bf 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.md index 09a49766530..42277f2ac23 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.29/qiskit.pulse.Schedule.md index 26facb29dff..bdfb1e94a0f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -239,7 +239,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -264,7 +264,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -287,7 +287,7 @@ If no arguments are provided, `self` is returned. -`Schedule.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Deprecated. @@ -299,7 +299,7 @@ Deprecated. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -321,7 +321,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -346,7 +346,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -365,7 +365,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -377,7 +377,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -438,7 +438,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.md index 6be4597cd35..4ea0dfc1225 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -126,7 +126,7 @@ Return the time of the end of the last instruction over the supplied channels. -`ScheduleBlock.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -142,7 +142,7 @@ Return the time of the start of the first instruction over the supplied channels -`ScheduleBlock.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -232,7 +232,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -265,7 +265,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -296,7 +296,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -318,7 +318,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -343,7 +343,7 @@ New block object with name and metadata. -`ScheduleBlock.insert(start_time, block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.insert(start_time, block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. @@ -366,7 +366,7 @@ This method will be removed. Temporarily added for backward compatibility. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -378,7 +378,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -390,7 +390,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -412,7 +412,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.shift(time, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.shift(time, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.md index 70e4017f765..bdcaecf284d 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.md index 62054c398c0..31416321d95 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.md index ccb0461c3b8..e2b5095ff9f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.md index b212bcf03ae..4303c5627fa 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.md index 0b35a9e071b..2978a2245eb 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.29/qiskit.pulse.Waveform.md index 64ae0355b64..4f36364a78e 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire.md index 7fb6b0c1c63..958170cf301 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire_channel.md index 98b8ed75896..484673363ea 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.active_backend.md index 29546869ebf..ca6fd922e1f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 4e74842ec4f..16cbc35b5f1 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.active_transpiler_settings.md index f3a15baa159..32640b97eb2 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_equispaced.md index 0fad84227e1..560510b986b 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_func.md index ccb18677995..54e8ac6b580 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_left.md index cbbb71aac73..fd6505616a3 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_right.md index 572951819b6..fb6aa7e45cd 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_sequential.md index 0b1585565a3..8b9a24f84a2 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.barrier.md index 339e1e01b0a..31e64cd6d59 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.build.md index 6e9fef84af6..027f1148f27 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.call.md index d69592c6a61..582dcc9cd79 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.circuit_scheduler_settings.md index 657d3302d88..a65c3624e7e 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.control_channels.md index 762939f242c..160ab43c52c 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.cx.md index 7e02b9e1bb7..95a269bec64 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.delay.md index 4f71e962d27..55ee9d104ff 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.delay_qubits.md index b0f847d24e3..70add771a15 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.drive_channel.md index ff0cf2a08e9..82422de0315 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.frequency_offset.md index e1a747dba9a..f62b75817fd 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.inline.md index 5f57428166d..5b9fedec7e9 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.measure.md index cc5ba4115b9..3b9a30910cc 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_all.md index 51e42b44561..8c11a4ce0f4 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_channel.md index 81f11f99879..b8b3e622524 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.num_qubits.md index 676d2ed6d40..701276b045b 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.pad.md index 43e967fc609..90f31cddfdd 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.phase_offset.md index 62ba68346f5..2498e5ac893 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.play.md index 18c6de4b90e..a7900788790 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.qubit_channels.md index 8bdc60de4df..2ae537d76a0 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.samples_to_seconds.md index b6d7fcda54f..dd76abd524f 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.seconds_to_samples.md index d93f52c4470..79d53f9ed18 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.set_frequency.md index d85f6e4ca0e..5808cfa6cc8 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.set_phase.md index b41660ee5ad..07b01f8d5e1 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_frequency.md index 2544b9eb704..9d4a11f08d6 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_phase.md index 94e436785ef..2451e512b45 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.snapshot.md index e983009dc0b..5a5c3597646 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.transpiler_settings.md index f5fbba68e32..d55a51109be 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.u1.md index 9941efd5892..0372cd49e83 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.u2.md index 593b6b26057..1106180b726 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.u3.md index ec7e467dae9..a78e299a90d 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.29/qiskit.pulse.builder.x.md index 0a4e7cc7f76..db5b0046e3d 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.md index b4d3e2cd393..fd9686e9043 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.md index 81e6a62715f..44f6c9375c0 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.md index b454559b818..2cf252fac58 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.md index 2669c0e7e33..a0d16875406 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.md index 867a3a2f0f2..df5d8545751 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.md index 145fda8c30a..a9528d66c33 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.md index 9cb4acecad2..1ebcfb1a11c 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.md index 23fc954ed82..207efa106f7 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.md index da52194db0e..48495887d05 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.md index 6a8c84c04ea..413eaa320e4 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.md index b6a1742d533..847bbb1d5b7 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.md index 0f819369aff..d54ee604c97 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.md index 8a9a5b4afca..0a37c624210 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.md index 0b10fefe392..806fe3393d7 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.md index 73fb571e07c..3c3f56c74b7 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.29/qiskit.pulse.transforms.add_implicit_acquires.md index 4a6619928c2..0980cb98d6b 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.29/qiskit.pulse.transforms.align_measures.md index 912fbe3c1d7..e455aa7afbd 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.29/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.29/qiskit.pulse.transforms.pad.md index 4fde0d29b1f..708fb7dea2c 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.md index 568692c6cec..cd7cbe99aa4 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.29/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.29/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.29/qiskit.qasm.Qasm.md index 5811942acdb..e252baff09b 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.29/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.29/qiskit.qasm.QasmError.md index 0953fcef5e4..baf3c16ec44 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.29/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.md index 8577ea17145..d6604047c6b 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.29/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.md index 4bb241a51f1..996e8f90c48 100644 --- a/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.29/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.md index dc6807f4f47..cb9c76c431b 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.md index 250da02a36c..e539df275f8 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.md index f32e162938b..61bd5da66dc 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.md index 23de14f2b58..13310686dd6 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.md index 946eb56277f..6108c37bf58 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.md index a102b65db76..26905407c4f 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.md index 09e4e8cf6b6..02a106e69be 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.md index 93e83cf8204..792aafbd46a 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.md index 229e0c25a80..0efb9250ec6 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.md index 68efc15b60a..8f1af92cd29 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.md index 1ac3a0d1412..8a9ab6d04c8 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.md index 169ff7f0edd..2f540e16e76 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.md index 2a8827e0025..b652e1c615b 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.29/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.29/qiskit.qobj.Qobj.md index 48fab3cc3e7..d5931646cfe 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.md index dfdb814e30a..4356b458ef9 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.md index 0683e853895..ce821f49651 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.md index 8d2804fa7cf..113a5434563 100644 --- a/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.29/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.md index ebff470a33f..dd0721a2889 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.md index ccf832fe311..4b2db827eaa 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.md index 7ec4ff27c21..53f3ad6cff6 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.md index e69135ac64a..c054c07c1fa 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.md index 45eb39aec8e..60a67bb15d1 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.md index a59d2279a15..bab4107eda2 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.md index d746922fe44..be43b8e566a 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.md index 174a69f047a..fd55e4f045a 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -207,7 +207,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -223,7 +223,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -273,7 +273,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -291,7 +291,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -317,7 +317,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -325,7 +325,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -333,7 +333,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.md index d14a8785d50..9b762b76754 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.md index b8d396e287b..056331534c7 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -344,7 +344,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -366,7 +366,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -401,7 +401,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -426,7 +426,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -460,7 +460,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -468,7 +468,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -500,7 +500,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -546,7 +546,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -595,7 +595,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -611,7 +611,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -636,7 +636,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -662,7 +662,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -670,7 +670,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -690,7 +690,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -710,7 +710,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -728,7 +728,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -736,7 +736,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -763,7 +763,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.md index 91f4377a9fc..a6c1d2e0436 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -372,7 +372,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -396,7 +396,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -426,7 +426,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -454,7 +454,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -462,7 +462,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -480,7 +480,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -560,7 +560,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -623,7 +623,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -647,7 +647,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -676,7 +676,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -706,7 +706,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -714,7 +714,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.md index 24ae20b9462..3cc5194073f 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.md index ebd5cb973c2..4a188ed873b 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.md index 4580365d9cc..aea5d2c2f59 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.md index b72250d6dc1..e475b2c7eac 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -39,7 +39,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -47,7 +47,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -79,7 +79,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -138,7 +138,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list \[(pauli\_str, coeffs)] @@ -146,7 +146,7 @@ Construct from a list \[(pauli\_str, coeffs)] -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -182,7 +182,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -203,7 +203,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -221,7 +221,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -301,7 +301,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliTable by combining duplicates and removing zeros. @@ -322,7 +322,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -348,7 +348,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -370,7 +370,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -390,7 +390,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -398,7 +398,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.md index 845a37a909b..f4afb057545 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of an operator. @@ -154,7 +154,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -162,7 +162,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -186,7 +186,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -209,7 +209,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -234,7 +234,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -254,7 +254,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -305,7 +305,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -340,7 +340,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -364,7 +364,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -372,7 +372,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.md index 1c85e3bceed..0bcf91d50cc 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.md index d41ce984ff1..a4222278812 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -103,7 +103,7 @@ Return a visualization of the Statevector. -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -129,7 +129,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -154,7 +154,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -178,7 +178,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -199,7 +199,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -225,7 +225,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -253,7 +253,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -286,7 +286,7 @@ The N-qubit basis state density matrix. -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -318,7 +318,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -416,7 +416,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -424,7 +424,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -448,7 +448,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -528,7 +528,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -552,7 +552,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -623,7 +623,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -631,7 +631,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.md index 6b75108f76f..65db3087e12 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.md index c3a7de9df50..2f806ef834b 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 033460fc1ea..8011ed5e7e9 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.29/qiskit.quantum_info.average_gate_fidelity.md index 7fb9a34233e..1b5652e7c30 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.29/qiskit.quantum_info.concurrence.md index c78b08178f3..687f9ae3338 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.29/qiskit.quantum_info.decompose_clifford.md index 6ca92850231..7d7e125d7df 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.29/qiskit.quantum_info.diamond_norm.md index 86f41fd7f25..a21fca61eb8 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.29/qiskit.quantum_info.entanglement_of_formation.md index ba0a5cf5d39..474efe05fef 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.29/qiskit.quantum_info.entropy.md index 972b7960c19..75988e6cee9 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.29/qiskit.quantum_info.gate_error.md index 2e21141eb7e..d0cc1eb2da5 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_distance.md index adfb9615a12..1efd2679b14 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_fidelity.md index a09de96ef13..5dc1ffbad75 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.29/qiskit.quantum_info.mutual_information.md index e4a660de27e..255470a0614 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.29/qiskit.quantum_info.partial_trace.md index fcab650edfc..c35c456a54e 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_basis.md index 1013541d50e..67e47327c8d 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_group.md index 4e5d94cc6fe..f7f574ad41f 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.29/qiskit.quantum_info.process_fidelity.md index 54dc69af792..0fe2d78fe1c 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.29/qiskit.quantum_info.purity.md index 2508d906b61..dfe63a28948 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_clifford.md index e397857937f..ebc9b143eca 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_cnotdihedral.md index 78482875122..7bf929ca519 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_density_matrix.md index 712a7a1eb2c..53f6e8e95a0 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_hermitian.md index 7822a9824b8..3a7c0fe6d7a 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli.md index bd5ff2607f8..1a1172b860f 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli_table.md index 137ca4d950e..6eafed31d9d 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_quantum_channel.md index 22449571abe..c74cf52ae83 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_stabilizer_table.md index 7b50b105331..3e9133f893d 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_statevector.md index ffd24a93345..c11755caa79 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.29/qiskit.quantum_info.random_unitary.md index fbfab7f787f..8ebc0cd56d2 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.29/qiskit.quantum_info.shannon_entropy.md index 3cffae817a1..d1f3ed5ceb7 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.29/qiskit.quantum_info.state_fidelity.md index a17bb1a7eeb..219305ec9d7 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.29/qiskit.result.Counts.md b/docs/api/qiskit/0.29/qiskit.result.Counts.md index 3e0c1b28c27..b0836bc1dac 100644 --- a/docs/api/qiskit/0.29/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.29/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return the most frequent count diff --git a/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.md index 652a93c0df8..badfda93833 100644 --- a/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.md index a3df439e777..2a008309699 100644 --- a/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.29/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -121,7 +121,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.29/qiskit.result.Result.md b/docs/api/qiskit/0.29/qiskit.result.Result.md index 1d5d04a9af8..dfea27ddcd8 100644 --- a/docs/api/qiskit/0.29/qiskit.result.Result.md +++ b/docs/api/qiskit/0.29/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.29/qiskit.result.ResultError.md b/docs/api/qiskit/0.29/qiskit.result.ResultError.md index 9636b827e5e..651b0b3a115 100644 --- a/docs/api/qiskit/0.29/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.29/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.29/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.29/qiskit.result.marginal_counts.md index 984ec18e675..4fbf937bd99 100644 --- a/docs/api/qiskit/0.29/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.29/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.md index d95b631d265..e3691a3a0d8 100644 --- a/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.29/qiskit.tools.backend_monitor.md index 900dae82e23..8917e8199fd 100644 --- a/docs/api/qiskit/0.29/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.29/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.29/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.29/qiskit.tools.backend_overview.md index 957fb280a60..f988ef320c1 100644 --- a/docs/api/qiskit/0.29/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.29/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.29/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.29/qiskit.tools.job_monitor.md index 3d16ebac30c..92e57bda169 100644 --- a/docs/api/qiskit/0.29/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.29/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.29/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.29/qiskit.tools.parallel_map.md index 07db725f8f3..f232ba2823a 100644 --- a/docs/api/qiskit/0.29/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.29/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.md index 5567193156c..9509698d52a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.md index 2ce2dfac706..8f25b090032 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -80,7 +80,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -102,7 +102,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -110,7 +110,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return qubits connected on a grid of num\_rows x num\_columns. @@ -118,7 +118,7 @@ Return qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -126,7 +126,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -134,7 +134,7 @@ Return a fully connected coupling map on n qubits. -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -150,7 +150,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -160,7 +160,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -168,7 +168,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -176,7 +176,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -186,7 +186,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -210,7 +210,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -235,7 +235,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -243,7 +243,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.md index 2911a55d282..a470e79302b 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.md index b19b52b8d4b..00e28c66d3c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.md index c66a5aa118b..ab556eb695e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.md index f535bb13e7b..92846548d61 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name and the qubits. @@ -74,7 +74,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -90,7 +90,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.29/qiskit.transpiler.Layout.md index fd318dce9c7..5779fc5efcd 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.md index d60d3062ea4..cb1d29a7a49 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.md index 7a34b30ea18..873ce1041ac 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.md index 940178feedb..de3f9b579ed 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.md index 58f37fcce1f..0be91a42cf2 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.md index 6187572348c..96db165c737 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.md index 04921d4f0c9..f58225cdf00 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.md index 5834bbcf5ba..5593d2d9b55 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.md index bf869cf5632..3583d27a24b 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.md index fdea1c26f1a..6f3047aa15a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.md index 8dbbf1adade..c2205e3f5d4 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.md index 3148d827221..9806713ab21 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -72,7 +72,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 868cc99c318..43482e25d9e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.md index 90564fc4170..dfa0268fc81 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.md index 6d963211a62..86445d2fde4 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.md index 80c02cf7d65..e8f366aba3a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.md index 6f04b9e6248..845de2e0172 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.md index b525f3316e5..fea10b8596e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.md index c71de599680..b02406f2a5c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.md index 6a17860c54c..c3429160e40 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.md index 810eaa83cc7..3f997e25f37 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.md index 032e151ddc1..4613199f5dd 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.md index 744736cbc13..62187c78316 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.md index a72caa5131d..46a35082205 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.md index 51bec98a443..c16e9ab7a7b 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.md index 02a07d088d0..2debc209680 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.md index 4f9431bb37b..1353af5be91 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index b32c79c6cc3..a34f76b8aea 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.md index 997db28662b..f755a0f2838 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.md index 4ecd9af788b..b1631964fc6 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.md index 4821800c0d5..025e85f28f4 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.md index 718d92615bc..a7b067d0923 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.md index 9c0c24fee12..062c118d97e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.md index 96b031391e5..b83c7d3d2cb 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.md index 72a4c9337b5..43705a6217c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.md index 58f845efea2..991d31b3594 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.md index 75443220b25..695c133ed97 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.md index bd591642853..a68660bd460 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -52,7 +52,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.md index 526e67b3172..2de48decfaf 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.md index 3b941efdc17..8f08841bdd8 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.md index c5ef7c51fe2..290a38a2ea6 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 18b39f6de80..79baa69b039 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.md index bfb88eaa73f..a0e9be18885 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.md index a43c925315a..4c3e10a227e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 9f025335f64..deb8bd3bc0e 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 247952bd2a6..f4185c64073 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` @@ -32,7 +32,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -63,7 +63,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -109,7 +109,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.supported(node_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index d1e35d9d7f8..0dbf71a687f 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.md index e80b597cd86..761812a77ff 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index ea691cfcdcc..ebb876ce4cf 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.md index bd287fcc787..cd167884a17 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.md index d92c6ed6a1a..1a34098a35f 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.md index 43a1246b882..4ea822d5049 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.md index 24b02cd5d37..1ec7028a48f 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.md index 310f7e38d21..07d7ccb91d0 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.md index 088beac9622..46e6c9c2f34 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.md index e3518c917f1..07a891b44c3 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.md index e9a9ae62a6e..6653a09acf6 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.md index 44a16cd9703..131fb3ef24a 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.md index c6dc911389c..963a68b4426 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.md index b72a56d66a9..d4ea3debc8f 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.md index d55722e6613..1c3cf957287 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 691671212e0..7dd2a3d0438 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.md index c02d018eb79..86621524a00 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.md index a5078bb49fa..e33af21c9ea 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.md index f7e21cd7667..e5e1dddb35c 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index ce49450400a..e56210238e8 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 893991f1e1e..5fa14dacdf7 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 2a48a316b60..ad034c98bdb 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 67a6d205867..241fe8b08a2 100644 --- a/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.29/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.md index 328d57f775f..b36be637246 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.29/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -65,7 +65,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -85,7 +85,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -116,7 +116,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -136,7 +136,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -148,7 +148,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -156,7 +156,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :param circuits: circuits to transpile :type circuits: Union\[‘QuantumCircuit’, List\[‘QuantumCircuit’]] diff --git a/docs/api/qiskit/0.29/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.29/qiskit.utils.apply_prefix.md index 2017d1c6643..a28b67fdb37 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.29/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.29/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.29/qiskit.utils.deprecate_arguments.md index 8282d5f19c9..a828755849a 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.29/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.29/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.29/qiskit.utils.deprecate_function.md index 2b87a5fcc00..4f63f06df1f 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.29/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.29/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.29/qiskit.utils.get_entangler_map.md index 6cf74ea4af2..236fae021fb 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.29/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.29/qiskit.utils.has_aer.md b/docs/api/qiskit/0.29/qiskit.utils.has_aer.md index 189bf9bfc23..102a23afe92 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.29/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.29/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.29/qiskit.utils.has_ibmq.md index 60361543541..be11ff87ff7 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.29/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.29/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.29/qiskit.utils.is_main_process.md index fa2d188fc3a..0ea19e37f4f 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.29/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.29/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.29/qiskit.utils.local_hardware_info.md index 830ffd2cddc..3844e400dc4 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.29/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.29/qiskit.utils.name_args.md b/docs/api/qiskit/0.29/qiskit.utils.name_args.md index eaa2979d4a7..1b871d1ee39 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.29/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.29/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.29/qiskit.utils.summarize_circuits.md index a0271e0a592..80bf315381d 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.29/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.29/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.29/qiskit.utils.validate_entangler_map.md index 2b216c7bc49..88c3e19f384 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.29/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.md index c6da2a2e904..5bfb9a42a70 100644 --- a/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.29/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.29/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.29/qiskit.validation.jsonschema.validate_json_against_schema.md index 2a574f25167..0b6d588facc 100644 --- a/docs/api/qiskit/0.29/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.29/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.md index 019d0e86d97..cbd4a33b528 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.29/qiskit.visualization.array_to_latex.md index 6be62f03dfb..6168a0bbc64 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.29/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.29/qiskit.visualization.circuit_drawer.md index ad6bd36cf60..159a7a0d0d1 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.29/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.29/qiskit.visualization.dag_drawer.md index a2b2847a3b8..6316fbb8859 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.29/qiskit.visualization.pass_manager_drawer.md index df1f70d2634..06fff318385 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_multivector.md index 483e5efd5c9..970597c14fc 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_vector.md index a3dc0c1248a..24fd05ae2b7 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_circuit_layout.md index 4be31bd9d7f..cf411276ae3 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_error_map.md index 9a927ed60da..e2a5d54cba2 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_gate_map.md index 7ed85aa8810..752ab2f6abc 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_histogram.md index 5455ef2d569..02da7c28e69 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_city.md index e7bac085f20..d209fe48bed 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_hinton.md index df9b906024a..a3763720a94 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_paulivec.md index 52c1e0df9d5..d3622a5fecf 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_qsphere.md index 788fef80cb5..1acdcf7d7ce 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.md index e2d818293eb..8c96b29e9d7 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.md index 53ecd61a0b0..deb943eb89c 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.md index 808cab2e4eb..463ec5974fd 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.draw.md index 85009084afc..990ac3ddbea 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.md index ebc50613fb6..e29877e00b4 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.29/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.29/qiskit.visualization.timeline.draw.md index 3267603ec56..5192dc88671 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.29/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.29/qiskit.visualization.visualize_transition.md index f799d8cd91f..bdd0cdda636 100644 --- a/docs/api/qiskit/0.29/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.29/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From ae52afbd3b60d6ae92d0067cc7cce003a08dc43c Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:29:11 +0100 Subject: [PATCH 11/41] Regenerate qiskit 0.30.1 --- docs/api/qiskit/0.30/execute.md | 2 +- docs/api/qiskit/0.30/logging.md | 2 +- .../0.30/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.30/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.30/qiskit.algorithms.Grover.md | 8 +- .../0.30/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.30/qiskit.algorithms.HHL.md | 6 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- .../0.30/qiskit.algorithms.LinearSolver.md | 4 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.algorithms.NumPyLinearSolver.md | 4 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.30/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.30/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.30/qiskit.algorithms.Shor.md | 8 +- .../0.30/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.30/qiskit.algorithms.VQE.md | 20 +- .../0.30/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.30/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.30/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.30/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.30/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.30/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 6 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.30/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.30/qiskit.algorithms.optimizers.SPSA.md | 10 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- .../0.30/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.30/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.30/qiskit.aqua.QuantumInstance.md | 16 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 6 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 4 +- ...ua.algorithms.AmplitudeEstimationResult.md | 4 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 4 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 4 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 4 +- .../qiskit/0.30/qiskit.aqua.algorithms.EOH.md | 4 +- .../qiskit.aqua.algorithms.Eigensolver.md | 6 +- ...iskit.aqua.algorithms.EigensolverResult.md | 4 +- .../0.30/qiskit.aqua.algorithms.Grover.md | 10 +- .../qiskit.aqua.algorithms.GroverResult.md | 4 +- .../qiskit/0.30/qiskit.aqua.algorithms.HHL.md | 10 +- .../0.30/qiskit.aqua.algorithms.HHLResult.md | 4 +- .../0.30/qiskit.aqua.algorithms.IQPE.md | 6 +- ...algorithms.IterativeAmplitudeEstimation.md | 4 +- ...thms.IterativeAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.LinearsolverResult.md | 4 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 6 +- ...imumLikelihoodAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 6 +- ...qua.algorithms.MinimumEigensolverResult.md | 4 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 4 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.30/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.30/qiskit.aqua.algorithms.QGAN.md | 10 +- .../qiskit/0.30/qiskit.aqua.algorithms.QPE.md | 6 +- .../0.30/qiskit.aqua.algorithms.QSVM.md | 24 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 6 +- .../0.30/qiskit.aqua.algorithms.Shor.md | 6 +- .../0.30/qiskit.aqua.algorithms.Simon.md | 4 +- .../0.30/qiskit.aqua.algorithms.SklearnSVM.md | 12 +- .../qiskit/0.30/qiskit.aqua.algorithms.VQC.md | 24 +- .../qiskit/0.30/qiskit.aqua.algorithms.VQE.md | 18 +- .../qiskit/0.30/qiskit.aqua.circuits.CNF.md | 4 +- .../qiskit/0.30/qiskit.aqua.circuits.DNF.md | 4 +- .../qiskit/0.30/qiskit.aqua.circuits.ESOP.md | 4 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 4 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 4 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 10 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 10 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 8 +- ...aqua.components.feature_maps.FeatureMap.md | 8 +- ...omponents.feature_maps.RawFeatureVector.md | 4 +- ...t.aqua.components.initial_states.Custom.md | 4 +- ....components.initial_states.InitialState.md | 4 +- ....components.initial_states.VarFormBased.md | 4 +- ...kit.aqua.components.initial_states.Zero.md | 4 +- ...mponents.multiclass_extensions.AllPairs.md | 8 +- ...lticlass_extensions.ErrorCorrectingCode.md | 8 +- ...lticlass_extensions.MulticlassExtension.md | 10 +- ...ts.multiclass_extensions.OneAgainstRest.md | 8 +- ...s.neural_networks.DiscriminativeNetwork.md | 12 +- ...nents.neural_networks.GenerativeNetwork.md | 12 +- ...ents.neural_networks.NumPyDiscriminator.md | 14 +- ...ts.neural_networks.PyTorchDiscriminator.md | 16 +- ...onents.neural_networks.QuantumGenerator.md | 14 +- .../qiskit.aqua.components.optimizers.ADAM.md | 12 +- .../qiskit.aqua.components.optimizers.AQGD.md | 6 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 6 +- .../qiskit.aqua.components.optimizers.CG.md | 6 +- ...iskit.aqua.components.optimizers.COBYLA.md | 6 +- .../qiskit.aqua.components.optimizers.CRS.md | 4 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 4 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 4 +- .../qiskit.aqua.components.optimizers.ESCH.md | 4 +- .../qiskit.aqua.components.optimizers.GSLS.md | 14 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 6 +- ...qiskit.aqua.components.optimizers.ISRES.md | 4 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 6 +- ....aqua.components.optimizers.NELDER_MEAD.md | 6 +- .../qiskit.aqua.components.optimizers.NFT.md | 6 +- ...it.aqua.components.optimizers.Optimizer.md | 16 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 6 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 6 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 6 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 6 +- .../qiskit.aqua.components.optimizers.SPSA.md | 6 +- .../qiskit.aqua.components.optimizers.TNC.md | 6 +- ....components.oracles.CustomCircuitOracle.md | 4 +- ...ponents.oracles.LogicalExpressionOracle.md | 6 +- .../qiskit.aqua.components.oracles.Oracle.md | 4 +- ...qua.components.oracles.TruthTableOracle.md | 6 +- ...qua.components.reciprocals.LongDivision.md | 6 +- ...a.components.reciprocals.LookupRotation.md | 6 +- ....aqua.components.reciprocals.Reciprocal.md | 6 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 4 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 6 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 4 +- ...els.MultivariateVariationalDistribution.md | 6 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 4 +- ....uncertainty_models.UniformDistribution.md | 8 +- ...certainty_models.UnivariateDistribution.md | 6 +- ...odels.UnivariateVariationalDistribution.md | 6 +- ...ncertainty_problems.MultivariateProblem.md | 8 +- ...uncertainty_problems.UncertaintyProblem.md | 4 +- ...lems.UnivariatePiecewiseLinearObjective.md | 8 +- ....uncertainty_problems.UnivariateProblem.md | 8 +- ...nents.variational_forms.VariationalForm.md | 8 +- .../qiskit.aqua.operators.OperatorBase.md | 36 +-- ...qua.operators.converters.AbelianGrouper.md | 6 +- ...qua.operators.converters.CircuitSampler.md | 8 +- ...aqua.operators.converters.ConverterBase.md | 4 +- ...a.operators.converters.DictToCircuitSum.md | 4 +- ...a.operators.converters.PauliBasisChange.md | 22 +- ...aqua.operators.evolutions.EvolutionBase.md | 4 +- ...a.operators.evolutions.EvolutionFactory.md | 4 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 30 +-- ...ua.operators.evolutions.MatrixEvolution.md | 4 +- ...rators.evolutions.PauliTrotterEvolution.md | 8 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 4 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 4 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 4 +- ...rators.evolutions.TrotterizationFactory.md | 4 +- ...rators.expectations.AerPauliExpectation.md | 6 +- ....operators.expectations.CVaRExpectation.md | 6 +- ....operators.expectations.ExpectationBase.md | 6 +- ...erators.expectations.ExpectationFactory.md | 4 +- ...perators.expectations.MatrixExpectation.md | 6 +- ...operators.expectations.PauliExpectation.md | 6 +- ...qua.operators.gradients.CircuitGradient.md | 4 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 4 +- ...aqua.operators.gradients.DerivativeBase.md | 8 +- ...iskit.aqua.operators.gradients.Gradient.md | 6 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 6 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 4 +- .../qiskit.aqua.operators.gradients.QFI.md | 4 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 16 +- ...it.aqua.operators.legacy.MatrixOperator.md | 24 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 10 +- ....operators.legacy.WeightedPauliOperator.md | 50 ++--- ...skit.aqua.operators.legacy.Z2Symmetries.md | 14 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 14 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 46 ++-- ...qiskit.aqua.operators.list_ops.SummedOp.md | 18 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 10 +- ....aqua.operators.primitive_ops.CircuitOp.md | 30 +-- ...t.aqua.operators.primitive_ops.MatrixOp.md | 28 +-- ...it.aqua.operators.primitive_ops.PauliOp.md | 34 +-- ...qua.operators.primitive_ops.PrimitiveOp.md | 46 ++-- ...qua.operators.state_fns.CVaRMeasurement.md | 30 +-- ...aqua.operators.state_fns.CircuitStateFn.md | 36 +-- ...it.aqua.operators.state_fns.DictStateFn.md | 24 +- ...qua.operators.state_fns.OperatorStateFn.md | 24 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 40 ++-- ....aqua.operators.state_fns.VectorStateFn.md | 26 +-- .../0.30/qiskit.aqua.utils.CircuitFactory.md | 26 +-- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.30/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.30/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.30/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.30/qiskit.aqua.utils.name_args.md | 2 +- .../0.30/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.30/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.30/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.30/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.30/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.30/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.30/qiskit.assembler.disassemble.md | 2 +- .../0.30/qiskit.chemistry.BosonicOperator.md | 8 +- .../qiskit.chemistry.FermionicOperator.md | 18 +- .../qiskit/0.30/qiskit.chemistry.MP2Info.md | 6 +- .../qiskit/0.30/qiskit.chemistry.QMolecule.md | 24 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 6 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 4 +- ...chemistry.algorithms.EigensolverFactory.md | 4 +- ...try.algorithms.ExcitedStatesEigensolver.md | 4 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 4 +- ...istry.algorithms.GroundStateEigensolver.md | 8 +- ....chemistry.algorithms.GroundStateSolver.md | 8 +- ...ry.algorithms.MinimumEigensolverFactory.md | 6 +- ...stry.algorithms.NumPyEigensolverFactory.md | 4 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 6 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 6 +- .../0.30/qiskit.chemistry.algorithms.QEOM.md | 4 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 8 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 6 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 6 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 4 +- ...s.pes_samplers.DifferentialExtrapolator.md | 4 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 12 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 12 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 6 +- ...gorithms.pes_samplers.HarmonicPotential.md | 24 +- ....algorithms.pes_samplers.MorsePotential.md | 24 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 4 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 4 +- ...y.algorithms.pes_samplers.PotentialBase.md | 8 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 4 +- ...thms.pes_samplers.VibronicStructureBase.md | 10 +- ...orithms.pes_samplers.WindowExtrapolator.md | 4 +- ...applications.MolecularGroundStateEnergy.md | 6 +- ...y.components.bosonic_bases.BosonicBasis.md | 4 +- ....components.bosonic_bases.HarmonicBasis.md | 4 +- ...y.components.initial_states.HartreeFock.md | 4 +- ...hemistry.components.initial_states.VSCF.md | 4 +- ...mistry.components.variational_forms.CHC.md | 4 +- ...stry.components.variational_forms.UCCSD.md | 22 +- ...istry.components.variational_forms.UVCC.md | 8 +- ...qiskit.chemistry.core.ChemistryOperator.md | 6 +- .../0.30/qiskit.chemistry.core.Hamiltonian.md | 4 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 6 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 4 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 6 +- ...iskit.chemistry.drivers.FermionicDriver.md | 4 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 4 +- ....chemistry.drivers.GaussianForcesDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogResult.md | 4 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 4 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.30/qiskit.chemistry.drivers.Molecule.md | 14 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 4 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 4 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 4 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 4 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 6 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 10 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 10 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 10 +- .../0.30/qiskit.circuit.AncillaQubit.md | 2 +- .../0.30/qiskit.circuit.AncillaRegister.md | 2 +- .../0.30/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.30/qiskit.circuit.Clbit.md | 2 +- .../0.30/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.30/qiskit.circuit.Delay.md | 12 +- .../0.30/qiskit.circuit.EquivalenceLibrary.md | 12 +- docs/api/qiskit/0.30/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.30/qiskit.circuit.Instruction.md | 28 +-- .../0.30/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.30/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.30/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 30 +-- .../0.30/qiskit.circuit.ParameterVector.md | 6 +- .../0.30/qiskit.circuit.QuantumCircuit.md | 206 +++++++++--------- .../0.30/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.30/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.30/qiskit.circuit.Reset.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.AND.md | 2 +- .../0.30/qiskit.circuit.library.Barrier.md | 8 +- .../0.30/qiskit.circuit.library.C3SXGate.md | 4 +- .../0.30/qiskit.circuit.library.C3XGate.md | 6 +- .../0.30/qiskit.circuit.library.C4XGate.md | 6 +- .../0.30/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.30/qiskit.circuit.library.CHGate.md | 4 +- .../0.30/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.30/qiskit.circuit.library.CRXGate.md | 4 +- .../0.30/qiskit.circuit.library.CRYGate.md | 4 +- .../0.30/qiskit.circuit.library.CRZGate.md | 4 +- .../0.30/qiskit.circuit.library.CSXGate.md | 2 +- .../0.30/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.30/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.30/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.30/qiskit.circuit.library.CUGate.md | 4 +- .../0.30/qiskit.circuit.library.CXGate.md | 6 +- .../0.30/qiskit.circuit.library.CYGate.md | 4 +- .../0.30/qiskit.circuit.library.CZGate.md | 4 +- .../0.30/qiskit.circuit.library.DCXGate.md | 2 +- .../0.30/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.30/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.GRZ.md | 2 +- .../0.30/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.30/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.30/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.30/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.30/qiskit.circuit.library.MCMT.md | 6 +- .../0.30/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.30/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.30/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.30/qiskit.circuit.library.MSGate.md | 2 +- .../0.30/qiskit.circuit.library.Measure.md | 4 +- .../0.30/qiskit.circuit.library.NLocal.md | 12 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.30/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.30/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.30/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.30/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.30/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.30/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.30/qiskit.circuit.library.RGate.md | 4 +- .../0.30/qiskit.circuit.library.RVGate.md | 6 +- .../0.30/qiskit.circuit.library.RXGate.md | 6 +- .../0.30/qiskit.circuit.library.RXXGate.md | 4 +- .../0.30/qiskit.circuit.library.RYGate.md | 6 +- .../0.30/qiskit.circuit.library.RYYGate.md | 4 +- .../0.30/qiskit.circuit.library.RZGate.md | 6 +- .../0.30/qiskit.circuit.library.RZXGate.md | 4 +- .../0.30/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.30/qiskit.circuit.library.Reset.md | 4 +- .../0.30/qiskit.circuit.library.SGate.md | 4 +- .../0.30/qiskit.circuit.library.SXGate.md | 6 +- .../0.30/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.30/qiskit.circuit.library.SdgGate.md | 4 +- .../0.30/qiskit.circuit.library.SwapGate.md | 6 +- .../0.30/qiskit.circuit.library.TGate.md | 4 +- .../0.30/qiskit.circuit.library.TdgGate.md | 4 +- .../0.30/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.30/qiskit.circuit.library.U1Gate.md | 6 +- .../0.30/qiskit.circuit.library.U2Gate.md | 4 +- .../0.30/qiskit.circuit.library.U3Gate.md | 6 +- .../0.30/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.UniformDistribution.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.30/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.30/qiskit.circuit.library.XOR.md | 2 +- .../0.30/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.30/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.30/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.30/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.30/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.30/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.30/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.30/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.30/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.qpy_serialization.dump.md | 2 +- .../qiskit.circuit.qpy_serialization.load.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.30/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.30/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.30/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.30/qiskit.compiler.transpile.md | 2 +- .../0.30/qiskit.converters.ast_to_dag.md | 2 +- .../0.30/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.30/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.30/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.30/qiskit.dagcircuit.DAGCircuit.md | 126 +++++------ .../0.30/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.30/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.30/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../qiskit/0.30/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.30/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.30/qiskit.extensions.Initialize.md | 8 +- .../qiskit/0.30/qiskit.extensions.Snapshot.md | 8 +- .../0.30/qiskit.extensions.UnitaryGate.md | 16 +- .../0.30/qiskit.finance.QiskitFinanceError.md | 2 +- ....uncertainty_problems.EuropeanCallDelta.md | 8 +- ...inty_problems.EuropeanCallExpectedValue.md | 8 +- ...ainty_problems.FixedIncomeExpectedValue.md | 10 +- ...finance.data_providers.BaseDataProvider.md | 16 +- ...nce.data_providers.DataOnDemandProvider.md | 4 +- ...nce.data_providers.ExchangeDataProvider.md | 4 +- ...nance.data_providers.RandomDataProvider.md | 4 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 4 +- ...inance.data_providers.YahooDataProvider.md | 4 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.30/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.30/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 6 +- .../0.30/qiskit.ignis.verification.BConfig.md | 18 +- .../qiskit.ignis.verification.CNOTDihedral.md | 34 +-- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.30/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.30/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 6 +- .../0.30/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.30/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.30/qiskit.ml.datasets.digits.md | 2 +- .../0.30/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.30/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.30/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.30/qiskit.opflow.OperatorBase.md | 40 ++-- .../qiskit/0.30/qiskit.opflow.OpflowError.md | 2 +- .../0.30/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.30/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.30/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.30/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.30/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.30/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.30/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.30/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 4 +- .../0.30/qiskit.opflow.gradients.QFI.md | 4 +- .../0.30/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.30/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.30/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.30/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.30/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +-- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 38 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +-- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.30/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +-- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 76 +++---- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 6 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 6 +- ....optimization.algorithms.CplexOptimizer.md | 8 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 6 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 4 +- ...zation.algorithms.MinimumEigenOptimizer.md | 6 +- ...mization.algorithms.MultiStartOptimizer.md | 4 +- ...zation.algorithms.OptimizationAlgorithm.md | 8 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 6 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 6 +- ....optimization.algorithms.SolutionSample.md | 2 +- ...ization.converters.InequalityToEquality.md | 6 +- ...optimization.converters.IntegerToBinary.md | 6 +- ...tion.converters.LinearEqualityToPenalty.md | 6 +- ...on.converters.QuadraticProgramConverter.md | 6 +- ...ation.converters.QuadraticProgramToQubo.md | 10 +- ...qiskit.optimization.problems.Constraint.md | 4 +- ....optimization.problems.LinearConstraint.md | 4 +- ....optimization.problems.LinearExpression.md | 10 +- ...timization.problems.QuadraticConstraint.md | 4 +- ...timization.problems.QuadraticExpression.md | 10 +- ...ptimization.problems.QuadraticObjective.md | 6 +- ....optimization.problems.QuadraticProgram.md | 76 +++---- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 4 +- .../qiskit/0.30/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.30/qiskit.providers.BackendV1.md | 16 +- .../0.30/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.30/qiskit.providers.BaseJob.md | 24 +- .../0.30/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.30/qiskit.providers.Job.md | 2 +- .../qiskit/0.30/qiskit.providers.JobError.md | 2 +- .../qiskit/0.30/qiskit.providers.JobStatus.md | 2 +- .../0.30/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.30/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.30/qiskit.providers.Options.md | 6 +- .../qiskit/0.30/qiskit.providers.Provider.md | 2 +- .../0.30/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.30/qiskit.providers.aer.AerError.md | 2 +- .../0.30/qiskit.providers.aer.AerProvider.md | 6 +- .../0.30/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.30/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 28 +-- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.30/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 10 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.30/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.30/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.30/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.30/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...skit.providers.ibmq.random.CQCExtractor.md | 10 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 6 +- ...providers.ibmq.random.IBMQRandomService.md | 6 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 24 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.30/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.30/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- docs/api/qiskit/0.30/qiskit.pulse.Acquire.md | 4 +- .../0.30/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.30/qiskit.pulse.Call.md | 8 +- docs/api/qiskit/0.30/qiskit.pulse.Constant.md | 6 +- .../0.30/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.30/qiskit.pulse.Delay.md | 4 +- docs/api/qiskit/0.30/qiskit.pulse.Drag.md | 6 +- .../qiskit/0.30/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.30/qiskit.pulse.Gaussian.md | 6 +- .../0.30/qiskit.pulse.GaussianSquare.md | 6 +- .../qiskit/0.30/qiskit.pulse.Instruction.md | 22 +- .../qiskit.pulse.InstructionScheduleMap.md | 20 +- .../0.30/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.30/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.30/qiskit.pulse.Play.md | 6 +- .../qiskit/0.30/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.30/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.30/qiskit.pulse.Schedule.md | 30 +-- .../qiskit/0.30/qiskit.pulse.ScheduleBlock.md | 30 +-- .../qiskit/0.30/qiskit.pulse.SetFrequency.md | 4 +- docs/api/qiskit/0.30/qiskit.pulse.SetPhase.md | 4 +- .../0.30/qiskit.pulse.ShiftFrequency.md | 4 +- .../qiskit/0.30/qiskit.pulse.ShiftPhase.md | 4 +- docs/api/qiskit/0.30/qiskit.pulse.Snapshot.md | 4 +- docs/api/qiskit/0.30/qiskit.pulse.Waveform.md | 6 +- .../0.30/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.30/qiskit.pulse.builder.align_func.md | 2 +- .../0.30/qiskit.pulse.builder.align_left.md | 2 +- .../0.30/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.30/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.delay.md | 2 +- .../0.30/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.30/qiskit.pulse.builder.inline.md | 2 +- .../0.30/qiskit.pulse.builder.measure.md | 2 +- .../0.30/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.30/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.pad.md | 2 +- .../0.30/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.30/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.30/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.30/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.30/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.30/qiskit.pulse.builder.x.md | 2 +- .../0.30/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.30/qiskit.pulse.instructions.Call.md | 8 +- .../0.30/qiskit.pulse.instructions.Delay.md | 4 +- .../qiskit.pulse.instructions.Instruction.md | 22 +- .../0.30/qiskit.pulse.instructions.Play.md | 6 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.30/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.30/qiskit.pulse.library.Drag.md | 6 +- .../0.30/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.30/qiskit.pulse.library.Waveform.md | 6 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.30/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.30/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.30/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.30/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.30/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.30/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.30/qiskit.qobj.GateCalibration.md | 6 +- .../0.30/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.md | 6 +- .../0.30/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.30/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.30/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.30/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.30/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.30/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.30/qiskit.qobj.Qobj.md | 2 +- .../0.30/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.30/qiskit.qobj.QobjHeader.md | 2 +- .../0.30/qiskit.qobj.QobjMeasurementOption.md | 6 +- .../0.30/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.30/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.30/qiskit.quantum_info.Choi.md | 12 +- .../0.30/qiskit.quantum_info.Clifford.md | 32 +-- .../0.30/qiskit.quantum_info.DensityMatrix.md | 38 ++-- .../qiskit/0.30/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.30/qiskit.quantum_info.Operator.md | 26 +-- .../qiskit/0.30/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.30/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.30/qiskit.quantum_info.PauliList.md | 50 ++--- .../0.30/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.30/qiskit.quantum_info.Quaternion.md | 14 +- .../0.30/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.30/qiskit.quantum_info.SparsePauliOp.md | 32 +-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.30/qiskit.quantum_info.Statevector.md | 38 ++-- .../0.30/qiskit.quantum_info.Stinespring.md | 14 +- .../0.30/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.30/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.30/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.30/qiskit.quantum_info.entropy.md | 2 +- .../0.30/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.30/qiskit.quantum_info.partial_trace.md | 2 +- .../0.30/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.30/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.30/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.30/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.30/qiskit.result.Counts.md | 8 +- .../0.30/qiskit.result.ProbDistribution.md | 6 +- .../0.30/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.30/qiskit.result.Result.md | 16 +- .../qiskit/0.30/qiskit.result.ResultError.md | 2 +- .../0.30/qiskit.result.marginal_counts.md | 2 +- .../0.30/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.30/qiskit.tools.backend_monitor.md | 2 +- .../0.30/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.30/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.30/qiskit.tools.parallel_map.md | 2 +- .../0.30/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.30/qiskit.transpiler.CouplingMap.md | 36 +-- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.30/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- .../qiskit/0.30/qiskit.transpiler.Layout.md | 30 +-- .../0.30/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.30/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.30/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.30/qiskit.transpiler.passes.CheckMap.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- .../0.30/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.30/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.30/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.30/qiskit.transpiler.passes.Unroller.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.30/qiskit.transpiler.passes.Width.md | 4 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.30/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.30/qiskit.utils.apply_prefix.md | 2 +- .../0.30/qiskit.utils.deprecate_arguments.md | 2 +- .../0.30/qiskit.utils.deprecate_function.md | 2 +- .../0.30/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.30/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.30/qiskit.utils.has_ibmq.md | 2 +- .../0.30/qiskit.utils.is_main_process.md | 2 +- .../0.30/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.30/qiskit.utils.name_args.md | 2 +- .../0.30/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.30/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1218 files changed, 3890 insertions(+), 3890 deletions(-) diff --git a/docs/api/qiskit/0.30/execute.md b/docs/api/qiskit/0.30/execute.md index 8755b9240c2..3b45799405a 100644 --- a/docs/api/qiskit/0.30/execute.md +++ b/docs/api/qiskit/0.30/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.30/logging.md b/docs/api/qiskit/0.30/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.30/logging.md +++ b/docs/api/qiskit/0.30/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.md index 8ca3e9ac38e..70247e04092 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.md index eda68be3b99..05f5a8abf08 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.md index 8b58f5f16f7..a35b05d675b 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.md index 0ea6cb88896..6a34c5b5e0d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.md index bd82b5983d1..c3d0fd6bca9 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.md index d9fbb41272f..850ab74790c 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.md index a7d3692f34c..d543bb3f8af 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.md index 9e8af705568..54f056bb323 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.md index 0fa85780d22..e4c1693fee6 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.md index 64a52fe413b..b43b87c52ae 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7e80483cdc3..13261c39680 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.30/qiskit.algorithms.Grover.md index 09619cab3ad..66afc42fcbf 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -109,7 +109,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -135,7 +135,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.md index 0d3262e9fe5..546a9de563a 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.30/qiskit.algorithms.HHL.md index 7b070d712b6..a58db83d55d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -88,7 +88,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4d3d66e1511..ff05137ad29 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index ffd8680ce2a..dac975d8447 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.md index 4e0525435b7..c1a5caaf0a8 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 786a28ca73f..cc26a05cb50 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.md index 734f5435191..9a5338b4e40 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.md index b467025bb12..95cc165d6df 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.md index e94e8c97d93..6bdc92cbd2d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 672d1632cf8..9b52579c968 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index a4549d470bf..07d3d3a29bb 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.md index 1fa59d6cbab..6efe690ec1c 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.md index 434d8f1b250..f461d953178 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.md index 9bbfcc4d1e1..53d3a4858fc 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.md index 40aedeb0213..94ac1589c69 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.md index a468cd4132d..6ac7e2745a0 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.md index 5646cc39b02..828dc7a48c8 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.md index 9b7c64c8742..8264f0cdd4d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.md index 6b02367ef38..0607e4db3f0 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.md index 3b6a7acc155..d4d3337a5a8 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.30/qiskit.algorithms.Shor.md index 943abc13d66..d02bc90d794 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.md index 301ee26f92b..aadac8890b7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.30/qiskit.algorithms.VQE.md index 85c5f13cd0b..ae0803868a7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -51,7 +51,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -93,7 +93,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -148,7 +148,7 @@ dict -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -175,7 +175,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -187,7 +187,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -199,7 +199,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -227,7 +227,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -243,7 +243,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.md index 91320d37127..67bde1016da 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -121,7 +121,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -159,7 +159,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.md index 9eb6256f9ba..72f65b1b1c7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.md index 6db1b85881e..36824db4a70 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.md index e4899ab96e1..fd95ce853d8 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.md index 85f09e4e59c..55db3a940b3 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.md index f52e1dd72f6..7fee2cbbfb1 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.md index dccc95dd453..8f7466e1deb 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5a424cb5965..5ef96d11579 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.md index d6e70b8e91a..e3a883d3222 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.md index 8f47f9e5d2c..f1bae1797c3 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -172,7 +172,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -196,7 +196,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.md index 3932cff062c..a6b80c6390f 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.md index 499edc4598c..0b65a1220ed 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.md index c3a40820c6b..d9140d08e01 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.md index 7da978ade93..3a2c93d82f2 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.md index f24e582865f..89b376cb8a7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.md index cce399c08cb..8613db5a039 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.md index f3e2efd0371..8aa53bca58d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 948f5158c5f..980594e2fe5 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.md index 2e38bcf0b6a..2107f37d0c3 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.md index 98dd1037f06..4837f9b9422 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.md index 01e413fbba3..4d0e65b0ebf 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -123,7 +123,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.md index a630c804619..30a2c283d1d 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.md index 3f7ed381506..86c66895db7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.md index a5555c44b15..30993b5e0fa 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -101,7 +101,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -136,7 +136,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -148,7 +148,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -179,7 +179,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.md index 72a75110049..6de668be969 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.md index 1f76b2e70b7..559898217d7 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.30/qiskit.aqua.AquaError.md index c2c87a14da5..b4579f16ed6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.md index a6654a15886..ae091b23fe5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.md index 4b2f505ac55..604dfb78a3a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") assemble circuits @@ -64,7 +64,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -84,7 +84,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -109,7 +109,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -129,7 +129,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Reset execution results @@ -141,7 +141,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -149,7 +149,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :type circuits: `Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]] :param circuits: circuits to transpile diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.md index b10e0ebc8ca..ccb94b46591 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -56,7 +56,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -82,7 +82,7 @@ The (1 - alpha) confidence interval of the specified kind. -`AmplitudeEstimation.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 2a74e74f268..0111c5beb77 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 214b669ba8c..9c38c01fbd8 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.md index bdf6a6a2030..1f8bd38fd94 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -29,7 +29,7 @@ The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jo -`BernsteinVazirani.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 3a85fe02cfa..d471a48f4d1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for Classical Algorithms. -`ClassicalAlgorithm.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Execute the classical algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.md index f5ad0c57f4e..b2d1ddbef94 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.md index 40b26aa0800..8a4fe2dbd30 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`DeutschJozsa.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.md index 6005a5c125b..ac96edbb4e6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -35,7 +35,7 @@ EOH provides the lower-level building blocks for simulating universal quantum sy -`EOH.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.md index 36a981429d0..c135dc4ece6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.md index 03e2bee0c4e..5fd16785333 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static EigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`static EigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.md index 05f0ff863d5..206dce3fd08 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -100,7 +100,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.construct_circuit(power=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(power=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -121,7 +121,7 @@ the QuantumCircuit object for the constructed circuit -`Grover.is_good_state(bitstr)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.is_good_state(bitstr)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Check whether a provided bitstring is a good state or not. @@ -141,7 +141,7 @@ True if the measurement is a good state, False otherwise. -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. @@ -162,7 +162,7 @@ The optimal number of iterations for Grover’s algorithm to succeed. -`Grover.post_processing(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.post_processing(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Do the post-processing to the measurement result diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.md index 27e2ed48c8b..0621bf4ee5e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static GroverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static GroverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.md index 104509eb4dc..3d4e71cd17c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -61,7 +61,7 @@ See also [https://arxiv.org/abs/0811.3171](https://arxiv.org/abs/0811.3171) -`HHL.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -81,7 +81,7 @@ the QuantumCircuit object for the constructed circuit -`static HHL.expand_to_hermitian(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_hermitian(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. @@ -102,7 +102,7 @@ the expanded matrix, the expanded vector -`static HHL.expand_to_powerdim(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_powerdim(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. @@ -123,7 +123,7 @@ the expanded matrix, the expanded vector -`static HHL.matrix_resize(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.matrix_resize(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Resizes matrix if necessary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.md index bacb695ea73..14d8c1fa1a3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static HHLResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHLResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.md index 2acf9246296..3ec9bf228b6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -41,7 +41,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -62,7 +62,7 @@ MinimumEigensolverResult -`IQPE.construct_circuit(k=None, omega=0, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.construct_circuit(k=None, omega=0, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index f55ec87a6b6..b41888a8ef7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -58,7 +58,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Construct the circuit Q^k A |0>. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index 46017326c36..ece986b79ca 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static IterativeAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`static IterativeAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.md index f9932eafc75..579de6c101c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static LinearsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`static LinearsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index d2fa6b6ec8f..bfe70b347c7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -47,7 +47,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -75,7 +75,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 834bf66fa9f..98c4ae01b1b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.md index 113932d3d9f..0e6660fc029 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.md index e69567d581a..a0a2e3e8146 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MinimumEigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`static MinimumEigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.md index abaf7014801..14fb63b3ae9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ dict -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.md index 869a22babd1..e82deb99e27 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 48320e33e2d..325dc0c2e7b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static NumPyLSsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`static NumPyLSsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index 7e31abd12a8..e9e0330c118 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -28,7 +28,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -65,7 +65,7 @@ dict -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.md index c76832ae833..567c8be2c20 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.md index cba3dfb07e5..9cdb44a756c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -52,7 +52,7 @@ These networks are trained in alternating optimization steps, where the discrimi -`QGAN.get_rel_entr()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.get_rel_entr()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Get relative entropy between target and trained distribution @@ -101,7 +101,7 @@ Sets backend with configuration. -`QGAN.set_discriminator(discriminator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_discriminator(discriminator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize discriminator. @@ -113,7 +113,7 @@ Initialize discriminator. -`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize generator. @@ -132,7 +132,7 @@ Initialize generator. -`QGAN.train()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.train()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Train the qGAN diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.md index 7cd80d2324f..b59e0f51ace 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -36,7 +36,7 @@ QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two -`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -57,7 +57,7 @@ MinimumEigensolverResult -`QPE.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.md index ecf1e8d533a..3dd3054fa81 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/1804.11326](https://arxiv.org/abs/1804.11326) -`QSVM.construct_circuit(x1, x2, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_circuit(x1, x2, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Generate inner product of x1 and x2 with the given feature map. @@ -68,7 +68,7 @@ constructed circuit -`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -98,7 +98,7 @@ numpy.ndarray -`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -126,7 +126,7 @@ numpy.ndarray -`QSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Load a model from a file path. @@ -138,7 +138,7 @@ Load a model from a file path. -`QSVM.predict(data, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.predict(data, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Predict using the svm. @@ -188,7 +188,7 @@ dict -`QSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Save the model to a file path. @@ -212,7 +212,7 @@ Sets backend with configuration. -`QSVM.setup_datapoint(datapoints)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_datapoint(datapoints)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup data points, if the data were there, they would be overwritten. @@ -224,7 +224,7 @@ Setup data points, if the data were there, they would be overwritten. -`QSVM.setup_test_data(test_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_test_data(test_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup test data, if the data were there, they would be overwritten. @@ -236,7 +236,7 @@ Setup test data, if the data were there, they would be overwritten. -`QSVM.setup_training_data(training_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_training_data(training_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup training data, if the data were there, they would be overwritten. @@ -248,7 +248,7 @@ Setup training data, if the data were there, they would be overwritten. -`QSVM.test(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.test(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Test the svm. @@ -274,7 +274,7 @@ float -`QSVM.train(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.train(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Train the svm. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.md index 6469b629d9f..1b4df2b01a5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`QuantumAlgorithm.run(quantum_instance=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.run(quantum_instance=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Execute the algorithm with selected backend. @@ -49,7 +49,7 @@ dict -`QuantumAlgorithm.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.md index 906bf8324e1..c70d9dd55e0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Construct circuit. @@ -64,7 +64,7 @@ Quantum circuit. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.md index 468f6eedbaf..a664949467d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`Simon.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.md index 114b49cd1b4..ea286eea4e7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` @@ -38,7 +38,7 @@ Internally, this algorithm will run the binary classification or multiclass clas -`SklearnSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Load a model from a file path. @@ -50,7 +50,7 @@ Load a model from a file path. -`SklearnSVM.predict(data)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.predict(data)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Predict using the SVM @@ -86,7 +86,7 @@ dict -`SklearnSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Save the model to a file path. @@ -98,7 +98,7 @@ Save the model to a file path. -`SklearnSVM.test(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.test(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Test the SVM @@ -119,7 +119,7 @@ float -`SklearnSVM.train(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.train(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Train the SVM diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.md index 17badab47c3..5b669ef12f5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -50,7 +50,7 @@ Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), -`VQC.batch_data(data, labels=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.batch_data(data, labels=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") batch data @@ -66,7 +66,7 @@ set parameterized circuits to None -`VQC.construct_circuit(x, theta, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.construct_circuit(x, theta, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Construct circuit based on data and parameters in variational form. @@ -120,7 +120,7 @@ dict -`VQC.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal circuit @@ -128,7 +128,7 @@ get optimal circuit -`VQC.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal cost @@ -136,7 +136,7 @@ get optimal cost -`VQC.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal vector @@ -160,7 +160,7 @@ get probabilities for counts -`VQC.is_gradient_really_supported()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.is_gradient_really_supported()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") returns is gradient really supported @@ -168,7 +168,7 @@ returns is gradient really supported -`VQC.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") load model @@ -176,7 +176,7 @@ load model -`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data. @@ -224,7 +224,7 @@ dict -`VQC.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") save model @@ -244,7 +244,7 @@ Sets backend with configuration. -`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data, and test against with ground truth labels. @@ -268,7 +268,7 @@ float -`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Train the models, and save results. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.md index 177f46fdf74..ec982849070 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -56,7 +56,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -77,7 +77,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -97,7 +97,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -149,7 +149,7 @@ dict -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -161,7 +161,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -173,7 +173,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -201,7 +201,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -254,7 +254,7 @@ Sets backend with configuration. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.md index 48fc6aa2731..f96e6e94ef1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.md index f45e1493fbd..55ada47cc05 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.md index cf2e01fee26..10d86130fc8 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 9b19c13d7f0..988178c03dc 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Quantum Phase Estimation Circuit. -`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Construct the Phase Estimation circuit diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.md index b93db01a246..51752d3e454 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Constructor. -`StateVectorCircuit.construct_circuit(circuit=None, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit.construct_circuit(circuit=None, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Construct the circuit representing the desired state vector. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.md index f03b31602d8..53f485efc6f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -35,7 +35,7 @@ Computes the weighted sum controlled by state qubits -`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`static WeightedSumOperator.get_required_sum_qubits(weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`static WeightedSumOperator.get_required_sum_qubits(weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") get required sum qubits @@ -152,7 +152,7 @@ get required sum qubits -`WeightedSumOperator.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") required ancillas @@ -160,7 +160,7 @@ required ancillas -`WeightedSumOperator.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.md index a33e8c8187a..e0c4d55bcfe 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Eigenvalues.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the eigenvalue estimation quantum circuit. @@ -49,7 +49,7 @@ object for the eigenvalue estimation circuit. -`Eigenvalues.construct_inverse(mode, circuit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues.construct_inverse(mode, circuit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the inverse eigenvalue estimation quantum circuit. @@ -77,7 +77,7 @@ circuit. -`abstract Eigenvalues.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get register sizes @@ -85,7 +85,7 @@ get register sizes -`abstract Eigenvalues.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get scaling diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.md index 2e3a140aed7..c5b9e1d0c41 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` @@ -36,7 +36,7 @@ Specifically, this class is based on PhaseEstimationCircuit with no measurements -`EigsQPE.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Construct the eigenvalues estimation using the PhaseEstimationCircuit @@ -89,7 +89,7 @@ circuit. -`EigsQPE.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get register sizes @@ -97,7 +97,7 @@ get register sizes -`EigsQPE.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get scaling diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.md index 0cbf5d6c13b..9319bd9c2eb 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Construct the variational form, given its parameters. @@ -46,7 +46,7 @@ a quantum circuit. -`static FeatureMap.get_entangler_map(map_type, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.get_entangler_map(map_type, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") get entangle map @@ -54,7 +54,7 @@ get entangle map -`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 409c3da2478..bb3b603b8a6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` @@ -28,7 +28,7 @@ The Raw Feature Vector can be directly used as a feature map, where the raw feat -`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Construct the second order expansion based on given data. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.md index 4517c472243..57ae062836a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -43,7 +43,7 @@ The custom initial state will be set from the *circuit*, the *state\_vector*, or -`Custom.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.md index c73507555a2..8cd086c95d1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract InitialState.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`abstract InitialState.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.md index e35c15f2541..04386860f9f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutoria -`VarFormBased.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.md index 2e66ab01606..b37e7959a31 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ This is suitable for those situations in which the all-zeros state is the desire -`Zero.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.md index 4e56d2102d5..9cbddbab79c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a -`AllPairs.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`AllPairs.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`AllPairs.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 603a21c221f..92f4f3b54bb 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -38,7 +38,7 @@ The table above shows a 6-bit ECC for a 3-class problem. Each class is assigned -`ErrorCorrectingCode.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Applying multiple estimators for prediction. @@ -70,7 +70,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`ErrorCorrectingCode.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -91,7 +91,7 @@ float -`ErrorCorrectingCode.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 4e5bfee3b20..c58a47d8259 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract MulticlassExtension.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Applying multiple estimators for prediction. @@ -36,7 +36,7 @@ Applying multiple estimators for prediction. -`MulticlassExtension.set_estimator(estimator_cls, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension.set_estimator(estimator_cls, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Called internally to set `Estimator` and parameters :type estimator\_cls: `Callable`\[\[`List`], `Estimator`] :param estimator\_cls: An `Estimator` class :type params: `Optional`\[`List`] :param params: Parameters for the estimator @@ -48,7 +48,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`abstract MulticlassExtension.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -61,7 +61,7 @@ Testing multiple estimators each for distinguishing a pair of classes. -`abstract MulticlassExtension.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99912cbdeaa..5746e6c21ed 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM cla -`OneAgainstRest.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`OneAgainstRest.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`OneAgainstRest.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index 8598a8a962c..27dff35e801 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module but raise an exception if a required co -`abstract DiscriminativeNetwork.get_label(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.get_label(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Apply quantum/classical neural network to the given input sample and compute the respective data label @@ -40,7 +40,7 @@ Apply quantum/classical neural network to the given input sample and compute the -`abstract DiscriminativeNetwork.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Loss function used for optimization @@ -62,7 +62,7 @@ Loss w\.r.t to the generated data points. -`abstract DiscriminativeNetwork.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Save discriminator model @@ -78,7 +78,7 @@ Save discriminator model -`abstract DiscriminativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Set seed. @@ -94,7 +94,7 @@ Set seed. -`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 87525ae962a..5cafb9ee98b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module, but raise an exception if a required c -`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Apply quantum/classical neural network to given input and get the respective output @@ -46,7 +46,7 @@ Neural network output -`abstract GenerativeNetwork.loss()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.loss()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Loss function used for optimization @@ -54,7 +54,7 @@ Loss function used for optimization -`abstract GenerativeNetwork.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set discriminator network. @@ -70,7 +70,7 @@ Set discriminator network. -`abstract GenerativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set seed. @@ -86,7 +86,7 @@ Set seed. -`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 508e3037633..51189161446 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -27,7 +27,7 @@ Discriminator based on NumPy -`NumPyDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -48,7 +48,7 @@ numpy.ndarray -`NumPyDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Load discriminator model @@ -60,7 +60,7 @@ Load discriminator model -`NumPyDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Loss function :param x: sample label (equivalent to discriminator output) :type x: numpy.ndarray :param y: target label :type y: numpy.ndarray :param weights: customized scaling for each sample (optional) :type weights: numpy.ndarray @@ -76,7 +76,7 @@ float -`NumPyDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Save discriminator model @@ -88,7 +88,7 @@ Save discriminator model -`NumPyDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Set seed. :param seed: seed :type seed: int @@ -96,7 +96,7 @@ Set seed. :param seed: seed :type seed: int -`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index 914d5fad9e0..09ec0d6fa91 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -31,7 +31,7 @@ Discriminator based on PyTorch -`PyTorchDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -52,7 +52,7 @@ torch.Tensor -`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Compute gradient penalty for discriminator optimization @@ -75,7 +75,7 @@ torch.Tensor -`PyTorchDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Load discriminator model @@ -87,7 +87,7 @@ Load discriminator model -`PyTorchDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Loss function @@ -109,7 +109,7 @@ torch.Tensor -`PyTorchDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Save discriminator model @@ -121,7 +121,7 @@ Save discriminator model -`PyTorchDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 11da90e6808..5b063c0b256 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` @@ -38,7 +38,7 @@ The quantum generator is a parametrized quantum circuit which can be trained wit -`QuantumGenerator.construct_circuit(params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.construct_circuit(params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Construct generator circuit. @@ -58,7 +58,7 @@ construct the quantum circuit and return as gate -`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Get classical data samples from the generator. Running the quantum generator circuit results in a quantum state. To train this generator with a classical discriminator, we need to sample classical outputs by measuring the quantum state and mapping them to feature space defined by the training data. @@ -80,7 +80,7 @@ list -`QuantumGenerator.loss(x, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.loss(x, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Loss function for training the generator’s parameters. @@ -101,7 +101,7 @@ float -`QuantumGenerator.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set discriminator network. @@ -117,7 +117,7 @@ Set discriminator network. -`QuantumGenerator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`QuantumGenerator.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.md index 1642282382a..c1aa6dbfde6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -48,7 +48,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -79,7 +79,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -95,7 +95,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -117,7 +117,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -155,7 +155,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.md index 82687ee457d..cb07e980296 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -45,7 +45,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Support level dictionary @@ -86,7 +86,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.md index 8a986e3c761..17ffb681269 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.md index 588d71e1e95..8389e09586c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize CG. For further detail, please refer to [https://do -`CG.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.md index 16da45b4d73..a0337c770a4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.minimize COBYLA. For further detail, please refer to [https: -`COBYLA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Return support level dictionary @@ -64,7 +64,7 @@ grad -`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.md index 771ae3eec74..c18de079b05 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.md index 3e2c4524bea..8128d75bb13 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index ae5dfe2e7b4..9cf5fd1788b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.md index f72728b4531..e18b87cecd3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.md index 40b08824745..e45cf06aa95 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -39,7 +39,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Return support level dictionary. @@ -55,7 +55,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -103,7 +103,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Run the line search optimization. @@ -131,7 +131,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Perform optimization. @@ -169,7 +169,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -193,7 +193,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.md index 503b45666d6..f96aa6e9508 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.md index 2307be651a4..dd96bbeb6a3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.md index 47d39c3177a..225aa2a83a7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -38,7 +38,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`L_BFGS_B.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Return support level dictionary @@ -69,7 +69,7 @@ grad -`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.md index b0a6d556988..951d36f56bd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize Nelder-Mead. For further detail, please refer to Se -`NELDER_MEAD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Return support level dictionary @@ -68,7 +68,7 @@ grad -`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.md index 8d818bbdf2f..e541f8173b4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -43,7 +43,7 @@ K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization fo -`NFT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") return support level dictionary @@ -74,7 +74,7 @@ grad -`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.md index 80e98a1d35c..c6705741607 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index 63d60f8c139..8c787fe12f7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.md index 74d8f777c17..bc33b3646a3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize Powell. For further detail, please refer to See [ht -`POWELL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.md index 9f7e665caea..fa6cfb71f22 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`P_BFGS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") return support level dictionary @@ -64,7 +64,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.md index d4cf3418d3a..271594803ec 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -36,7 +36,7 @@ Uses scipy.optimize.minimize SLSQP. For further detail, please refer to See [htt -`SLSQP.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Return support level dictionary @@ -67,7 +67,7 @@ grad -`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.md index c12fdcc6f6e..ba81d9e236b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.md index 9ea7dcf9cbe..57b9cda4881 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -51,7 +51,7 @@ For further details, please refer to [https://arxiv.org/pdf/1704.05018v2.pdf#sec -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") return support level dictionary @@ -82,7 +82,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.md index 86a951cf3ff..5ce0ad96d08 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize TNC For further detail, please refer to See [https: -`TNC.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") return support level dictionary @@ -68,7 +68,7 @@ grad -`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 95a27575e64..71443988da0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ This class is provided for easy creation of oracles using custom circuits. It is -`CustomCircuitOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index af31497f164..a17dc76baa0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -58,7 +58,7 @@ By default, the Logical Expression oracle will not try to apply any optimization -`LogicalExpressionOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") construct circuit @@ -66,7 +66,7 @@ construct circuit -`LogicalExpressionOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") evaluate classically diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.md index bc8909a4dd2..6f3f2f313a4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ This method should initialize the module and use an exception if a component of -`abstract Oracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`abstract Oracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.md index 83f64fb7476..d75f233bad4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ Regarding circuit optimization and mct usages, the truth table oracle is similar -`TruthTableOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") construct circuit @@ -54,7 +54,7 @@ construct circuit -`TruthTableOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") evaluate classical diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.md index ba457478c4f..5a4caa52a33 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -36,7 +36,7 @@ It finds the reciprocal with long division method and rotates the ancillary qubi -`LongDivision.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Construct the Long Division Rotation circuit. @@ -62,7 +62,7 @@ containing the Long Division Rotation circuit. -`LongDivision.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.md index d8db023f7f4..21c0acbde68 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -35,7 +35,7 @@ A calculation of reciprocals of eigenvalues is performed and controlled rotation -`LookupRotation.construct_circuit(mode, inreg)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.construct_circuit(mode, inreg)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Construct the Lookup Rotation circuit. @@ -60,7 +60,7 @@ NotImplementedError: mode not supported -`LookupRotation.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.md index fe08d1e0579..8c0ba818e7d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Construct the initial state circuit. @@ -42,7 +42,7 @@ The reciprocal circuit. -`abstract Reciprocal.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 545dc579533..a761e167b55 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 91cc535509c..748f3c73eab 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -35,7 +35,7 @@ Dependency between individual risk variables and latent variable is approximated -`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index c8f212d4df1..4355ff2fc65 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 6b9bc9c32d7..dda3b6f9e05 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -29,7 +29,7 @@ This module contains the definition of a base class for multivariate distributio -`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") ### build\_controlled @@ -129,7 +129,7 @@ returns number of qubits controlled -`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") pdf to probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index b0da929a0d1..0c92d70e77c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 56b5c191c73..9b1ad691dd2 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index e9517faa06b..0c07823fa19 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ Although this just results in a Hadamard gate on all involved qubits, the lower -`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index 82225843582..8b611c1f0c4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ The Multivariate Variational Distribution. -`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") ### build\_controlled @@ -154,7 +154,7 @@ returns required ancillas controlled -`MultivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index 574d76b9062..816a8c3ebc0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 3d78ef0f430..0efcb0c9223 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -22,7 +22,7 @@ The abstract Uncertainty Model -`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Adds corresponding sub-circuit to given circuit diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 7cca0f927c4..db8ec72852d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ Uniform distribution is defined by the number of qubits that should be used to r -`UniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") ### build\_controlled @@ -153,7 +153,7 @@ list -`UniformDistribution.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas @@ -161,7 +161,7 @@ returns required ancillas -`UniformDistribution.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index a7f59c743ae..098a1402e22 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -33,7 +33,7 @@ This module contains the definition of a base class for univariate distributions -`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") ### build\_controlled @@ -133,7 +133,7 @@ returns number of qubits controlled -`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 040089b5059..c5acc1805cb 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ The Univariate Variational Distribution. -`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") ### build\_controlled @@ -169,7 +169,7 @@ returns required ancillas controlled -`UnivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 7601ab629f2..d7d33f0762c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`MultivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`MultivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 250bbe128ad..88b518dfb92 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -147,7 +147,7 @@ returns required ancillas controlled -`UncertaintyProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 63199cf7444..0252c577e63 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -42,7 +42,7 @@ $$ -`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") ### build\_controlled @@ -142,7 +142,7 @@ returns number of qubits controlled -`UnivariatePiecewiseLinearObjective.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") requires ancillas @@ -158,7 +158,7 @@ returns required ancillas controlled -`UnivariatePiecewiseLinearObjective.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") value to estimation diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index 795745b2220..2cee7d25a27 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`UnivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`UnivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.md index 56c44d14c26..a6f628f93f6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract VariationalForm.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`abstract VariationalForm.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Construct the variational form, given its parameters. @@ -45,7 +45,7 @@ A quantum circuit. -`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") returns entangler map @@ -53,7 +53,7 @@ returns entangler map -`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.md index 78d926e0bb7..52f300b1ca7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -140,7 +140,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -162,7 +162,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -182,7 +182,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -198,7 +198,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Permutes the qubits of the operator. @@ -222,7 +222,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -242,7 +242,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -258,7 +258,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -270,7 +270,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -294,7 +294,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -314,7 +314,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -336,7 +336,7 @@ The `LegacyBaseOperator` representing this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.md index b6368fa370e..08c02698d7b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.md index e9783f821f1..1d28761a3f7 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -35,7 +35,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -60,7 +60,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. @@ -85,7 +85,7 @@ The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. -`CircuitSampler.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.md index 2107b6a1d2d..804264fbf74 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.md index 87540049609..dce2cbcb935 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.md index fbc3778b8d2..be149136d09 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TBP stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.md index 217601fddc1..f4b3fe51472 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.md index 54f196a9083..efede772208 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.md index 9fb3de17e9c..1cffa046041 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -95,7 +95,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -123,7 +123,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -143,7 +143,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -177,7 +177,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to the negation of self. -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -269,7 +269,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -285,7 +285,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -301,7 +301,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -403,7 +403,7 @@ The `LegacyBaseOperator` representing this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -419,7 +419,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.md index 67bc05bd33f..3304c4c1bb2 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index 8e276a706ab..f176beedf72 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.md index a3c8f15543f..5ad24fd7bff 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.md index 2b2083745e9..1235021c257 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.md index 6ac9cd1ce64..3fb5b235bb3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.md index aca978cce4a..1357669efc6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index a211e007991..e557805d407 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.md index 4a47649405a..88d453f3f7d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.md index eb85fc18bfa..67f3bef26cd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.md index d4ebaffdd5d..ca8eaabee5c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.md index 899b706f36e..f145817d2da 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.md index 1ed2fe426da..6b0d349e38b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.md index 115a7fef8a6..baa3f571a7c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.md index a902b5ae962..3665bc06a86 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.md index 2c755ac3ec0..5409b312c4f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.md index b8978323d97..9a156503c79 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -74,7 +74,7 @@ callable(param\_values) -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.md index 9a3aef0c97e..64476eeaabf 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.md index 55ab93c2325..cd419722bd4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.md index 31aa592b695..2484984c874 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.md index b1f14fb3936..0ad4946a2d5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.md index 6d7b8d64b4a..3a552c00d70 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.md index e11efc85ae5..96c2f27fc2f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.md index 1231b401a6e..e82979d6745 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 0a325af00ff..e163e07a261 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Bases: `abc.ABC` @@ -24,13 +24,13 @@ Constructor. -`abstract LegacyBaseOperator.chop(threshold, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.chop(threshold, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") ### construct\_evaluation\_circuit -`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Build circuits to compute the expectation w\.r.t the wavefunction. @@ -38,7 +38,7 @@ Build circuits to compute the expectation w\.r.t the wavefunction. -`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. @@ -46,7 +46,7 @@ Consume the result from the quantum computer to build the expectation, will be o -`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Time evolution, exp^(-jt H). @@ -54,7 +54,7 @@ Time evolution, exp^(-jt H). -`abstract LegacyBaseOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Check Operator is empty or not @@ -62,7 +62,7 @@ Check Operator is empty or not -`abstract LegacyBaseOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") print details @@ -70,7 +70,7 @@ print details -`abstract LegacyBaseOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Convert to new Operator format. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.md index d24a16a9769..ae1ad60213e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -34,13 +34,13 @@ Operators relevant for quantum applications -`MatrixOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### chop -`MatrixOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Eliminate the real and imagine part of coeff in each pauli by threshold. If pauli’s coeff is less then threshold in both real and imagine parts, the pauli is removed. To align the internal representations, all available representations are chopped. The chopped result is stored back to original property. Note: if coeff is real-only, the imag part is skipped. @@ -61,7 +61,7 @@ self or copy -`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Construct the circuits for evaluation. @@ -86,7 +86,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`MatrixOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Get a copy of self. @@ -94,7 +94,7 @@ Get a copy of self. -`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Use the executed result with operator to get the evaluated value. @@ -121,7 +121,7 @@ float -`MatrixOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Parameters** @@ -143,7 +143,7 @@ float -`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -172,7 +172,7 @@ numpy.array -`MatrixOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Check Operator is empty or not. @@ -188,7 +188,7 @@ bool -`MatrixOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Returns** @@ -202,13 +202,13 @@ str -`MatrixOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### to\_opflow -`MatrixOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.md index 58edb0b9a98..43ff09e9970 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 65630538d2f..bf4012a9ea0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` @@ -373,7 +373,7 @@ bool -`TPBGroupedWeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Perform self \* other. @@ -395,7 +395,7 @@ the multiplied operator -`TPBGroupedWeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -472,7 +472,7 @@ the simplified operator -`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Largest-Degree First Coloring for grouping paulis. @@ -550,7 +550,7 @@ to op flow -`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Greedy and unsorted grouping paulis. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 4130ae96338..4d1f948fa31 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -30,7 +30,7 @@ Weighted Pauli Operator -`WeightedPauliOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self + other. @@ -51,7 +51,7 @@ operator -`WeightedPauliOperator.anticommute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.anticommute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Anti commutes with @@ -59,7 +59,7 @@ Anti commutes with -`WeightedPauliOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminate the real and imagine part of weight in each pauli by threshold. If pauli’s weight is less then threshold in both real and imaginary parts, the pauli is removed. @@ -86,7 +86,7 @@ the operator is mutated. -`WeightedPauliOperator.commute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.commute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Commutes with @@ -94,7 +94,7 @@ Commutes with -`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Construct the circuits for evaluation, which calculating the expectation \. @@ -129,7 +129,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`WeightedPauliOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self @@ -137,7 +137,7 @@ Get a copy of self -`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.WeightedPauliOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. @@ -166,7 +166,7 @@ float -`WeightedPauliOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -188,7 +188,7 @@ float -`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -212,7 +212,7 @@ dict -`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -242,7 +242,7 @@ The constructed circuit. -`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -271,7 +271,7 @@ The constructed QuantumCircuit. -`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: @@ -308,7 +308,7 @@ the operator created from the input dictionary. -`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis in a file to construct an Operator. @@ -329,7 +329,7 @@ the loaded operator. -`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Create a WeightedPauliOperator via a pair of list. @@ -355,7 +355,7 @@ operator -`WeightedPauliOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check Operator is empty or not. @@ -371,7 +371,7 @@ bool -`WeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self \* other, and the phases are tracked. @@ -391,7 +391,7 @@ the multiplied operator -`WeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -407,7 +407,7 @@ str -`WeightedPauliOperator.reorder_paulis()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.reorder_paulis()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Reorder the paulis based on the basis and return the reordered paulis. @@ -423,7 +423,7 @@ the ordered paulis based on the basis. -`WeightedPauliOperator.rounding(decimals, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.rounding(decimals, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Rounding the weight. @@ -444,7 +444,7 @@ operator -`WeightedPauliOperator.simplify(copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.simplify(copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. @@ -468,7 +468,7 @@ the simplified operator -`WeightedPauliOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self - other. @@ -489,7 +489,7 @@ operator -`WeightedPauliOperator.to_dict()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_dict()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a dict in pauli representation. @@ -505,7 +505,7 @@ dict -`WeightedPauliOperator.to_file(file_name)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_file(file_name)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a file in pauli representation. @@ -517,7 +517,7 @@ Save operator to a file in pauli representation. -`WeightedPauliOperator.to_opflow(reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_opflow(reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.md index 07bd6621292..fad511f194a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ TaperedWeightedPauliOperator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self. @@ -73,7 +73,7 @@ copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -89,7 +89,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check the z2\_symmetries is empty or not. @@ -105,7 +105,7 @@ bool -`Z2Symmetries.taper(operator, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.taper(operator, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -132,7 +132,7 @@ list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`static Z2Symmetries.two_qubit_reduction(operator, num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`static Z2Symmetries.two_qubit_reduction(operator, num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.md index 2a15f7437f5..400e3845c24 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -96,7 +96,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -232,7 +232,7 @@ An `OperatorBase` equivalent to the negation of self. -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -308,7 +308,7 @@ A set of strings describing the primitives contained within the Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -368,7 +368,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.md index 234d33c0976..a21d9e5c3c4 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -105,7 +105,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -133,7 +133,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ListOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -241,7 +241,7 @@ An `OperatorBase` equivalent to the negation of self. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -265,7 +265,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -285,7 +285,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -301,7 +301,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -317,7 +317,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -341,7 +341,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -361,7 +361,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -373,7 +373,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -395,7 +395,7 @@ The `LegacyBaseOperator` representing this Operator. -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -411,7 +411,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -423,7 +423,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -435,7 +435,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -451,7 +451,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.md index 0d44bd127d9..41ccfd150e1 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -146,7 +146,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -328,7 +328,7 @@ A set of strings describing the primitives contained within the Operator. -`SummedOp.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Print out the operator in details. :returns: a formatted string describes the operator. :rtype: str @@ -336,7 +336,7 @@ Print out the operator in details. :returns: a formatted string describes the op -`SummedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -398,7 +398,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parametrized PrimitiveOps (in that case, AquaError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -431,7 +431,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`SummedOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -469,7 +469,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.md index 50a67ce9a69..ed9579963e6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -292,7 +292,7 @@ A set of strings describing the primitives contained within the Operator. -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -308,7 +308,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -352,7 +352,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0845d8186f3..972105875c3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -270,7 +270,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -286,7 +286,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -302,7 +302,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -346,7 +346,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -358,7 +358,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -370,7 +370,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -404,7 +404,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c06b5d15c6f..db393ba67f0 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -274,7 +274,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -306,7 +306,7 @@ The reduced `OperatorBase`. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -374,7 +374,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -386,7 +386,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -408,7 +408,7 @@ The `LegacyBaseOperator` representing this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -424,7 +424,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.md index 0e779e37344..0a29af1539e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -99,7 +99,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PauliOp.commutes(other_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.commutes(other_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns whether self commutes with other\_op. @@ -119,7 +119,7 @@ A bool equaling whether self commutes with other\_op -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -147,7 +147,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -167,7 +167,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -189,7 +189,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -249,7 +249,7 @@ An `OperatorBase` equivalent to the negation of self. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -293,7 +293,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -325,7 +325,7 @@ The reduced `OperatorBase`. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -393,7 +393,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -405,7 +405,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -427,7 +427,7 @@ The `LegacyBaseOperator` representing this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -455,7 +455,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -467,7 +467,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 06bb537c7b0..c29f249d801 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -97,7 +97,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -125,7 +125,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -145,7 +145,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -167,7 +167,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -179,7 +179,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -191,7 +191,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -227,7 +227,7 @@ An `OperatorBase` equivalent to the negation of self. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -251,7 +251,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -271,7 +271,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -287,7 +287,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -303,7 +303,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -327,7 +327,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -347,7 +347,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -359,7 +359,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -371,7 +371,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -383,7 +383,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -405,7 +405,7 @@ The `LegacyBaseOperator` representing this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -421,7 +421,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -433,7 +433,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 8fb7e91a1a3..15616f8ab35 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -136,7 +136,7 @@ An Operator equivalent to the function composition of self and other. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -185,7 +185,7 @@ A bool equal to the equality of self and other. -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -231,7 +231,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -257,7 +257,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -365,7 +365,7 @@ The reduced `OperatorBase`. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -387,7 +387,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -431,7 +431,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -443,7 +443,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -477,7 +477,7 @@ The `LegacyBaseOperator` representing this Operator. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -489,7 +489,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -501,7 +501,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.md index a6291c4b3ea..2acb13e731d 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -168,7 +168,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -188,7 +188,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -244,7 +244,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -284,7 +284,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -300,7 +300,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -316,7 +316,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -328,7 +328,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -372,7 +372,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -384,7 +384,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -396,7 +396,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -408,7 +408,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -438,7 +438,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.md index c7f657ffc46..7753ab1914e 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -204,7 +204,7 @@ An `OperatorBase` equivalent to the negation of self. -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -244,7 +244,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -298,7 +298,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -342,7 +342,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -354,7 +354,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -400,7 +400,7 @@ The `LegacyBaseOperator` representing this Operator. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -436,7 +436,7 @@ A VectorStateFn equivalent to self. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.md index d00c5e512aa..1e96869be1f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -384,7 +384,7 @@ The `LegacyBaseOperator` representing this Operator. -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -410,7 +410,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.md index 511b06e8ac4..f200f3a35ce 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -102,7 +102,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -128,7 +128,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -206,7 +206,7 @@ An `OperatorBase` equivalent to the negation of self. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -226,7 +226,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -246,7 +246,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -262,7 +262,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -278,7 +278,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -300,7 +300,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -324,7 +324,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -344,7 +344,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -368,7 +368,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -390,7 +390,7 @@ The `LegacyBaseOperator` representing this Operator. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -406,7 +406,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -426,7 +426,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.md index 1557aa5d657..afab35e8a34 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -374,7 +374,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -412,7 +412,7 @@ The `LegacyBaseOperator` representing this Operator. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -428,7 +428,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.md index 17e5fc4f133..34b0a0e40f6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for CircuitFactories -`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding sub-circuit to given circuit @@ -37,7 +37,7 @@ Adds corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding controlled sub-circuit to given circuit @@ -53,7 +53,7 @@ Adds corresponding controlled sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled inverse of corresponding sub-circuit to given circuit @@ -69,7 +69,7 @@ Adds controlled inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -77,7 +77,7 @@ Adds controlled, inverse, power of corresponding circuit. May be overridden if a -`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -85,7 +85,7 @@ Adds controlled power of corresponding circuit. May be overridden if a more effi -`CircuitFactory.build_inverse(qc, q, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse(qc, q, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse of corresponding sub-circuit to given circuit @@ -99,7 +99,7 @@ Adds inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -107,7 +107,7 @@ Adds inverse power of corresponding circuit. May be overridden if a more efficie -`CircuitFactory.build_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -115,7 +115,7 @@ Adds power of corresponding circuit. May be overridden if a more efficient imple -`CircuitFactory.get_num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits @@ -123,7 +123,7 @@ returns number of qubits -`CircuitFactory.get_num_qubits_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits controlled @@ -131,7 +131,7 @@ returns number of qubits controlled -`CircuitFactory.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas @@ -139,7 +139,7 @@ returns required ancillas -`CircuitFactory.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.30/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.30/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.30/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.md index f08a8c2467f..db0fe7be543 100644 --- a/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.30/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.30/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.30/qiskit.assembler.assemble_circuits.md index 0b7badfe8e7..91302eba922 100644 --- a/docs/api/qiskit/0.30/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.30/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.30/qiskit.assembler.assemble_schedules.md index 174896e6b6b..25ff21249a3 100644 --- a/docs/api/qiskit/0.30/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.30/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.30/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.30/qiskit.assembler.disassemble.md index acbe0abbd5d..d27cfe3c9e2 100644 --- a/docs/api/qiskit/0.30/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.30/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.md index d2285896e8f..362e19bbb2c 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ The Bosonic operator in this class is written in the n-mode second quantization -`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Filters out the states of irrelevant symmetries @@ -57,7 +57,7 @@ True if the state is has one and only one modal occupied per mode meaning that t -`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Maps a bosonic operator into a qubit operator. @@ -82,7 +82,7 @@ A qubit operator -`BosonicOperator.number_occupied_modals_per_mode(mode)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.number_occupied_modals_per_mode(mode)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A bosonic operator which can be used to evaluate the number of occupied modals in a given mode diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.md index 8852f24734c..88871eb1517 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ The [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") class -`FermionicOperator.fermion_mode_elimination(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_elimination(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Eliminate modes. @@ -72,7 +72,7 @@ Fermionic Hamiltonian -`FermionicOperator.fermion_mode_freezing(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_freezing(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Freezing modes and extracting its energy. @@ -94,7 +94,7 @@ tuple([FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.F -`FermionicOperator.mapping(map_type, threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.mapping(map_type, threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Map fermionic operator to qubit operator. @@ -121,7 +121,7 @@ create an Operator object in Paulis form. -`FermionicOperator.particle_hole_transformation(num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.particle_hole_transformation(num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") The ‘standard’ second quantized Hamiltonian can be transformed in the particle-hole (p/h) picture, which makes the expansion of the trail wavefunction from the HF reference state more natural. In fact, for both trail wavefunctions implemented in q-lib (‘heuristic’ hardware efficient and UCCSD) the p/h Hamiltonian improves the speed of convergence of the VQE algorithm for the calculation of the electronic ground state properties. For more information on the p/h formalism see: P. Barkoutsos, arXiv:1805.04340([https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340)). @@ -141,7 +141,7 @@ tuple -`FermionicOperator.total_angular_momentum()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_angular_momentum()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Total angular momentum. @@ -159,7 +159,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_magnetization()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_magnetization()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the magnetization of the given eigenstate. @@ -175,7 +175,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_particle_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_particle_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the number of particle of the given eigenstate. @@ -191,7 +191,7 @@ Fermionic Hamiltonian -`FermionicOperator.transform(unitary_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.transform(unitary_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Transform the one and two body term based on unitary\_matrix. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.md index 7767ac98360..a2386ddd296 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Bases: `object` @@ -41,7 +41,7 @@ A utility class for MP2 info -`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") With a reduced active space the set of used excitations can be less than allowing all available excitations. Given a (sub)set of excitations in the space this will return a list of correlation coefficients and a list of correlation energies ordered as per the excitation list provided. @@ -67,7 +67,7 @@ Tuple(list, list) -`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Gets the set of MP2 terms for the molecule taking into account index adjustments due to frozen core and/or other orbital reduction diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.md index e979a66297d..a35cd660fc7 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Bases: `object` @@ -28,13 +28,13 @@ This class provides methods to save it and load it again from an HDF5 file -`QMolecule.Z(natom)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.Z(natom)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ### has\_dipole\_integrals -`QMolecule.has_dipole_integrals()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.has_dipole_integrals()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Check if dipole integrals are present. @@ -42,7 +42,7 @@ Check if dipole integrals are present. -`QMolecule.load()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.load()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") loads info saved. @@ -50,7 +50,7 @@ loads info saved. -`QMolecule.log()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.log()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") log properties @@ -58,7 +58,7 @@ log properties -`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert one-body MO integrals to spin orbital basis @@ -82,7 +82,7 @@ numpy.ndarray -`static QMolecule.oneeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.oneeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts one-body integrals from AO to MO basis @@ -105,7 +105,7 @@ numpy.ndarray -`QMolecule.remove_file(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.remove_file(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") remove file @@ -113,7 +113,7 @@ remove file -`QMolecule.save(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.save(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Saves the info from the driver. @@ -121,7 +121,7 @@ Saves the info from the driver. -`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert two-body MO integrals to spin orbital basis @@ -146,7 +146,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts two-body integrals from AO to MO basis @@ -169,7 +169,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.md index 44ca4ce3362..1e48cd816ea 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.md index acff494f47e..cc29e688ef5 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.md index 4a12aea1ebf..2c9ac46295f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -51,7 +51,7 @@ The expectation value of the given operator(s). The return type will be identica -`AdaptVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -63,7 +63,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`AdaptVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Computes the ground state. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.md index 7f9d388d608..b20341d7dc0 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.md index 254c2c52a7a..e9d6ee9646a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a eigensolver based on a qubit operator transformation. -`abstract EigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`abstract EigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Returns a eigensolver, based on the qubit operator transformation. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index 7dad604602c..3ce3db48c4e 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via an Eigensolver algorithm -`ExcitedStatesEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Compute Ground and Excited States properties. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index e91e7836bc5..663ed080638 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The excited states calculation interface -`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Compute the excited states energies of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 02f4dbe380a..18e83d40eed 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` @@ -27,7 +27,7 @@ Ground state computation using a minimum eigensolver. -`GroundStateEigensolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Evaluates additional operators at the given state. @@ -48,7 +48,7 @@ The expectation value of the given operator(s). The return type will be identica -`GroundStateEigensolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -60,7 +60,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`GroundStateEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.md index 101256b9a3a..45cab346ef3 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ The ground state calculation interface -`abstract GroundStateSolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Evaluates additional operators at the given state. @@ -47,7 +47,7 @@ The expectation value of the given operator(s). The return type will be identica -`abstract GroundStateSolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Whether this class returns only the ground state energy or also the ground state itself. @@ -63,7 +63,7 @@ True, if this class also returns the ground state in the results object. False o -`abstract GroundStateSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index db1be79349d..eb9e42dbd54 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a minimum eigensolver based on a qubit operator transform -`abstract MinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns a minimum eigensolver, based on the qubit operator transformation. @@ -42,7 +42,7 @@ A minimum eigensolver suitable to compute the ground state of the molecule trans -`abstract MinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index e915859b2a4..c5759900f38 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` @@ -29,7 +29,7 @@ A factory to construct a NumPyEigensolver. -`NumPyEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Returns a NumPyEigensolver with the desired filter diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index f9cc83c2cc8..0587bb64afa 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -27,7 +27,7 @@ A factory to construct a NumPyMinimumEigensolver. -`NumPyMinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the `transformation`. @@ -47,7 +47,7 @@ A NumPyMinimumEigensolver suitable to compute the ground state of the molecule t -`NumPyMinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 0a0362652d0..1507f8c4edd 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -57,7 +57,7 @@ The expectation value of the given operator(s). The return type will be identica -`OrbitalOptimizationVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -69,7 +69,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`OrbitalOptimizationVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.md index 73920f5628b..2647a4e4f81 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via the qEOM algorithm -`QEOM.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Run the excited-states calculation. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.md index a80b38b913e..6e661775e3d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.md index 3bdfaeaae9a..caac0014a78 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.md index 25460147fc0..06e893291e1 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -79,7 +79,7 @@ dict -`VQEAdapt.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal circuit @@ -87,7 +87,7 @@ get optimal circuit -`VQEAdapt.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal cost @@ -95,7 +95,7 @@ get optimal cost -`VQEAdapt.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal vector diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 8d20352d9dc..134cd6fbcdd 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -35,7 +35,7 @@ A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. -`VQEUCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns a VQE with a UCCSD wavefunction ansatz, based on `transformation`. This works only with a `FermionicTransformation`. @@ -59,7 +59,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index db186bdd442..fe9d34414fd 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -31,7 +31,7 @@ A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction -`VQEUVCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns a VQE with a UVCCSD wavefunction ansatz, based on `transformation`. This works only with a `BosonicTransformation`. @@ -51,7 +51,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUVCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 9c6a5773253..7fd983696f2 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 6e977f009de..ebb790bcde3 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`DifferentialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Each parameter list and list of numerical gradients is treated as a single point in vector space. The regression model tries to fit a Hamiltonian that describes the evolution from one parameter set (and its gradient features) at point r, to another parameter set at point, r + epsilon. The regression model is then used to predict the parameter set at the point of interest. Note that this extrapolation technique does not explicitly use the spacing of the points (step size) but rather infers it from the list of parameter values. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index 8d04afed4fd..eda9274f2b4 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` @@ -26,7 +26,7 @@ This allows for fitting BOPES sampler results or potential energy surfaces. -`EnergySurface1DSpline.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -46,7 +46,7 @@ Value of surface fit in point x. -`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Fits surface to data. @@ -65,7 +65,7 @@ Fits surface to data. -`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. :type scaling: `float` :param scaling: scaling factor @@ -81,7 +81,7 @@ equilibrium geometry -`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. :type scaling: `float` :param scaling: scaling factor @@ -97,7 +97,7 @@ minimum energy -`EnergySurface1DSpline.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 589d66f534e..ecb8e7b2446 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a potential energy surface -`abstract EnergySurfaceBase.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -42,7 +42,7 @@ value of surface in point x -`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Fits surface to data @@ -61,7 +61,7 @@ Fits surface to data -`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the equilibrium energy. @@ -83,7 +83,7 @@ equilibrium geometry -`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the minimal energy. @@ -105,7 +105,7 @@ minimum energy -`abstract EnergySurfaceBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index 12098ea57e2..79f3c17b80d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ There are two types of Extrapolators: external/wrapper and internal. The externa -`abstract Extrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`abstract Extrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Abstract method to extrapolate point(s) of interest. @@ -47,7 +47,7 @@ Dictionary of variational parameters for extrapolated point(s). -`static Extrapolator.factory(mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`static Extrapolator.factory(mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Factory method for constructing extrapolators. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index 7916ddc3e05..5c81143c12a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -32,7 +32,7 @@ Input units are Angstroms (distance between the two atoms), and output units are -`HarmonicPotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the estimated dissociation energy for the current fit. @@ -52,7 +52,7 @@ estimated dissociation energy -`HarmonicPotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -72,7 +72,7 @@ value of potential in point x -`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Fits a potential to computed molecular energies. @@ -91,7 +91,7 @@ Fits a potential to computed molecular energies. -`static HarmonicPotential.fit_function(x, k, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`static HarmonicPotential.fit_function(x, k, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Functional form of the potential. @@ -114,7 +114,7 @@ harmonic potential functional form -`HarmonicPotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -130,7 +130,7 @@ fundamental frequency for the current fit -`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -170,7 +170,7 @@ maximum\_trusted\_level setted -`HarmonicPotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -214,7 +214,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`classmethod HarmonicPotential.process_fit_data(xdata, ydata)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`classmethod HarmonicPotential.process_fit_data(xdata, ydata)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() @@ -237,7 +237,7 @@ the processed data that fit better to a harmonic potential -`HarmonicPotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Updates the underlying molecule. @@ -257,7 +257,7 @@ Updates the underlying molecule. -`HarmonicPotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -277,7 +277,7 @@ vibrational energy level for the current fit -`HarmonicPotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 39f5a6ac5fd..f00c34443a6 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -34,7 +34,7 @@ Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algor -`MorsePotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the calculated dissociation energy for the current fit. @@ -54,7 +54,7 @@ calculated dissociation energy for the current fit -`MorsePotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -74,7 +74,7 @@ value of surface in point x -`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Fits a potential to computed molecular energies. @@ -93,7 +93,7 @@ Fits a potential to computed molecular energies. -`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Functional form of the potential. @@ -117,7 +117,7 @@ potential functional form -`MorsePotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -133,7 +133,7 @@ fundamental frequency for the current fit -`MorsePotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -153,7 +153,7 @@ interatomic distance corresponding to minimal energy -`MorsePotential.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. @@ -173,7 +173,7 @@ maximum\_trusted\_level estimated -`MorsePotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -217,7 +217,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`MorsePotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Updates the underlying molecule. @@ -237,7 +237,7 @@ Updates the underlying molecule. -`MorsePotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -257,7 +257,7 @@ vibrational energy level for the current fit -`MorsePotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index b9c05c60048..826a345addf 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -34,7 +34,7 @@ Constructor. -`PCAExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. This method transforms the parameters in PCA space before performing the internal extrapolation. The parameters are transformed back to regular space after extrapolation. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 67bf8bd84fa..3e3cb04837b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -30,7 +30,7 @@ Constructor. -`PolynomialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Extrapolation is based on a polynomial function/spline fitting with a user-specified degree. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 27e02c06513..362ee9caa30 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` @@ -22,7 +22,7 @@ Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of fr -`abstract PotentialBase.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract PotentialBase.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the dissociation energy (scaled by ‘scaling’) @@ -137,7 +137,7 @@ minimum energy -`PotentialBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") This (1D) potential represents a single vibrational mode @@ -149,7 +149,7 @@ This (1D) potential represents a single vibrational mode -`PotentialBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. Redefine in derived classes if needed. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index 2f59b46bb2c..4e0858f71f4 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -31,7 +31,7 @@ Constructor. -`SieveExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method finds a cutoff distance based on the maximum average distance or ‘gap’ between the average values of the variational parameters. This cutoff distance is used as a criteria to divide the parameters into two clusters by setting all parameters that are below the cutoff distance to zero. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index 6a795448f01..23343a3d42a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a molecular vibronic structure providing access to vibrational mod -`VibronicStructureBase.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. Default value of 100. Redefined where needed (see e.g. Morse). @@ -42,7 +42,7 @@ maximum\_trusted\_level setted -`abstract VibronicStructureBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the number of vibrational modes for the molecule. @@ -58,7 +58,7 @@ the number of vibrational modes -`VibronicStructureBase.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Wipe state if molecule changes, and check validity of molecule for potential. @@ -78,7 +78,7 @@ molecule used -`abstract VibronicStructureBase.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the n-th vibrational energy level for a given mode. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 681fb8420fb..434ae7bed14 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`WindowExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method defines the data window before performing the internal extrapolation. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index 3d7e0169b30..705c3b2b0c3 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Molecular ground state energy chemistry application -`MolecularGroundStateEnergy.compute_energy(callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy.compute_energy(callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver @@ -57,7 +57,7 @@ A molecular ground state result -`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index efe575f1e23..42af0c7e1c5 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Basis to express a second quantization Bosonic Hamiltonian. -`BosonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 36779a993cf..ef39732a053 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` @@ -34,7 +34,7 @@ This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) -`HarmonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.md index 2ffac17ec3c..d9d4dcec315 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -35,7 +35,7 @@ A Hartree-Fock initial state. -`HartreeFock.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.md index 2e0c0af3104..522b7cc0aa5 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ Creates an occupation number vector as defined in Ollitrault Pauline J., Chemica -`VSCF.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.md index 357ad749e4b..d1ef9c870cd 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -37,7 +37,7 @@ The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science -`CHC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.md index e709b18e9e7..c6cb6f62aa5 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -66,7 +66,7 @@ Constructor. -`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Computes single and double excitation lists. @@ -98,7 +98,7 @@ list -`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. @@ -119,7 +119,7 @@ list -`UCCSD.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Construct the variational form, given its parameters. @@ -152,7 +152,7 @@ returns entangler map -`static UCCSD.group_excitations(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. @@ -173,7 +173,7 @@ tuple -`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. @@ -194,7 +194,7 @@ list -`UCCSD.manage_hopping_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.manage_hopping_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Triggers the adaptive behavior of this UCCSD instance. This function is used by the Adaptive VQE algorithm. It stores the full list of available hopping operators in a so called “excitation pool” and clears the previous list to be empty. Furthermore, the depth is asserted to be 1 which is required by the Adaptive VQE algorithm. @@ -202,7 +202,7 @@ Triggers the adaptive behavior of this UCCSD instance. This function is used by -`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. @@ -223,7 +223,7 @@ list -`UCCSD.pop_hopping_operator()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.pop_hopping_operator()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pops the hopping operator that was added last. @@ -231,7 +231,7 @@ Pops the hopping operator that was added last. -`UCCSD.push_hopping_operator(excitation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.push_hopping_operator(excitation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pushes a new hopping operator. @@ -243,7 +243,7 @@ Pushes a new hopping operator. -`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Regroups the excitations that involve same spatial orbitals for example, with labeling. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.md index bee952ab726..f5d200aca47 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -34,7 +34,7 @@ This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Doub -`static UVCC.compute_excitation_lists(basis, degrees)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`static UVCC.compute_excitation_lists(basis, degrees)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Compute the list with all possible excitation for given orders @@ -59,7 +59,7 @@ List of excitation indexes in terms of modes and modals -`UVCC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Construct the variational form, given its parameters. @@ -85,7 +85,7 @@ Quantum Circuit a quantum circuit with given parameters -`UVCC.excitations_in_qubit_format()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.excitations_in_qubit_format()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") #### Gives the list of excitation indexes in terms of qubit indexes rather diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.md index 878f1ea509f..4061b4093bb 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for ChemistryOperator. -`ChemistryOperator.process_algorithm_result(algo_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator.process_algorithm_result(algo_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Takes the algorithm result and processes it as required, e.g. by combination of any parts that were classically computed, for the final result. @@ -42,7 +42,7 @@ Final chemistry result computed from the algorithm result -`abstract ChemistryOperator.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`abstract ChemistryOperator.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.md index c03444567c8..eb31d2657af 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` @@ -55,7 +55,7 @@ Final chemistry result computed from the algorithm result -`Hamiltonian.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") run method diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.md index 32e2f1c0875..a8f9f08f3e0 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.md index fd533f4dcab..e6b07622e9b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.md index 1302c42392b..2c4cd73fc6b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` @@ -68,7 +68,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`MolecularGroundStateResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether dipole moment is present in result or not @@ -80,7 +80,7 @@ Returns whether dipole moment is present in result or not -`MolecularGroundStateResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.md index bfb15314061..6ac9c24805a 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.md index d5c63c9d4f0..228ffac5f39 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.md index 39426cd2514..47f776191ca 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.md index b5df8909308..7f58d2463e8 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.md index 4da4e20d1af..8ec3e686c63 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry bosonic drivers. -`abstract BosonicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`abstract BosonicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.md index d79f936dd16..23caf4fba8b 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -39,7 +39,7 @@ A determinant based full configuration interaction program, Computer Physics Com -`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Convenience method to produce an FCIDump output file. @@ -58,7 +58,7 @@ Convenience method to produce an FCIDump output file. -`FCIDumpDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Constructs a QMolecule instance out of a FCIDump file. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.md index 174374675eb..3a4d06230a7 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry fermionic drivers. -`abstract FermionicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`abstract FermionicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.md index fe1cff4b4bf..37f1b1a1b71 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -37,7 +37,7 @@ This driver uses the Gaussian open-source Gaussian 16 interfacing code in order -`GaussianDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.md index 5b04ce5ae68..0f66d0991e1 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` @@ -34,7 +34,7 @@ Gaussian™ 16 forces driver. -`GaussianForcesDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.md index 5fc824ad1b9..6b7177cfdb7 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -36,7 +36,7 @@ This driver does not use Gaussian 16 interfacing code, as certain data such as f -`GaussianLogDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Runs the driver to produce a result given the supplied job control file. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.md index 40d7a5481cd..0e112c3acbd 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This result allows access to selected data from the log file that is not availab -`GaussianLogResult.get_watson_hamiltonian(normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult.get_watson_hamiltonian(normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Get the force constants as a WatsonHamiltonian diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.md index 9582539afdb..64e565da608 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -28,7 +28,7 @@ The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiski -`HDF5Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.md index 6289aa7eb45..928663b500f 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.md index 410096c76a9..3de633535df 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.md index ec18e83e10f..5796d2cf1bf 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ This module implements an interface for a driver-independent, i.e. generic molec -`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -56,7 +56,7 @@ end geometry -`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -76,7 +76,7 @@ end geometry -`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -96,7 +96,7 @@ end geometry -`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -116,7 +116,7 @@ end geometry -`classmethod Molecule.relative_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -136,7 +136,7 @@ end geometry -`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.md index d0a06fbbb14..ddb4af9d64d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -35,7 +35,7 @@ See [http://www.psicode.org/](http://www.psicode.org/) -`PSI4Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.md index 16d9f65e178..caea9901606 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -40,7 +40,7 @@ See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante -`PyQuanteDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.md index f4c64cdc041..55b44e98b06 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -42,7 +42,7 @@ See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) -`PySCFDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.md index 469b40c1e2a..6b4dc597ca3 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.md index 67d1f416cb9..1fb4cf470c9 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Creates an new instance of the result. :type points: `List`\[`float`] :param poi -`BOPESSamplerResult.point_results(point)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult.point_results(point)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") returns all results for a specific point. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.md index 767ebecf173..7a864fe5ae2 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.md index 71c4ad2f861..8a0b96613b1 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` @@ -66,7 +66,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`ElectronicStructureResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether dipole moment is present in result or not @@ -78,7 +78,7 @@ Returns whether dipole moment is present in result or not -`ElectronicStructureResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.md index cddb6391c36..cc2af141495 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.md index ce3d3d3d772..38002efdb4d 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.md index 3127a618daa..f908cca5d33 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -29,7 +29,7 @@ A vibronic Hamiltonian operator representing the energy of the nuclei in the mol -`BosonicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") **Parameters** @@ -47,7 +47,7 @@ Dict of hopping operators, dict of commutativity types and dict of excitation in -`BosonicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. In the fermionic case the default filter ensures that the number of particles is being preserved. @@ -59,7 +59,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`BosonicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -79,7 +79,7 @@ An vibronic structure result. -`BosonicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Transformation to qubit operator from the driver diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.md index bb6afdb8bce..58c401fa05c 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3ef9d847003..7b4deefdc79 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.md index 10bb4baa0fe..600ab26cb11 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -35,7 +35,7 @@ A transformation from a fermionic problem, represented by a driver, to a qubit o -`FermionicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -55,7 +55,7 @@ A tuple containing the hopping operators, the types of commutativities and the e -`FermionicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -69,7 +69,7 @@ In the fermionic case the default filter ensures that the number of particles is -`FermionicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -89,7 +89,7 @@ An electronic structure result. -`FermionicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.md index 2ae6f6416e7..fffc7533ce6 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.md index db32514f369..57e0ad41d45 100644 --- a/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.30/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for transformation to qubit operators for chemistry problems -`abstract Transformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -40,7 +40,7 @@ Returns: -`Transformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -52,7 +52,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`abstract Transformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -72,7 +72,7 @@ An “interpreted” eigenstate result. -`abstract Transformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.md index 8cd7b485d02..d3b4f754286 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.md index 634b2bed559..e53e9a58a06 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.md index bf25a7cff82..6bd13e1cfce 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.30/qiskit.circuit.Clbit.md index cf55bda3d15..43a6f8a46bd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.md index eb392cf3a31..092856d8c38 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -220,7 +220,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Delay.md b/docs/api/qiskit/0.30/qiskit.circuit.Delay.md index 4c0eed62094..ad694b6169a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Add classical condition on register or cbit classical and value val. @@ -91,7 +91,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -199,7 +199,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -215,7 +215,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.md index e05c34fb48b..02ce8f97850 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Gate.md b/docs/api/qiskit/0.30/qiskit.circuit.Gate.md index 59769962af3..2f5a5fba5e6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -110,7 +110,7 @@ Add classical condition on register or cbit classical and value val. -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -208,7 +208,7 @@ reversed. -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -306,7 +306,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -326,7 +326,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.30/qiskit.circuit.Instruction.md index 56dcacff5ea..df48ee72209 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add classical condition on register or cbit classical and value val. @@ -83,7 +83,7 @@ Add classical condition on register or cbit classical and value val. -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -105,7 +105,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -129,7 +129,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -137,7 +137,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") DEPRECATED: use instruction.reverse\_ops(). @@ -155,7 +155,7 @@ reversed. -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -165,7 +165,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -189,7 +189,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -209,7 +209,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -229,7 +229,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.md index 26139092e55..99238e090d4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -34,7 +34,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add condition on classical register to all instructions. @@ -42,7 +42,7 @@ Add condition on classical register to all instructions. -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Measure.md b/docs/api/qiskit/0.30/qiskit.circuit.Measure.md index 700d91f1abc..a57e26f4f61 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.30/qiskit.circuit.Parameter.md index 999790ae31b..da59ceeb105 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -175,7 +175,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.md index 1d8ee50f6ce..235fa17e288 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.md index f927e45c737..7828c4cbc07 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.md index 97a250f432d..3bdcf21d965 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla_0: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -135,7 +135,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -154,7 +154,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -162,7 +162,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -189,7 +189,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -287,7 +287,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is None, applies to all. @@ -295,7 +295,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`QuantumCircuit.bind_parameters(values, value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values, value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -323,7 +323,7 @@ copy of self with assignment substitution. -`static QuantumCircuit.cast(value, _type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, _type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -331,7 +331,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -351,7 +351,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -359,7 +359,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -367,7 +367,7 @@ Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -375,7 +375,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -383,7 +383,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -391,7 +391,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -419,7 +419,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -474,7 +474,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -500,7 +500,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -520,7 +520,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -536,7 +536,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -544,7 +544,7 @@ Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.C -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -552,7 +552,7 @@ Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -560,7 +560,7 @@ Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -568,7 +568,7 @@ Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -576,7 +576,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -584,7 +584,7 @@ Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -592,7 +592,7 @@ Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -600,7 +600,7 @@ Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -608,7 +608,7 @@ Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -616,7 +616,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -624,7 +624,7 @@ Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -632,7 +632,7 @@ Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -640,7 +640,7 @@ Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate -`QuantumCircuit.decompose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -656,7 +656,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -682,7 +682,7 @@ qiskit.Instruction -`QuantumCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’. @@ -729,7 +729,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -803,7 +803,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -811,7 +811,7 @@ Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -839,7 +839,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -847,7 +847,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -867,7 +867,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -887,7 +887,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -907,7 +907,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -923,7 +923,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -943,7 +943,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -951,7 +951,7 @@ Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1077,7 +1077,7 @@ circuit.draw() -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1183,7 +1183,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1191,7 +1191,7 @@ Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSw -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1261,7 +1261,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1269,7 +1269,7 @@ Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1277,7 +1277,7 @@ Apply `MCU1Gate`. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1312,7 +1312,7 @@ qiskit.Instruction -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -1334,7 +1334,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured. @@ -1356,7 +1356,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). @@ -1364,7 +1364,7 @@ Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -1384,7 +1384,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -1394,7 +1394,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1406,7 +1406,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1414,7 +1414,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -1422,7 +1422,7 @@ Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.Pha -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -1430,7 +1430,7 @@ Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.Pau -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -1457,7 +1457,7 @@ A circuit implementing this circuit raised to the power of `power`. -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -1484,7 +1484,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -1504,7 +1504,7 @@ List(tuple) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1524,7 +1524,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1551,7 +1551,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1578,7 +1578,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -1586,7 +1586,7 @@ Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -1594,7 +1594,7 @@ Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XG -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -1602,7 +1602,7 @@ Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXG -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurement on all qubits if they are present. Deletes the ClassicalRegister that was used to store the values from these measurements if it is idle. @@ -1624,7 +1624,7 @@ Returns circuit with measurements removed when inplace = False. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -1652,7 +1652,7 @@ Reset q. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -1698,7 +1698,7 @@ the circuit with reversed bit order. -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -1742,7 +1742,7 @@ the reversed circuit. -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -1750,7 +1750,7 @@ Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -1758,7 +1758,7 @@ Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -1766,7 +1766,7 @@ Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -1774,7 +1774,7 @@ Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -1782,7 +1782,7 @@ Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -1790,7 +1790,7 @@ Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -1798,7 +1798,7 @@ Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -1806,7 +1806,7 @@ Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -2179,7 +2179,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -2333,7 +2333,7 @@ with attached instruction. -`QuantumCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of gate operations in circuit. @@ -2554,7 +2554,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -2562,7 +2562,7 @@ Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapG -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -2570,7 +2570,7 @@ Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -2578,7 +2578,7 @@ Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgG -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -2586,7 +2586,7 @@ Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -2594,7 +2594,7 @@ Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -2647,7 +2647,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -2668,7 +2668,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -2689,7 +2689,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -2697,7 +2697,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -2705,7 +2705,7 @@ Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -2713,7 +2713,7 @@ Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -2721,7 +2721,7 @@ Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -2850,7 +2850,7 @@ Apply unitary gate to q. -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -2866,7 +2866,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -2874,7 +2874,7 @@ Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -2882,7 +2882,7 @@ Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.md index 631b64d0b63..722180a95cc 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.30/qiskit.circuit.Qubit.md index fd6ea387a2e..19f2145d2f9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.Reset.md b/docs/api/qiskit/0.30/qiskit.circuit.Reset.md index db36821fa59..d5ad125a0fa 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.md index 5575c46c0c3..cdc8153858e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -154,7 +154,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -302,7 +302,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -344,7 +344,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.md index ae94f80d436..fc8063c3c3d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -114,7 +114,7 @@ Add classical condition on register or cbit classical and value val. -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -298,7 +298,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -320,7 +320,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -356,7 +356,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 85a2a4729a6..690b52b4c36 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index c691288c43f..b79995d471d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.30/qiskit.circuit.library.AND.md index 648a2389ca2..7f2677e8362 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.md index 4a06432d594..4ab5adee456 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new barrier instruction. -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -45,7 +45,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Add classical condition on register or cbit classical and value val. @@ -53,7 +53,7 @@ Add classical condition on register or cbit classical and value val. -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.md index 23c145e9e74..b81d851ee9e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -36,7 +36,7 @@ Create a new 3-qubit controlled sqrt-X gate. -`C3SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C3X is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.md index 4f5eb579f84..dab626ac268 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.md index 0038fd79bca..53b513d6f96 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.md index f9854e01b74..d753960e13f 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.md index ea639de97f0..eeb3a99ef58 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.md index db9ad0a42b4..516204a66dd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -70,7 +70,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.md index 82f2112954e..d7d969d902e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.md index 0e942b081ea..d5ed8c39cb4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.md index 292afa15c6c..c381a22dfd4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.md index 56c6b377137..a847c538920 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.md index 98942079f30..5276c1ecf8d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.md index 1202f7eeba0..a21a2548b47 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.md index da4776b973c..7970d7e8a25 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.md index 17ef47f3306..a5743476752 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.md index 43b3ad8715d..906ec5cb3ce 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.md index 7b91c381efd..36131fed814 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.md index a378b4b80a7..c4b531b53e8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.md index 52efb1bfa37..24b88e1940c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.md index e7e2290cfc7..a9d87e54627 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.md index 2e490ea940e..69c00e1915b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.md index a953a4e9416..39b77eced97 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.md index 46381f1c63b..1840acc87f7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.md index 148ac42d178..d85c1f18dd6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.md index f7a3859659a..70d9c94e621 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.md index 4bcb1e1beac..1e1629743b4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.md index f4e892c337c..5ca272dd016 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.md index 4d2d9169916..2587327f214 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.md index 5a745088e3c..0efc064dc8a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GR.md index 7209ecc0e08..88471addd14 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.md index 71aa083afec..d71317a0cd6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.md index 6cc06a24d47..af1b23cd589 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.md index 8466600f053..d664f0e14c8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.md index 3a9588f99c8..2508e7ae1f6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.md index f7bf6ce118e..f4e6f51982c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.md index d24f0a4df5b..35169041b9c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.md index 500b209d60c..941dfdc7e08 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.md index 1f5fe56e5ea..9349598046e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.md index ab0a4176c1d..3f44eb54c23 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.md index 714318270c1..5a408089b5b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.md index 2c236db1c10..10d4c612562 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.md index 3d904625192..dafb19123ec 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.md index 9bc4122037a..17aae70d925 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.md index 74928b7d27a..42a3793e589 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.md index 3a1185f373c..a73e1a3c7ba 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.md index 426d49f6834..a1f966647ea 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.md index aeeda9cf0d0..cad9befc265 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.md index bc67b7ca908..09bff9dc82a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.md index 74b06fd9380..ed6c036caa1 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -56,7 +56,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.md index 18d5c37cb29..7e4aa6039f7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.md index 8dcdd3807ad..a89c06d33c9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.md index 935f91d10df..22d510c1ec4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.md index 0f11bf418ed..dc14bf47721 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.md index 00c1ed0cbf3..78cd4e05a36 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new measurement instruction. -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.md index def9356edec..d732503ade4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.md index 488a4caa893..6487b4a9504 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.30/qiskit.circuit.library.OR.md index f3ee7c97b11..aaf0af23333 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.md index 5c5e6f8db3b..f21509e9eb3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.md index 8a71080853b..e57682cb532 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.md index 7119daf7f7a..43289d23126 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.md index 00074ca10be..88ed0e5a328 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.md index 9a8009546db..f5a7b24e9d6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.md index fd53a6d8cab..32f9efd9359 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.md index 58771a39d73..166d3fa0577 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.md index a572e590b4a..30f2d3e13fe 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 94a1cfd492e..2ae019ee8ba 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 20b10508163..93cf5d80a58 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.md index 2ada624c39e..764103c3df9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.md index cafd21b595a..fa44d5455a8 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.md index 932311cba70..ebad93bf9dc 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.md index 4545b2500a6..eda2a66ffb5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.md index a4e6c90eeaf..694fc14293b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.md index 0e3f7bac634..b425c7d26d2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.md index 0db3218bc97..88734afdf67 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.md index eab5fe55fe1..9579e5419c2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.md index 6e023f33c0f..83948311cde 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.md index 128c18dcf46..bd51856b2e0 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.md index 2b46955c44e..88fd78628f6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.md index ef77affdaac..987786012e5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.md index 2f2035eae69..1f6ba208e32 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.md index fa44339fb50..0c6126f7086 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.md index e8244085f6b..30d6950547c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.md index 4cfbee61b1f..4593c6a22a4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.md index d38c6c1667b..3e2bbbcb12d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.md index 989de416035..2d3490388db 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.md index c20563ec423..6dd72cc2346 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new reset instruction. -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.md index c6a7b1e06cd..eedca638845 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.md index c657f0ee852..536757393e2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.md index a829101a023..8518ed4751c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.md index d913f0e62cd..2d08b505e5b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.md index f11d7eb6216..cc6e058caa2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.md index b8035708015..db12e700fda 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.md index d03585524b0..f611ea7a707 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.md index e3dbaeb72dd..80e87fb56a1 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.md index 4f10c56dc2b..a78f7f2c8e2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.md index a9e5a1e7145..3e8ada96707 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.md index d908894c93e..20690138ae9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.md index 09a37c12208..b5a4cf7ed64 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.md index 07bb23f2d15..0c4ca373ef7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.md index 25157118440..d89c12cca70 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.md index 7d5b28937ca..dd6717b85a0 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.md index f18f5ae21b2..d07a7109f78 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.md index 43e734f066e..c4211df1578 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.md index 21f9a64cd0c..a82778ecd28 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.md index c576b3ad645..f979263538b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.md index d1e1747e332..5d76044f233 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.md index df1ea433e53..2f1552e5317 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_1.md index 42cf538c532..22bd668f91f 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_2.md index 5bf66e9f98c..f2c5dd8fc10 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_3.md index 927f19fa200..94d8dfa34f4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_4.md index 8b16e2825d6..b22af4fca25 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_3_1.md index 2c09082d230..4fba3a33436 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_1.md index 07b3612de9c..ecf6ae0b847 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_2.md index 36856209e49..3c8360c05de 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_3.md index d0f5a22555e..b383502f2b2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_4.md index 57ae97f2a84..d05d911fcf2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_5_1.md index 570f78364e6..a13af44ea44 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_1.md index a9b3cb55224..ab33af8a64c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_2.md index 0a9966bb05d..5300850cc44 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_3.md index c979ff290d7..9d98315d660 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_4.md index e48a68c9e45..b60dac07ece 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_5.md index 69364d28f8d..04add82fbe3 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_1.md index 4e11397bbef..5023943cd35 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_2.md index 0485bc05efe..ced38daade6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_3.md index feaaa81f23c..caa0eaa3b81 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.md index 6b4367232a1..22826237cef 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_cy.md index bae210512c6..5cee06c07dd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_xz.md index 6111e4b6d65..41579dc8e27 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_yz.md index f5feb56c245..a09251daecb 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz1.md index f8a2218bc4b..cae37878081 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz2.md index d4d76d03eb4..4771308c6ef 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz3.md index 9ab0e123a91..92dcb301fc6 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index fccc60c5901..6901ced3335 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index bc9dfac625c..79f50d36359 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 9a0f1d6e2e0..8275bd14b9d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index a099d56f93c..6a139dddd79 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 199b0ba73fb..af90757559d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index d8f119d2cde..6a7e2cbba0e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 645f993d038..64eb9dbc638 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index b29f66cbbd3..7d5f16134f9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index cdfab95456d..28a9def5e19 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 42e44c71ccb..38eb6fe0f01 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f2bf2fb8ffd..bfa2880e791 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f5857f8be6d..7bc7fb49e7f 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 54d796c48ea..3c958322aef 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 497c7f651c8..d7857911c5c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 05dd1473bf2..500c3f9542b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index bf4346c45e9..506e1f4c1e5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 143ce700b60..575584da1f5 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index bddea475821..c21c0e0b10b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 1d23abdcba1..dfdf7f93c5e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 5e04b1587b2..31a4609876c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7f827c64901..ad51542d5c9 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 5fd5601a5c9..e8b1fd4612d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index c8b3b9b383b..d6a37940f1a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 5e36d6a1208..86f78e9c92a 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 1340401a8c0..88220d5de36 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 7d6a80af75b..b0ac097f194 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 9d72c54ca1a..19994762b62 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index cfb20db8ead..4e172dfcd3c 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8f053052c41..bf49584b47e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 0dbc8a78f8c..406a990948d 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 767dfc0dc71..4af3a1e4799 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index fbf1fac3a16..cbb0b73f437 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index e00e9a09031..d026edef43f 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 51fafdebc96..e2d6bdcc984 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 7c6acba7de7..9bd4b84a326 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 23417772375..736756f7008 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 1f41755ea0a..4bd9eac06cd 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index f66ad8c3ec1..d55f4e85b13 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 42e65f18b74..7d348ef65a4 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index dcdd118e19e..5c506c0d1a2 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 2eae01bb124..10b935ea263 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 4038dc3d507..83a8fd11254 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 705eded25a9..d07c214552b 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4c845969dab..68996fb600e 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index d55538e6a62..80d5f36a9d0 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 4865ff7af80..ca902b97814 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 03d25edc1ff..f2a903e2504 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.dump.md b/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.dump.md index 6e832dbf55e..b5c5db7be06 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.dump.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.dump -`dump(circuits, file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`dump(circuits, file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.load.md b/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.load.md index 5df021c72c7..f3b81e96362 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.load.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.qpy_serialization.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.load -`load(file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`load(file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.30/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.30/qiskit.circuit.random.random_circuit.md index e2917aed640..5e102d0ada7 100644 --- a/docs/api/qiskit/0.30/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.30/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.30/qiskit.compiler.assemble.md b/docs/api/qiskit/0.30/qiskit.compiler.assemble.md index 5ca3ef24c10..4fe7956f99a 100644 --- a/docs/api/qiskit/0.30/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.30/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.30/qiskit.compiler.schedule.md b/docs/api/qiskit/0.30/qiskit.compiler.schedule.md index 8e7a6cffa9f..6788dfb4f20 100644 --- a/docs/api/qiskit/0.30/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.30/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.30/qiskit.compiler.sequence.md b/docs/api/qiskit/0.30/qiskit.compiler.sequence.md index 5bfaf303b8b..4fceaa00aab 100644 --- a/docs/api/qiskit/0.30/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.30/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.30/qiskit.compiler.transpile.md b/docs/api/qiskit/0.30/qiskit.compiler.transpile.md index 3102cf09b2e..485f96f1b66 100644 --- a/docs/api/qiskit/0.30/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.30/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.30/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.30/qiskit.converters.ast_to_dag.md index 8523ba56ba5..e13421cfd0e 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.30/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dag.md index e2237388e01..af771d6b992 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dagdependency.md index 15a315afab9..ea1f2e076ca 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_gate.md index 9ec3011bd18..4ec8eb91504 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_instruction.md index ca7910f4bbb..1e403242771 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.30/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.30/qiskit.converters.dag_to_circuit.md index 9fd5e9df0d5..e87a0827eee 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.30/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.30/qiskit.converters.dag_to_dagdependency.md index 1659bc658dd..40903d9c45a 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.30/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_circuit.md index 8bc14e76d3b..a95b2c1d722 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_dag.md index 340e3d702ef..87bb9458172 100644 --- a/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.30/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.md index 494a5dfc982..54c4c701d79 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -112,7 +112,7 @@ the current max node -`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -139,7 +139,7 @@ the current max node -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -147,7 +147,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -155,7 +155,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -167,7 +167,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -200,7 +200,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.compose_back(input_circuit, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose_back(input_circuit, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: use DAGCircuit.compose() instead. @@ -208,7 +208,7 @@ DEPRECATED: use DAGCircuit.compose() instead. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -218,7 +218,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -228,7 +228,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -240,7 +240,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGNodes. @@ -248,7 +248,7 @@ Returns set of the descendants of a node as DAGNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -272,7 +272,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -294,7 +294,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.extend_back(dag, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.extend_back(dag, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: Add dag at the end of self, using edge\_map. @@ -302,7 +302,7 @@ DEPRECATED: Add dag at the end of self, using edge\_map. -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -329,7 +329,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -337,7 +337,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -353,7 +353,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -361,7 +361,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -377,7 +377,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -385,7 +385,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -393,7 +393,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -407,7 +407,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGNodes. @@ -415,7 +415,7 @@ Returns the longest path in the dag as a list of DAGNodes. -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -423,7 +423,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -431,7 +431,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -439,7 +439,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -459,7 +459,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -471,7 +471,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -492,7 +492,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -500,7 +500,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -508,7 +508,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -516,7 +516,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -537,7 +537,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGNodes. @@ -545,7 +545,7 @@ Returns iterator of the predecessors of a node as DAGNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -553,7 +553,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as DAGNodes. @@ -569,7 +569,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -577,7 +577,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -585,7 +585,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -593,7 +593,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -609,7 +609,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -619,7 +619,7 @@ Add edges from predecessors to successors. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -635,7 +635,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -645,7 +645,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -653,7 +653,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a DAGNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -680,7 +680,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -698,7 +698,7 @@ Replace one node with dag. -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGNodes. @@ -706,7 +706,7 @@ Returns iterator of the successors of a node as DAGNodes. -`DAGCircuit.threeQ_or_more_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.threeQ_or_more_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3-or-more-qubit gates: (id, data). @@ -714,7 +714,7 @@ Get list of 3-or-more-qubit gates: (id, data). -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -722,7 +722,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -738,7 +738,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.topological_op_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -754,7 +754,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.twoQ_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.twoQ_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. @@ -762,7 +762,7 @@ Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -770,7 +770,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.md index bb21501298e..5a90ee6e808 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.md index bcd32521e05..a1b007467cd 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.md index fa2fb46df2b..3b7a6b442e9 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.md index f1bc71320da..8347f948010 100644 --- a/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.30/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.md index 6e95a5df69a..12f758d29b9 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.30/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -121,7 +121,7 @@ Add classical condition on register or cbit classical and value val. -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -177,7 +177,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -327,7 +327,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -335,7 +335,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.30/qiskit.extensions.Initialize.md index b853a50324b..90caafc8c78 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.30/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -60,7 +60,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -111,7 +111,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. @@ -251,7 +251,7 @@ bool -`Initialize.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Initialize instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.md index d83db85713b..cc5cd584b18 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.30/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Add classical condition on register or cbit classical and value val. @@ -103,7 +103,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.md index b465d1acd69..a77284cbebb 100644 --- a/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.30/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -120,7 +120,7 @@ Add classical condition on register or cbit classical and value val. -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -128,7 +128,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -177,7 +177,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -327,7 +327,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -335,7 +335,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.md index ab5c5a443aa..ed05ecd5593 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.30/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 05de4ab6cb8..19f5413aa81 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -33,7 +33,7 @@ Constructor. -`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Adds corresponding sub-circuit to given circuit @@ -142,7 +142,7 @@ returns number of qubits controlled -`EuropeanCallDelta.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas @@ -150,7 +150,7 @@ returns required ancillas -`EuropeanCallDelta.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index 392aea5a2ca..9f5b6d2a1bb 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -35,7 +35,7 @@ Constructor. -`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`EuropeanCallExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") returns required ancillas @@ -160,7 +160,7 @@ returns required ancillas controlled -`EuropeanCallExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 316c8b5f2a0..e04857292ee 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.30/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -36,7 +36,7 @@ Constructor. -`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -145,7 +145,7 @@ returns number of qubits controlled -`FixedIncomeExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas @@ -153,7 +153,7 @@ returns required ancillas -`FixedIncomeExpectedValue.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas controlled @@ -161,7 +161,7 @@ returns required ancillas controlled -`FixedIncomeExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.md index fb1cdeb326d..5540c469166 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ To use the subclasses, please see [https://github.com/Qiskit/qiskit-tutorials/bl -`BaseDataProvider.get_coordinates()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_coordinates()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns random coordinates for visualisation purposes. @@ -38,7 +38,7 @@ Returns random coordinates for visualisation purposes. -`BaseDataProvider.get_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns the covariance matrix. @@ -58,7 +58,7 @@ an asset-to-asset covariance matrix. -`BaseDataProvider.get_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -78,7 +78,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -98,7 +98,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -118,7 +118,7 @@ a per-asset mean vector. -`BaseDataProvider.get_similarity_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_similarity_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns time-series similarity matrix computed using dynamic time warping. @@ -138,7 +138,7 @@ an asset-to-asset similarity matrix. -`abstract BaseDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`abstract BaseDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Loads data. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.md index 94753becaed..ad9fb1dd4b5 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -144,7 +144,7 @@ an asset-to-asset similarity matrix. -`DataOnDemandProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.md index e1cc0617a79..d67f4ff88e0 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -143,7 +143,7 @@ an asset-to-asset similarity matrix. -`ExchangeDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.md index 1bcbc4c4948..4d6bbfd435a 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -140,7 +140,7 @@ an asset-to-asset similarity matrix. -`RandomDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Generates data pseudo-randomly, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.md index 52aba5452c7..4828fddcb3f 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.md index f19acad7323..54b205c6808 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`WikipediaDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.md index 2ee584d5c10..f205961b05b 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.30/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`YahooDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.md index dd9d483900a..35f05b36244 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.md index d0f88c08567..0d3fdafef06 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.md index 90e5c8b58f0..7aec65b5119 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.md index fd940e7ee8c..d5e4b734fc6 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.md index c71f6cc0b9a..8d56ebaf63c 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.md index 1cec73b08a3..419df9ac5b1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.md index 2242b5d8764..c057d7d091d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.md index d02ec6dd010..a155df678ed 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.md index c18ff34c92c..2ffb7fe61bb 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.md index 46efe0157ed..5a997c28987 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.md index b7627d45203..b011b738b4d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.md index 3a8aa5098ec..ae5f847fa56 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.30/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.md index 3922362b0f9..b41fdc9b1dc 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.md index 033560eff61..56e9976dfe2 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.md index 54364b12efc..c695dc4b508 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.md index 8584a3a690f..49fe9e2c3c1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.md index 40d7957630a..4b6c2e26112 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.md index ba4bd514893..387f010961b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 3d6f722a7e0..452e3277c6d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.md index 93de99f8d05..eba4d8a9ad6 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 334088e40ef..d3bcce556c0 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0ca0b7b67c0..b3cb9710f5c 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.md index 0f3bba86927..d072e158644 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 57a69ef51fa..2f83a375cb5 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.md index 4bc47d26b5b..a69d4e77ba6 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 49e3ba02622..15cd48b959a 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.md index 2b0a1ce3bd7..d4b3fe51512 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.md index a4bb48a9b8e..ed39147d0d5 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index 7af372629b4..072561c44b8 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.md index 5dc44ca0492..2b8d0b699ec 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -55,7 +55,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.md index 4d41f6e5e23..0577877a3bf 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence @@ -36,7 +36,7 @@ This function computes the bound on variation distance based and the confidence -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single protocol run of accreditation protocol on simul backend diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.md index 01718a5447a..854522ad63e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.md index 7f5ca421e29..ccacdd777f0 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` @@ -29,7 +29,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate transpose of the CNOTDihedral element @@ -37,7 +37,7 @@ Return the conjugate transpose of the CNOTDihedral element -`CNOTDihedral.cnot(i, j)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.cnot(i, j)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. @@ -45,7 +45,7 @@ Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the composed operator. @@ -76,7 +76,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate of the CNOTDihedral element. @@ -92,7 +92,7 @@ Make a deep copy of current operator. -`CNOTDihedral.dot(other, qargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.dot(other, qargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the right multiplied operator self \* other. @@ -118,7 +118,7 @@ The operator self \* other. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: other tensor self. @@ -138,7 +138,7 @@ the tensor product operator: other tensor other. -`CNOTDihedral.flip(i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.flip(i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply X to this element. Left multiply the element by X\_i. @@ -146,7 +146,7 @@ Apply X to this element. Left multiply the element by X\_i. -`CNOTDihedral.from_circuit(circuit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.from_circuit(circuit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -178,7 +178,7 @@ Return tuple of input dimension for specified subsystems. -`CNOTDihedral.is_cnotdihedral()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.is_cnotdihedral()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return True if input is a CNOTDihedral element. @@ -194,7 +194,7 @@ Return tuple of output dimension for specified subsystems. -`CNOTDihedral.phase(k, i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.phase(k, i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply an k-th power of T to this element. Left multiply the element by T\_i^k. @@ -252,7 +252,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: self tensor other. @@ -272,7 +272,7 @@ the tensor product operator: self tensor other. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -297,7 +297,7 @@ Decompose 1 and 2-qubit CNOTDihedral elements. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -305,7 +305,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -313,7 +313,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert to an Operator object. @@ -321,7 +321,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the transpose of the CNOT-Dihedral element. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 754b7eacb30..8b2163e96d9 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.md index b18f6f79193..d7854d7e13b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.md index 62ed38a919d..cb084321e40 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. @@ -56,7 +56,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -76,7 +76,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -96,7 +96,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -120,7 +120,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.md index e82966c03c0..5be47257523 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.md index 3d42ae904cb..087a91924f8 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.md index b74bafa3b11..41820f2d520 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.md index 751d05ee71f..92bd314c40e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.md index 1454540bb20..55810cc5d2f 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.md index 397eae2c7c4..d43065093ae 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.md index a7421af715c..9c90d276cbf 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -47,7 +47,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -71,7 +71,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -79,7 +79,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(reset=True, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(reset=True, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -92,7 +92,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.md index 69e323d90d6..80681d4d48a 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.md index 9ec254be6af..8a8b513d769 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.gates_per_clifford.md index 922ea7355c4..7ede68322ac 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.md index 48ddbc46318..aba1aa0cd21 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.30/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -123,7 +123,7 @@ a handle to the instruction that was just added -`RawFeatureVector.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Call the initialize instruction. @@ -139,7 +139,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`RawFeatureVector.bind_parameters(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.bind_parameters(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bind parameters. diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.30/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.30/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.30/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.30/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.md index 56fc97fec81..0773653dca8 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -194,7 +194,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -210,7 +210,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -234,7 +234,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -250,7 +250,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -262,7 +262,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -286,7 +286,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -306,7 +306,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -318,7 +318,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -334,7 +334,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -346,7 +346,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.md index 28c74b79a54..815ea7ecdde 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.30/qiskit.opflow.anti_commutator.md index 3898db790be..85f54d4274f 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.commutator.md b/docs/api/qiskit/0.30/qiskit.opflow.commutator.md index fee5b93b02a..d2172385ff8 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.md index a00d134ed2c..7ef1f6a17ab 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.md index f2d2e759eed..0a26367547b 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.md index e3684e8963c..ff8184df7d4 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.md index 72f672de34f..573cf535bb1 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.md index 325cb11c1d4..a0e53dbd895 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.md index 93a5e86999e..f2e0bf2a7d2 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.30/qiskit.opflow.double_commutator.md index 4bdc73dda07..b683221f214 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.md index bba55129dca..4fa5d784a81 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.md index ae71ca2719c..54addd5040b 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.md index 4e93b0b8f51..0600758b9f7 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.md index 8993a5179ad..a155c64b246 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c8094df0d06..7be00afa27c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.md index 78ae73fad20..acf94d9f7f3 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.md index e846c732386..2f1524def39 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.md index e781c2e76c8..a33d03b8132 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.md index 95c23779df5..ca6f0b7f2ca 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.md index 161563dd794..dd6c75a56ac 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.md index 79cea305c20..b1225040f62 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.md index 5975abbdf52..5e9dfcf4211 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.md index 33966301d47..b5a981655a4 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.md index afcaea6d4a0..3a013bc4cdd 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.md index f6b8202b43d..79427656c9e 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.md index c07db9f3256..c0b89e29978 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.md index d6afd8ebc0b..0d9fc2a38a1 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.md index f375c3475b6..6b3474abd7c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.md index 598fc181127..20bfc03a64d 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.md index 850df331191..0e6796aed84 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.md index 8d79589afe0..75514ddeefd 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.md index 352d43dd268..3b55901f378 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.md index f4ac8a832c8..e81a6901eab 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.md index 11e541cabb8..78c8e24e3e3 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.md index 08944253b50..68b117566d3 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.md index 407fe1b1b01..15e5bb9139f 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.md index 03cc0694b50..2fcddfb0d4e 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.md index 7f1a289097d..2b91bd07914 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.md index 1d21cfa23b8..107a83d4489 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.md index 773dac11de7..a9b207588fd 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.md index 38ff1eda070..2d0c23c165a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.md index 2b3d38ad8d7..462397fa0d4 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.md index a6a95e2a19d..1b5d915c986 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.md index 27e7660a535..f34c50c98a2 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backend by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -183,7 +183,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -205,7 +205,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -249,7 +249,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -265,7 +265,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -286,7 +286,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -310,7 +310,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -322,7 +322,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -338,7 +338,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -350,7 +350,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.md index adc7134555c..82498bf1023 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index e79d5a51100..2cab71b234e 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.md index 7b5e72bf7c5..5d5d896f45c 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -65,7 +65,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -81,7 +81,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -89,7 +89,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.md index e4d35b103db..4f8ca4cb019 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.md index e1dd3b4e91f..0f322c553c8 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.md index 9206389fb7c..d8cf52cf557 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.md index 33a6664f407..94f60abcd8a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.md index 5e032defd82..039a65f1aed 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.md index 315df2f89ad..a61562894fe 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.md index 5e6a01d2378..d8f21000943 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.md index 9372d7fff09..8fe6bc0d377 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.md index bdaf05c904f..0dc04028355 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 3c0ddee770b..52040836598 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.md index 8c263ce4d89..16b8400a0a4 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -36,7 +36,7 @@ Optimization on Classical and Quantum Computers. arXiv preprint arXiv:2001.02069 -`ADMMOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -80,7 +80,7 @@ Returns True if the problem is compatible, False otherwise. -`ADMMOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Tries to solves the given problem using ADMM algorithm. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.md index 023564a13d5..d3f3337be92 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.md index 1ce1e212854..9175824d009 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.md index 49ea17d7f80..284d526dbdf 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -49,7 +49,7 @@ This initializer takes the algorithmic parameters of COBYLA and stores them for -`CobylaOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -112,7 +112,7 @@ The result of the multi start algorithm applied to the problem. -`CobylaOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.md index 56cf574ed45..b07f8629871 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -45,7 +45,7 @@ Initializes the CplexOptimizer. -`CplexOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -87,7 +87,7 @@ Returns True if the problem is compatible, False otherwise. -`static CplexOptimizer.is_cplex_installed()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`static CplexOptimizer.is_cplex_installed()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Returns True if cplex is installed @@ -95,7 +95,7 @@ Returns True if cplex is installed -`CplexOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.md index f8bec039b40..4f2e129b671 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.md index 0d195bd9c3c..65f95718e35 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -34,7 +34,7 @@ Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. -`GroverOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -76,7 +76,7 @@ Returns True if the problem is compatible, False otherwise. -`GroverOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Tries to solves the given problem using the grover optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.md index c3841732628..7172485413c 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index 0c583aca782..9ede7545b9d 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` @@ -32,7 +32,7 @@ Minimum Eigen Optimizer Result. -`MinimumEigenOptimizationResult.get_correlations()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult.get_correlations()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Get \ correlation matrix from samples. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 7b6b8077e7c..54fc420dd2e 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -53,7 +53,7 @@ This initializer takes the minimum eigen solver to be used to approximate the gr -`MinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -95,7 +95,7 @@ Returns True if the problem is compatible, False otherwise. -`MinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.md index 858b2d9f97a..cf70df4393e 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` @@ -69,7 +69,7 @@ Returns True if the problem is compatible, False otherwise. -`MultiStartOptimizer.multi_start_solve(minimize, problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer.multi_start_solve(minimize, problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Applies a multi start method given a local optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 3a5a2cd46a1..a9163ab5585 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for optimization algorithms in Qiskit’s optimization module. -`abstract OptimizationAlgorithm.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -42,7 +42,7 @@ Returns the incompatibility message. If the message is empty no issues were foun -`OptimizationAlgorithm.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -62,7 +62,7 @@ Returns True if the problem is compatible, False otherwise. -`abstract OptimizationAlgorithm.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.md index a6aa4c989d0..014e77d6c41 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.md index 8bf9832d57f..21613d9ecb6 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index 24c7b4a162f..12d0272ee2d 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index b292156eee5..99c4d5f3534 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -64,7 +64,7 @@ This initializer takes a `MinimumEigenOptimizer`, the parameters to specify unti -`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -106,7 +106,7 @@ Returns True if the problem is compatible, False otherwise. -`RecursiveMinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Tries to solve the given problem using the recursive optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 34ca60acc3c..f8cd40fe775 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.md index d6d8d5db9ae..7136c317531 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -62,7 +62,7 @@ This initializer takes the algorithmic parameters of SLSQP and stores them for l -`SlsqpOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -125,7 +125,7 @@ The result of the multi start algorithm applied to the problem. -`SlsqpOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.md index b4da60e7fe8..f494851b386 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.md index e35345c4ba8..3818968c838 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -47,7 +47,7 @@ To chose the type of slack variables. There are 3 options for mode. -`InequalityToEquality.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a problem with inequality constraints into one with only equality constraints. @@ -73,7 +73,7 @@ The converted problem, that contain only equality constraints. -`InequalityToEquality.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a result of a converted problem into that of the original problem. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.md index e4a3c3ccc94..6c224c3b544 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -41,7 +41,7 @@ Annealers. arxiv.org:1706.01945. -`IntegerToBinary.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert an integer problem into a new problem with binary variables. @@ -65,7 +65,7 @@ The converted problem, that contains no integer variables. -`IntegerToBinary.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert back the converted problem (binary variables) to the original (integer variables). diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.md index b71a8baad93..202c4ef38d3 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -26,7 +26,7 @@ Convert a problem with only equality constraints to unconstrained with penalty t -`LinearEqualityToPenalty.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with equality constraints into an unconstrained problem. @@ -50,7 +50,7 @@ The converted problem, that is an unconstrained problem. -`LinearEqualityToPenalty.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert the result of the converted problem back to that of the original problem diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.md index 7eda37a7c99..f2077921bc9 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for converters of quadratic programs in Qiskit’s optimizatio -`abstract QuadraticProgramConverter.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Convert a QuadraticProgram into another form and keep the information required to interpret the result. @@ -34,7 +34,7 @@ Convert a QuadraticProgram into another form and keep the information required t -`abstract QuadraticProgramConverter.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Interpret a result into another form using the information of conversion diff --git a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.md index 630ff285c33..d602667802d 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -37,7 +37,7 @@ Convert a given optimization problem to a new problem that is a QUBO. -`QuadraticProgramToQubo.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a problem with linear equality constraints into new one with a QUBO form. @@ -61,7 +61,7 @@ The problem converted in QUBO format. -`static QuadraticProgramToQubo.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`static QuadraticProgramToQubo.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -83,7 +83,7 @@ A message describing the incompatibility. -`QuadraticProgramToQubo.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a result of a converted problem into that of the original problem. @@ -103,7 +103,7 @@ The result of the original problem. -`QuadraticProgramToQubo.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.md index 6aaa1e61bcd..f07e10ec8f4 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ Initializes the constraint. -`abstract Constraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`abstract Constraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Evaluate left-hand-side of constraint for given values of variables. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.md index b1fa58edc45..8b2d46fded4 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -30,7 +30,7 @@ Representation of a linear constraint. -`LinearConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.md index c4afeea8ae0..e778ec5c833 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The linear expression can be defined via an array, a list, a sparse matrix, or a -`LinearExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the linear expression for given variables. @@ -51,7 +51,7 @@ The value of the linear expression given the variable values. -`LinearExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the gradient of the linear expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient of the linear expression given the variable values. -`LinearExpression.to_array()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_array()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as array. @@ -87,7 +87,7 @@ An array with the coefficients corresponding to the linear expression. -`LinearExpression.to_dict(use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_dict(use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as dictionary, either using variable names or indices as keys. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.md index 880f9867257..1424ae8c13a 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -33,7 +33,7 @@ Constructs a quadratic constraint, consisting of a linear and a quadratic term. -`QuadraticConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.md index 9ec54d30e0e..4b406447014 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The quadratic expression can be defined via an array, a list, a sparse matrix, o -`QuadraticExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the quadratic expression for given variables: x \* Q \* x. @@ -51,7 +51,7 @@ The value of the quadratic expression given the variable values. -`QuadraticExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the gradient of the quadratic expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient quadratic expression given the variable values. -`QuadraticExpression.to_array(symmetric=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_array(symmetric=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as array. @@ -91,7 +91,7 @@ An array with the coefficients corresponding to the quadratic expression. -`QuadraticExpression.to_dict(symmetric=False, use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_dict(symmetric=False, use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as dictionary, either using tuples of variable names or indices as keys. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.md index d572d67bf56..f566abbc987 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -32,7 +32,7 @@ Constructs a quadratic objective function. -`QuadraticObjective.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the quadratic objective for given variable values. @@ -52,7 +52,7 @@ The value of the quadratic objective given the variable values. -`QuadraticObjective.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the gradient of the quadratic objective for given variable values. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.md index 331b06a13ea..58a09ecaa2f 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.md index f819786e881..6a652de761a 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.md index 224ffcab330..dd93ab6a778 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -38,7 +38,7 @@ The variables is exposed by the top-level QuadraticProgram class in QuadraticPro -`Variable.as_tuple()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable.as_tuple()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Returns a tuple corresponding to this variable. diff --git a/docs/api/qiskit/0.30/qiskit.providers.Backend.md b/docs/api/qiskit/0.30/qiskit.providers.Backend.md index 8f8b2617abf..5d43bc5af2e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.30/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.md index 624c3efa4ac..37527a2e10f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.30/qiskit.providers.BackendV1.md index 7982b298902..c1d3b6527a0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.30/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.md index de4e1e24d13..c2724f27642 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.30/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.30/qiskit.providers.BaseJob.md index 84da9924fa4..b915fd12e9f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.md index 5a3be2cefee..2823a2f7486 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.30/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.30/qiskit.providers.Job.md b/docs/api/qiskit/0.30/qiskit.providers.Job.md index 63659a6fffd..f3bbce8abc6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.30/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobError.md b/docs/api/qiskit/0.30/qiskit.providers.JobError.md index c451db25471..34cdf601cd6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.30/qiskit.providers.JobStatus.md index 5b2f11fd019..c234d5ec2ff 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.30/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.md index 5cd9186bd93..e190fbd84cd 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.30/qiskit.providers.JobV1.md b/docs/api/qiskit/0.30/qiskit.providers.JobV1.md index 8a10a273119..9e8e5d7ee99 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.30/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.30/qiskit.providers.Options.md b/docs/api/qiskit/0.30/qiskit.providers.Options.md index ac32ae67834..006e6291d63 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.30/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Bases: `types.SimpleNamespace` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.30/qiskit.providers.Provider.md b/docs/api/qiskit/0.30/qiskit.providers.Provider.md index 968e515262f..bfcea8694aa 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.30/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.md index 2b87bbfd5ec..2e5188b77e3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.md index ed7ccfe563b..5e7acf5c172 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.md index e73f1efd60e..edbb37c6d86 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.md index 26bfd13c4cc..199c977d93a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.md index 9e330f42d8b..3735043373f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -162,7 +162,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -170,7 +170,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -186,7 +186,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -220,7 +220,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -228,7 +228,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -335,7 +335,7 @@ This method should be extended by sub classes to update special option values. -`AerSimulator.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Set the simulator options diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.md index 35c5903ba27..0f6694ec091 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -147,7 +147,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -205,7 +205,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -231,7 +231,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.md index 63ed447eb44..e80c83b2432 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -141,7 +141,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -149,7 +149,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -165,7 +165,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -199,7 +199,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -322,7 +322,7 @@ This method should be extended by sub classes to update special option values. -`QasmSimulator.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Set the simulator options diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.md index ec72c4a0837..bc7daccfffa 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -73,7 +73,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -81,7 +81,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -246,7 +246,7 @@ This method should be extended by sub classes to update special option values. -`StatevectorSimulator.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Set the simulator options diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.md index c452464ae07..caf6b4d7728 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -247,7 +247,7 @@ This method should be extended by sub classes to update special option values. -`UnitarySimulator.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Set the simulator options diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.md index bd09b928a2b..14911530532 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -107,7 +107,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -115,7 +115,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 79b02f0dd1c..28a05cec894 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 1677292f0f7..5c29d00998b 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 47dcb71f194..92bbd042bff 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.md index b91c0717c6f..cbb222737f5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.md index b82a02aae95..2f3b7dd1c3c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.md index 769df845673..3fa77df13d8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.md index 354de533212..2643ef10f37 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.md index 2f084af6024..14674abb5db 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.md index e20f410d2b8..254595e1e9a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.md index ff1c118b222..306a5e8b853 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.md index e7d38aafa3d..ebe8a598f45 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 30a2d26ecec..ead7a8ab0a8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.md index db64cb57ee9..f4df6a88c6a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.md index 18382603f71..8d742cc756e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.md index 22b425d8341..79cbc45cc27 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.md index 9c77eba94d7..24af3581d0e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.md index b8b38a17639..79aea308a9e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.md index 0d4023041c8..e4394dd1499 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.md index e759602c281..0eeb3724bde 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.md index 0d8ad8e8c82..497ab39b422 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.md index 020d0728ea7..ac08ffe9fc5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.md index 1e490ce4ef7..12a0944942d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.md index 2ba6b03db6e..8c51f05fc21 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.md index b0582a7713b..66007879890 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.md index 79d105c1369..f6d60e6d579 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.md index 22e1e4de639..8ec98e46380 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.md index 35c61148419..cefa258d9de 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes.md index d0fd751daa9..f6f88f92a8a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes_squared.md index c8e82191ee3..9e69b08814e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_density_matrix.md index c292865e173..b7fe6d72ad4 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value.md index afb0aa6b5cd..b5d6c393030 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value_variance.md index cad935698d1..540f5a6fa5c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_matrix_product_state.md index ad9329fb5b6..042515e636f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities.md index 98709e41a00..c74bc7fb192 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities_dict.md index 232f5123a85..1d2c6e7628c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_stabilizer.md index caa96c0dad7..c9bae83161e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_state.md index 5b43901211e..38b617016f0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector.md index 910688c4069..25ff84a6e48 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector_dict.md index 3e042263bd0..af529254e93 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_unitary.md index 3900cf9ef44..d223f5969b0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_density_matrix.md index 62f93bfba5c..04a01d89e8d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_matrix_product_state.md index 07cb9ac48f9..0fe380ec195 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_stabilizer.md index 47ce108bc7f..ca1043a2443 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_statevector.md index caf2c8ae80d..97f9f6e64c8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_superop.md index a71d2be2b79..2de685817f9 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_unitary.md index 318fc9eccab..e6946858c46 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.md index b7e7e1dd885..591edcd2526 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.md index be262c84116..ff22ab5d765 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel other \* self. @@ -85,7 +85,7 @@ The composition error channel. -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -93,7 +93,7 @@ Make a copy of current QuantumError. -`QuantumError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel self \* other. @@ -118,7 +118,7 @@ The composition error channel. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -143,7 +143,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -167,7 +167,7 @@ the tensor product error channel other ⊗ self. -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if current error object is an identity @@ -175,7 +175,7 @@ Return True if current error object is an identity -`QuantumError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the compose of a error channel with itself n times. @@ -199,7 +199,7 @@ the n-times composition error channel. -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -207,7 +207,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -215,7 +215,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -239,7 +239,7 @@ the tensor product error channel self ⊗ other. -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -247,7 +247,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -255,7 +255,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.md index b2ceb8ec9cd..98829a8f1d2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -81,7 +81,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -89,7 +89,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -114,7 +114,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -138,7 +138,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -146,7 +146,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -170,7 +170,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -178,7 +178,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -186,7 +186,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -210,7 +210,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -218,7 +218,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.amplitude_damping_error.md index 8e9e6295d9e..dd2ff84f6d0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.coherent_unitary_error.md index 75525914a49..84e4b8ec014 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.depolarizing_error.md index 85a1d7c9498..68d139e8b8c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ee7da332025..25ae7882329 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index f364dd25f2d..3b481f5b563 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_error_values.md index 3ae2a2ff174..d0943efa790 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_length_values.md index 1b13b72489b..892fe67f613 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_param_values.md index 918d4b8a054..93fb9036ea3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.readout_error_values.md index e59808902fb..0fadf024f1e 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index 0bacf85f54f..4785b2029bb 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.kraus_error.md index 44ca93fb5ca..90bd27c8bba 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.mixed_unitary_error.md index 3d5c9582a90..111474c892d 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.pauli_error.md index 6d368a98133..ccfd737e3c1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index 1e5fd78c8b6..a2f2c78e418 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_damping_error.md index 01e831a17d9..162563bfad3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.reset_error.md index a254e39f831..63de275e22f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.thermal_relaxation_error.md index 677c791119f..36c3b22a0d8 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.md index f80a4e6e134..65f4da8ad16 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.duffing_system_model.md index 24d251b1714..d6036ef8fd1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.md index a79f3f36e95..4e5fc535530 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Transforms one quantum channel to another based on a specified criteria. -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_noise_model.md index 6ac6827b3e9..1ca9fe60950 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_quantum_error.md index cd5acf0deb7..ca9a30e2885 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.insert_noise.md index c9c0300ea59..c29fc6f23ab 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.remap_noise_model.md index 64a6012ca37..8bbffc11ecc 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.30/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.md index 1a9600d9787..274cabb8be7 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.md index 6b901b10024..a1a30ea5642 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.md index dbdc2b1476c..32a5b314e49 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.md index 933a7deb632..2c5d6fe17c3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.md index dc2fded523b..698c76540f4 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.md index a75d9051fba..14c43d97a79 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.30/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.md index 4344bb2e5cb..7e3ed1777f2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.md index ca761e46dff..af2d883e17c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index cec4fc42466..2ee0be8c182 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 79af09762a4..e591719edca 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 449019be974..ec1e890b4b6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index e46178b9eef..c861952d391 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.md index af17e0db07d..61bbe741a1f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index ec4f905db80..e32f5b1ed50 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.md index be873e03180..f7721361b3c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -475,7 +475,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.md index 44fc5a3efc3..abc7002f7c7 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index e0a13181d11..a458969e0bb 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.md index fcba3e1a657..2ca562e58e6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.md index 9327d29ea98..f9b897d46d2 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -159,7 +159,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -175,7 +175,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.md index 037d67d23f9..688f3811ebf 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.md index a7e204ec3f6..b9d74788f50 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.md index 01ddd5b7006..18339de39e3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.md index 644b1b68ab9..f8de9e2c040 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.md index 624528d03b4..b47c5c445df 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.md index ad3307c4e13..6e656824dfc 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.md index d60cb444c0e..01071a482fd 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 647eae1a554..4f9a9b4815c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 3f0dd9e7ec1..19f0da305cb 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.md index 9ee42782350..a1afb8b755b 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index c0b8d4ef509..8f51705054a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index 6431153f5c8..32c9cc9a320 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.md index ad0313c9c8a..c6cc11b7cfe 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 3c727bf7209..9563c0861f6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -258,7 +258,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -290,7 +290,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -314,7 +314,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -338,7 +338,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -363,7 +363,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -387,7 +387,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -413,7 +413,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -493,7 +493,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -520,7 +520,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -542,7 +542,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -570,7 +570,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -615,7 +615,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.md index 0bbf974c710..1190f984155 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.md index f281293da41..f6195f25602 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.md index 207791c1b94..cfb66ace3ce 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.md index b9344955f03..e2f9c4f619a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.md index e48c8971f18..ca1f808bd83 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index a727797656b..b9977038acc 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index f35cfcbaef8..cf44eaed545 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.md index 28a38bd7e9d..581c93cf40f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.job_monitor.md index ee8b745104e..dd2fdcb3763 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.least_busy.md index edd2b10418d..4aa14f40398 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.md index 212b2bc7e0d..70f0139468f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 00d3e7a0aa0..35ae7fcf8cd 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index fdf6b78f09e..58ce03df4d6 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index a82c0055676..544d01fc368 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 67a33878a32..c4658b1a63f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index a9c04f26edf..c0d48ca651b 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 15e13ac66f2..3d1ac65151b 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.md index 9f10b5bcd7a..2a40ccd12bd 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.md index cc10166e22f..a3d4266727a 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.md index c3cbb54f4d9..e270d54bbbb 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.md index 0b9bda90a4a..17470e86e6f 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` @@ -49,7 +49,7 @@ BaseRandomService constructor. -`CQCExtractor.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Retrieve a previously submitted job. @@ -69,7 +69,7 @@ A `CQCExtractorJob` instance. -`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Process input data synchronously. @@ -95,7 +95,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the first extractor asynchronously. @@ -122,7 +122,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the second extractor asynchronously. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.md index c361511ac71..0fc73da8a08 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ CQCExtractorJob constructor. -`CQCExtractorJob.block_until_ready(timeout=None, wait=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.block_until_ready(timeout=None, wait=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Wait for the job to finish and return the result. @@ -70,7 +70,7 @@ Extractor output. -`CQCExtractorJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Query the server for the latest job status. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.md index 38d16e02439..bcab27e67da 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ IBMQRandomService constructor. -`IBMQRandomService.get_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.get_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return the random number service with the given name. @@ -60,7 +60,7 @@ Service with the given name. -`IBMQRandomService.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return all random number services available to this account. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 490b359f225..c9a85d885a5 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -162,7 +162,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -180,7 +180,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -196,7 +196,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -224,7 +224,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -246,7 +246,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -283,7 +283,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -305,7 +305,7 @@ Sets a program’s visibility. -`IBMRuntimeService.upload_program(data, metadata=None, name=None, max_execution_time=None, description=None, version=None, backend_requirements=None, parameters=None, return_values=None, interim_results=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None, name=None, max_execution_time=None, description=None, version=None, backend_requirements=None, parameters=None, return_values=None, interim_results=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 1baa09f210c..c5242b903f3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(params)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(params)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.md index b2514045a61..5118a383641 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.md index 64e9a2dedec..0879e146e24 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index b2cbda219da..ef0ab3ab931 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index c22f600387f..a311a1f4a90 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.md index c0bfc2940e1..87f09246ae4 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -54,7 +54,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -70,7 +70,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -87,7 +87,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -99,7 +99,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -115,7 +115,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -131,7 +131,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -155,7 +155,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -181,7 +181,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -197,7 +197,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -224,7 +224,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 9188c5c94c2..4612f139b27 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -75,7 +75,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.md index b85acf7fdcd..c92663f50d1 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.seconds_to_duration.md index 0bd2b10b6d7..c8a8e87a466 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.to_python_identifier.md index 2dfbfed663d..3fdcd9b46a3 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.update_qobj_config.md index 92a68f9f19a..bf644e78ed0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.utc_to_local.md index 669e2de5b50..f07c209fbf7 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.validate_job_tags.md index 79b9de18509..a9908753502 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.30/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.16/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.md index 1194041a160..a98f84d7d25 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.md index 95a5a196fdd..23cc125a1dc 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Create a new Gate object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.md index 2a77cb0018c..c8310dbaea0 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.Command.md b/docs/api/qiskit/0.30/qiskit.providers.models.Command.md index d59f62fa357..0064c29ba84 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.md index f2567400f56..84751abd71c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.md index fec2e864f50..00e71ba5b63 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.md index 6c8cbdaf67b..2b7d9d81202 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.md index 5b451249c5b..3d849f6b642 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.md index 03a572c07fa..dc79f529a51 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.md index c5e76ea2756..8a7866e606c 100644 --- a/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.30/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.30/qiskit.pulse.Acquire.md index e81c9ad04e6..ddbc145a70a 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.md index c0c426ea242..29f34ba6a0f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Call.md b/docs/api/qiskit/0.30/qiskit.pulse.Call.md index 7799d85e74d..5984caf0764 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Constant.md b/docs/api/qiskit/0.30/qiskit.pulse.Constant.md index 4d938607047..02184ee1aa7 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.md index b4dba6f160f..2b778a25c38 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Delay.md b/docs/api/qiskit/0.30/qiskit.pulse.Delay.md index 5b1c53a52df..a14b028f5ee 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Drag.md b/docs/api/qiskit/0.30/qiskit.pulse.Drag.md index 43b41cc3adb..c88bb9a600e 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.md index e76436c993a..195322c688f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.md index e702d836cdd..41a84546aec 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.md index 7f8a3a3f7fd..f3631d07c9b 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.30/qiskit.pulse.Instruction.md index ed76521b1e2..f15a0f63b7c 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.md index 1151ecd4dfb..ffd9fd4586f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -170,7 +170,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -192,7 +192,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -216,7 +216,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.md index 37f7f62aa03..01fcf813f1a 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.md index 9ac277595cf..63bf5b6d97b 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Play.md b/docs/api/qiskit/0.30/qiskit.pulse.Play.md index da5ab8a6b88..74c3dc0b374 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.30/qiskit.pulse.PulseError.md index 4a3cdeb7c7e..2bcf25644bf 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.md index 09a49766530..42277f2ac23 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.30/qiskit.pulse.Schedule.md index 26facb29dff..bdfb1e94a0f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -239,7 +239,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -264,7 +264,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -287,7 +287,7 @@ If no arguments are provided, `self` is returned. -`Schedule.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Deprecated. @@ -299,7 +299,7 @@ Deprecated. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -321,7 +321,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -346,7 +346,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -365,7 +365,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -377,7 +377,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -438,7 +438,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.md index 6be4597cd35..4ea0dfc1225 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -126,7 +126,7 @@ Return the time of the end of the last instruction over the supplied channels. -`ScheduleBlock.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -142,7 +142,7 @@ Return the time of the start of the first instruction over the supplied channels -`ScheduleBlock.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -232,7 +232,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -265,7 +265,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -296,7 +296,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -318,7 +318,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -343,7 +343,7 @@ New block object with name and metadata. -`ScheduleBlock.insert(start_time, block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.insert(start_time, block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. @@ -366,7 +366,7 @@ This method will be removed. Temporarily added for backward compatibility. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -378,7 +378,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -390,7 +390,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -412,7 +412,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.shift(time, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.shift(time, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.md index 70e4017f765..bdcaecf284d 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.md index 62054c398c0..31416321d95 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.md index ccb0461c3b8..e2b5095ff9f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.md index b212bcf03ae..4303c5627fa 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.md index 0b35a9e071b..2978a2245eb 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.30/qiskit.pulse.Waveform.md index 64ae0355b64..4f36364a78e 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire.md index 7fb6b0c1c63..958170cf301 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire_channel.md index 98b8ed75896..484673363ea 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.active_backend.md index 29546869ebf..ca6fd922e1f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 4e74842ec4f..16cbc35b5f1 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.active_transpiler_settings.md index f3a15baa159..32640b97eb2 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_equispaced.md index 296dc49815d..dfd01e7e485 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_func.md index 05c26fa7c07..a5de989d671 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_left.md index cbbb71aac73..fd6505616a3 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_right.md index 572951819b6..fb6aa7e45cd 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_sequential.md index 0b1585565a3..8b9a24f84a2 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.barrier.md index 339e1e01b0a..31e64cd6d59 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.build.md index 6e9fef84af6..027f1148f27 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.call.md index d69592c6a61..582dcc9cd79 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.circuit_scheduler_settings.md index 657d3302d88..a65c3624e7e 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.control_channels.md index 762939f242c..160ab43c52c 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.cx.md index 7e02b9e1bb7..95a269bec64 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.delay.md index 4f71e962d27..55ee9d104ff 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.delay_qubits.md index b0f847d24e3..70add771a15 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.drive_channel.md index ff0cf2a08e9..82422de0315 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.frequency_offset.md index e1a747dba9a..f62b75817fd 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.inline.md index 5f57428166d..5b9fedec7e9 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.measure.md index cc5ba4115b9..3b9a30910cc 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_all.md index 51e42b44561..8c11a4ce0f4 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_channel.md index 81f11f99879..b8b3e622524 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.num_qubits.md index 676d2ed6d40..701276b045b 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.pad.md index 43e967fc609..90f31cddfdd 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.phase_offset.md index 62ba68346f5..2498e5ac893 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.play.md index 18c6de4b90e..a7900788790 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.qubit_channels.md index d6517e36c09..76b6cabbb5e 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.samples_to_seconds.md index b6d7fcda54f..dd76abd524f 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.seconds_to_samples.md index d93f52c4470..79d53f9ed18 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.set_frequency.md index d85f6e4ca0e..5808cfa6cc8 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.set_phase.md index b41660ee5ad..07b01f8d5e1 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_frequency.md index 2544b9eb704..9d4a11f08d6 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_phase.md index 94e436785ef..2451e512b45 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.snapshot.md index e983009dc0b..5a5c3597646 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.transpiler_settings.md index f5fbba68e32..d55a51109be 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.u1.md index 9941efd5892..0372cd49e83 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.u2.md index 593b6b26057..1106180b726 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.u3.md index ec7e467dae9..a78e299a90d 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.30/qiskit.pulse.builder.x.md index 0a4e7cc7f76..db5b0046e3d 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.md index b4d3e2cd393..fd9686e9043 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.md index 81e6a62715f..44f6c9375c0 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.md index b454559b818..2cf252fac58 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.md index 2669c0e7e33..a0d16875406 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.md index 867a3a2f0f2..df5d8545751 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.md index 145fda8c30a..a9528d66c33 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.md index 9cb4acecad2..1ebcfb1a11c 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.md index 23fc954ed82..207efa106f7 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.md index da52194db0e..48495887d05 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.md index 6a8c84c04ea..413eaa320e4 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.md index b6a1742d533..847bbb1d5b7 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.md index 0f819369aff..d54ee604c97 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.md index 8a9a5b4afca..0a37c624210 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.md index 0b10fefe392..806fe3393d7 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.md index 73fb571e07c..3c3f56c74b7 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.30/qiskit.pulse.transforms.add_implicit_acquires.md index 4a6619928c2..0980cb98d6b 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.30/qiskit.pulse.transforms.align_measures.md index 912fbe3c1d7..e455aa7afbd 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.30/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.30/qiskit.pulse.transforms.pad.md index 4fde0d29b1f..708fb7dea2c 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.md index 568692c6cec..cd7cbe99aa4 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.30/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.30/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.30/qiskit.qasm.Qasm.md index 5811942acdb..e252baff09b 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.30/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.30/qiskit.qasm.QasmError.md index 0953fcef5e4..baf3c16ec44 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.30/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.md index 8577ea17145..d6604047c6b 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.30/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.md index 4bb241a51f1..996e8f90c48 100644 --- a/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.30/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.md index dc6807f4f47..cb9c76c431b 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.md index 250da02a36c..e539df275f8 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.md index f32e162938b..61bd5da66dc 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.md index 23de14f2b58..13310686dd6 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.md index 946eb56277f..6108c37bf58 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.md index a102b65db76..26905407c4f 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.md index 09e4e8cf6b6..02a106e69be 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.md index 93e83cf8204..792aafbd46a 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.md index 229e0c25a80..0efb9250ec6 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.md index 68efc15b60a..8f1af92cd29 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.md index 1ac3a0d1412..8a9ab6d04c8 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.md index 169ff7f0edd..2f540e16e76 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.md index 2a8827e0025..b652e1c615b 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.30/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.30/qiskit.qobj.Qobj.md index 48fab3cc3e7..d5931646cfe 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.md index dfdb814e30a..4356b458ef9 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.md index 0683e853895..ce821f49651 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.md index 8d2804fa7cf..113a5434563 100644 --- a/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.30/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.md index ebff470a33f..dd0721a2889 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.md index ccf832fe311..4b2db827eaa 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.md index 7ec4ff27c21..53f3ad6cff6 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.md index e69135ac64a..c054c07c1fa 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.md index 45eb39aec8e..60a67bb15d1 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.md index a59d2279a15..bab4107eda2 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.md index d746922fe44..be43b8e566a 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.md index 174a69f047a..fd55e4f045a 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -207,7 +207,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -223,7 +223,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -273,7 +273,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -291,7 +291,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -317,7 +317,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -325,7 +325,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -333,7 +333,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.md index d14a8785d50..9b762b76754 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.md index b8d396e287b..056331534c7 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -344,7 +344,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -366,7 +366,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -401,7 +401,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -426,7 +426,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -460,7 +460,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -468,7 +468,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -500,7 +500,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -546,7 +546,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -595,7 +595,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -611,7 +611,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -636,7 +636,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -662,7 +662,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -670,7 +670,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -690,7 +690,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -710,7 +710,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -728,7 +728,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -736,7 +736,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -763,7 +763,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.md index 7bdf7b82f1a..e0c74ef3a99 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -372,7 +372,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -396,7 +396,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -426,7 +426,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -454,7 +454,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -462,7 +462,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -480,7 +480,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -560,7 +560,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -623,7 +623,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -647,7 +647,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -676,7 +676,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -706,7 +706,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -714,7 +714,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.md index 0813db675f5..bc75cca248a 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.md index ebd5cb973c2..4a188ed873b 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.md index 4580365d9cc..aea5d2c2f59 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.md index b72250d6dc1..e475b2c7eac 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -39,7 +39,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -47,7 +47,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -79,7 +79,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -138,7 +138,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list \[(pauli\_str, coeffs)] @@ -146,7 +146,7 @@ Construct from a list \[(pauli\_str, coeffs)] -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -182,7 +182,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -203,7 +203,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -221,7 +221,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -301,7 +301,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliTable by combining duplicates and removing zeros. @@ -322,7 +322,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -348,7 +348,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -370,7 +370,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -390,7 +390,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -398,7 +398,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.md index 845a37a909b..f4afb057545 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of an operator. @@ -154,7 +154,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -162,7 +162,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -186,7 +186,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -209,7 +209,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -234,7 +234,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -254,7 +254,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -305,7 +305,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -340,7 +340,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -364,7 +364,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -372,7 +372,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.md index 9dca8a94bb7..1b0e92e532f 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.md index d41ce984ff1..a4222278812 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -103,7 +103,7 @@ Return a visualization of the Statevector. -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -129,7 +129,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -154,7 +154,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -178,7 +178,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -199,7 +199,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -225,7 +225,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -253,7 +253,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -286,7 +286,7 @@ The N-qubit basis state density matrix. -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -318,7 +318,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -416,7 +416,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -424,7 +424,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -448,7 +448,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -528,7 +528,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -552,7 +552,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -623,7 +623,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -631,7 +631,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.md index 6b75108f76f..65db3087e12 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.md index c3a7de9df50..2f806ef834b 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 033460fc1ea..8011ed5e7e9 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.30/qiskit.quantum_info.average_gate_fidelity.md index 7fb9a34233e..1b5652e7c30 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.30/qiskit.quantum_info.concurrence.md index c78b08178f3..687f9ae3338 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.30/qiskit.quantum_info.decompose_clifford.md index 6ca92850231..7d7e125d7df 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.30/qiskit.quantum_info.diamond_norm.md index 86f41fd7f25..a21fca61eb8 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.30/qiskit.quantum_info.entanglement_of_formation.md index ba0a5cf5d39..474efe05fef 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.30/qiskit.quantum_info.entropy.md index 972b7960c19..75988e6cee9 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.30/qiskit.quantum_info.gate_error.md index 2e21141eb7e..d0cc1eb2da5 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_distance.md index adfb9615a12..1efd2679b14 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_fidelity.md index 1e45b7cd4e9..9da8d5d3e9f 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.30/qiskit.quantum_info.mutual_information.md index e4a660de27e..255470a0614 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.30/qiskit.quantum_info.partial_trace.md index fcab650edfc..c35c456a54e 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_basis.md index 1013541d50e..67e47327c8d 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_group.md index 4e5d94cc6fe..f7f574ad41f 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.30/qiskit.quantum_info.process_fidelity.md index 54dc69af792..0fe2d78fe1c 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.30/qiskit.quantum_info.purity.md index 2508d906b61..dfe63a28948 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_clifford.md index e397857937f..ebc9b143eca 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_cnotdihedral.md index 78482875122..7bf929ca519 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_density_matrix.md index 712a7a1eb2c..53f6e8e95a0 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_hermitian.md index 7822a9824b8..3a7c0fe6d7a 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli.md index bd5ff2607f8..1a1172b860f 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli_table.md index 137ca4d950e..6eafed31d9d 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_quantum_channel.md index 22449571abe..c74cf52ae83 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_stabilizer_table.md index 7b50b105331..3e9133f893d 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_statevector.md index ffd24a93345..c11755caa79 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.30/qiskit.quantum_info.random_unitary.md index fbfab7f787f..8ebc0cd56d2 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.30/qiskit.quantum_info.shannon_entropy.md index 3cffae817a1..d1f3ed5ceb7 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.30/qiskit.quantum_info.state_fidelity.md index a17bb1a7eeb..219305ec9d7 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.30/qiskit.result.Counts.md b/docs/api/qiskit/0.30/qiskit.result.Counts.md index 3e0c1b28c27..b0836bc1dac 100644 --- a/docs/api/qiskit/0.30/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.30/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return the most frequent count diff --git a/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.md index 652a93c0df8..badfda93833 100644 --- a/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.md index a3df439e777..2a008309699 100644 --- a/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.30/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -121,7 +121,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.30/qiskit.result.Result.md b/docs/api/qiskit/0.30/qiskit.result.Result.md index 1d5d04a9af8..dfea27ddcd8 100644 --- a/docs/api/qiskit/0.30/qiskit.result.Result.md +++ b/docs/api/qiskit/0.30/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.30/qiskit.result.ResultError.md b/docs/api/qiskit/0.30/qiskit.result.ResultError.md index 9636b827e5e..651b0b3a115 100644 --- a/docs/api/qiskit/0.30/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.30/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.30/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.30/qiskit.result.marginal_counts.md index 984ec18e675..4fbf937bd99 100644 --- a/docs/api/qiskit/0.30/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.30/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.md index d95b631d265..e3691a3a0d8 100644 --- a/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.30/qiskit.tools.backend_monitor.md index 900dae82e23..8917e8199fd 100644 --- a/docs/api/qiskit/0.30/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.30/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.30/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.30/qiskit.tools.backend_overview.md index 957fb280a60..f988ef320c1 100644 --- a/docs/api/qiskit/0.30/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.30/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.30/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.30/qiskit.tools.job_monitor.md index 3d16ebac30c..92e57bda169 100644 --- a/docs/api/qiskit/0.30/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.30/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.30/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.30/qiskit.tools.parallel_map.md index 07db725f8f3..f232ba2823a 100644 --- a/docs/api/qiskit/0.30/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.30/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.md index 5567193156c..9509698d52a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.md index 2ce2dfac706..8f25b090032 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -80,7 +80,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -102,7 +102,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -110,7 +110,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return qubits connected on a grid of num\_rows x num\_columns. @@ -118,7 +118,7 @@ Return qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -126,7 +126,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -134,7 +134,7 @@ Return a fully connected coupling map on n qubits. -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -150,7 +150,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -160,7 +160,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -168,7 +168,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -176,7 +176,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -186,7 +186,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -210,7 +210,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -235,7 +235,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -243,7 +243,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.md index 2911a55d282..a470e79302b 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.md index b19b52b8d4b..00e28c66d3c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.md index c66a5aa118b..ab556eb695e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.md index f535bb13e7b..92846548d61 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name and the qubits. @@ -74,7 +74,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -90,7 +90,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.30/qiskit.transpiler.Layout.md index fd318dce9c7..5779fc5efcd 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.md index d60d3062ea4..cb1d29a7a49 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.md index 7a34b30ea18..873ce1041ac 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.md index 940178feedb..de3f9b579ed 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.md index 58f37fcce1f..0be91a42cf2 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.md index 6187572348c..96db165c737 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.md index 04921d4f0c9..f58225cdf00 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.md index 5834bbcf5ba..5593d2d9b55 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.md index bf869cf5632..3583d27a24b 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.md index fdea1c26f1a..6f3047aa15a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.md index 8dbbf1adade..c2205e3f5d4 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.md index 3148d827221..9806713ab21 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -72,7 +72,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 868cc99c318..43482e25d9e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.md index 90564fc4170..dfa0268fc81 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.md index 6d963211a62..86445d2fde4 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.md index 80c02cf7d65..e8f366aba3a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.md index 6f04b9e6248..845de2e0172 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.md index b525f3316e5..fea10b8596e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.md index c71de599680..b02406f2a5c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.md index 6a17860c54c..c3429160e40 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.md index 810eaa83cc7..3f997e25f37 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.md index 032e151ddc1..4613199f5dd 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.md index 744736cbc13..62187c78316 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.md index a72caa5131d..46a35082205 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.md index 51bec98a443..c16e9ab7a7b 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.md index 02a07d088d0..2debc209680 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.md index 4f9431bb37b..1353af5be91 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index b32c79c6cc3..a34f76b8aea 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.md index 997db28662b..f755a0f2838 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.md index 4ecd9af788b..b1631964fc6 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.md index 4821800c0d5..025e85f28f4 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.md index 718d92615bc..a7b067d0923 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.md index 9c0c24fee12..062c118d97e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.md index bd5229317f5..d4a29cd390d 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.md index 72a4c9337b5..43705a6217c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.md index 58f845efea2..991d31b3594 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.md index 75443220b25..695c133ed97 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.md index bd591642853..a68660bd460 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -52,7 +52,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.md index 526e67b3172..2de48decfaf 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.md index 3b941efdc17..8f08841bdd8 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.md index c5ef7c51fe2..290a38a2ea6 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 18b39f6de80..79baa69b039 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.md index bfb88eaa73f..a0e9be18885 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.md index a43c925315a..4c3e10a227e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 9f025335f64..deb8bd3bc0e 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 247952bd2a6..f4185c64073 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` @@ -32,7 +32,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -63,7 +63,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -109,7 +109,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.supported(node_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index d1e35d9d7f8..0dbf71a687f 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.md index e80b597cd86..761812a77ff 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index ea691cfcdcc..ebb876ce4cf 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.md index bd287fcc787..cd167884a17 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.md index d92c6ed6a1a..1a34098a35f 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.md index 43a1246b882..4ea822d5049 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.md index 24b02cd5d37..1ec7028a48f 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.md index 310f7e38d21..07d7ccb91d0 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.md index 088beac9622..46e6c9c2f34 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.md index e3518c917f1..07a891b44c3 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.md index e9a9ae62a6e..6653a09acf6 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.md index 44a16cd9703..131fb3ef24a 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.md index c6dc911389c..963a68b4426 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.md index b72a56d66a9..d4ea3debc8f 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.md index d55722e6613..1c3cf957287 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 691671212e0..7dd2a3d0438 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.md index c02d018eb79..86621524a00 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.md index a5078bb49fa..e33af21c9ea 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.md index f7e21cd7667..e5e1dddb35c 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index ce49450400a..e56210238e8 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 893991f1e1e..5fa14dacdf7 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 2a48a316b60..ad034c98bdb 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 67a6d205867..241fe8b08a2 100644 --- a/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.30/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.md index 328d57f775f..b36be637246 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.30/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -65,7 +65,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -85,7 +85,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -116,7 +116,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -136,7 +136,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -148,7 +148,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -156,7 +156,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :param circuits: circuits to transpile :type circuits: Union\[‘QuantumCircuit’, List\[‘QuantumCircuit’]] diff --git a/docs/api/qiskit/0.30/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.30/qiskit.utils.apply_prefix.md index 2017d1c6643..a28b67fdb37 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.30/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.30/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.30/qiskit.utils.deprecate_arguments.md index 8282d5f19c9..a828755849a 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.30/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.30/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.30/qiskit.utils.deprecate_function.md index 2b87a5fcc00..4f63f06df1f 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.30/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.30/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.30/qiskit.utils.get_entangler_map.md index 6cf74ea4af2..236fae021fb 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.30/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.30/qiskit.utils.has_aer.md b/docs/api/qiskit/0.30/qiskit.utils.has_aer.md index 189bf9bfc23..102a23afe92 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.30/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.30/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.30/qiskit.utils.has_ibmq.md index 60361543541..be11ff87ff7 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.30/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.30/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.30/qiskit.utils.is_main_process.md index fa2d188fc3a..0ea19e37f4f 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.30/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.30/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.30/qiskit.utils.local_hardware_info.md index 830ffd2cddc..3844e400dc4 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.30/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.30/qiskit.utils.name_args.md b/docs/api/qiskit/0.30/qiskit.utils.name_args.md index eaa2979d4a7..1b871d1ee39 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.30/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.30/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.30/qiskit.utils.summarize_circuits.md index a0271e0a592..80bf315381d 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.30/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.30/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.30/qiskit.utils.validate_entangler_map.md index 2b216c7bc49..88c3e19f384 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.30/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.md index c6da2a2e904..5bfb9a42a70 100644 --- a/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.30/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.30/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.30/qiskit.validation.jsonschema.validate_json_against_schema.md index 2a574f25167..0b6d588facc 100644 --- a/docs/api/qiskit/0.30/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.30/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.md index 019d0e86d97..cbd4a33b528 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.30/qiskit.visualization.array_to_latex.md index 6be62f03dfb..6168a0bbc64 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.30/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.30/qiskit.visualization.circuit_drawer.md index 2b55132367a..877fba7cffd 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.30/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.30/qiskit.visualization.dag_drawer.md index 9d49c5f755e..4a073d3d00e 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.30/qiskit.visualization.pass_manager_drawer.md index df1f70d2634..06fff318385 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_multivector.md index 833dc7a2363..0d95c9eb6b7 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_vector.md index f9513e4c898..4dca6462ad6 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_circuit_layout.md index f2dc215b6c5..b28c1b18dd3 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_error_map.md index de79f3abdd1..aae17732e02 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_gate_map.md index c8edf66cc2d..8e42f85c36b 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_histogram.md index abaa8a31fd2..31899ef8130 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_city.md index 89f4680fa23..7c6b2ddda34 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_hinton.md index 336e8ef0342..b8e3c1b8988 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_paulivec.md index 3f2c47f124f..60ce975cdd7 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_qsphere.md index 04f2996a9ef..371f096d41e 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.md index e2d818293eb..8c96b29e9d7 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.md index 53ecd61a0b0..deb943eb89c 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.md index 808cab2e4eb..463ec5974fd 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.draw.md index 6ccdd4c5932..8298a4f8151 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.md index ebc50613fb6..e29877e00b4 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.30/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.30/qiskit.visualization.timeline.draw.md index 1136f138d32..8356ae6eab9 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.30/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.30/qiskit.visualization.visualize_transition.md index f799d8cd91f..bdd0cdda636 100644 --- a/docs/api/qiskit/0.30/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.30/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 05e8cdb35ff942b8fb250611884338aa38a76dec Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:31:37 +0100 Subject: [PATCH 12/41] Regenerate qiskit 0.31.0 --- docs/api/qiskit/0.31/execute.md | 2 +- docs/api/qiskit/0.31/logging.md | 2 +- .../0.31/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.31/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.31/qiskit.algorithms.Grover.md | 8 +- .../0.31/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.31/qiskit.algorithms.HHL.md | 6 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- .../0.31/qiskit.algorithms.LinearSolver.md | 4 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.algorithms.NumPyLinearSolver.md | 4 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.31/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.31/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.31/qiskit.algorithms.Shor.md | 8 +- .../0.31/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.31/qiskit.algorithms.VQE.md | 20 +- .../0.31/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.31/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.31/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.31/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.31/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.31/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 6 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.31/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.31/qiskit.algorithms.optimizers.SPSA.md | 10 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- .../0.31/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.31/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.31/qiskit.aqua.QuantumInstance.md | 16 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 6 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 4 +- ...ua.algorithms.AmplitudeEstimationResult.md | 4 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 4 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 4 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 4 +- .../qiskit/0.31/qiskit.aqua.algorithms.EOH.md | 4 +- .../qiskit.aqua.algorithms.Eigensolver.md | 6 +- ...iskit.aqua.algorithms.EigensolverResult.md | 4 +- .../0.31/qiskit.aqua.algorithms.Grover.md | 10 +- .../qiskit.aqua.algorithms.GroverResult.md | 4 +- .../qiskit/0.31/qiskit.aqua.algorithms.HHL.md | 10 +- .../0.31/qiskit.aqua.algorithms.HHLResult.md | 4 +- .../0.31/qiskit.aqua.algorithms.IQPE.md | 6 +- ...algorithms.IterativeAmplitudeEstimation.md | 4 +- ...thms.IterativeAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.LinearsolverResult.md | 4 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 6 +- ...imumLikelihoodAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 6 +- ...qua.algorithms.MinimumEigensolverResult.md | 4 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 4 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.31/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.31/qiskit.aqua.algorithms.QGAN.md | 10 +- .../qiskit/0.31/qiskit.aqua.algorithms.QPE.md | 6 +- .../0.31/qiskit.aqua.algorithms.QSVM.md | 24 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 6 +- .../0.31/qiskit.aqua.algorithms.Shor.md | 6 +- .../0.31/qiskit.aqua.algorithms.Simon.md | 4 +- .../0.31/qiskit.aqua.algorithms.SklearnSVM.md | 12 +- .../qiskit/0.31/qiskit.aqua.algorithms.VQC.md | 24 +- .../qiskit/0.31/qiskit.aqua.algorithms.VQE.md | 18 +- .../qiskit/0.31/qiskit.aqua.circuits.CNF.md | 4 +- .../qiskit/0.31/qiskit.aqua.circuits.DNF.md | 4 +- .../qiskit/0.31/qiskit.aqua.circuits.ESOP.md | 4 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 4 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 4 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 10 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 10 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 8 +- ...aqua.components.feature_maps.FeatureMap.md | 8 +- ...omponents.feature_maps.RawFeatureVector.md | 4 +- ...t.aqua.components.initial_states.Custom.md | 4 +- ....components.initial_states.InitialState.md | 4 +- ....components.initial_states.VarFormBased.md | 4 +- ...kit.aqua.components.initial_states.Zero.md | 4 +- ...mponents.multiclass_extensions.AllPairs.md | 8 +- ...lticlass_extensions.ErrorCorrectingCode.md | 8 +- ...lticlass_extensions.MulticlassExtension.md | 10 +- ...ts.multiclass_extensions.OneAgainstRest.md | 8 +- ...s.neural_networks.DiscriminativeNetwork.md | 12 +- ...nents.neural_networks.GenerativeNetwork.md | 12 +- ...ents.neural_networks.NumPyDiscriminator.md | 14 +- ...ts.neural_networks.PyTorchDiscriminator.md | 16 +- ...onents.neural_networks.QuantumGenerator.md | 14 +- .../qiskit.aqua.components.optimizers.ADAM.md | 12 +- .../qiskit.aqua.components.optimizers.AQGD.md | 6 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 6 +- .../qiskit.aqua.components.optimizers.CG.md | 6 +- ...iskit.aqua.components.optimizers.COBYLA.md | 6 +- .../qiskit.aqua.components.optimizers.CRS.md | 4 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 4 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 4 +- .../qiskit.aqua.components.optimizers.ESCH.md | 4 +- .../qiskit.aqua.components.optimizers.GSLS.md | 14 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 6 +- ...qiskit.aqua.components.optimizers.ISRES.md | 4 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 6 +- ....aqua.components.optimizers.NELDER_MEAD.md | 6 +- .../qiskit.aqua.components.optimizers.NFT.md | 6 +- ...it.aqua.components.optimizers.Optimizer.md | 16 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 6 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 6 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 6 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 6 +- .../qiskit.aqua.components.optimizers.SPSA.md | 6 +- .../qiskit.aqua.components.optimizers.TNC.md | 6 +- ....components.oracles.CustomCircuitOracle.md | 4 +- ...ponents.oracles.LogicalExpressionOracle.md | 6 +- .../qiskit.aqua.components.oracles.Oracle.md | 4 +- ...qua.components.oracles.TruthTableOracle.md | 6 +- ...qua.components.reciprocals.LongDivision.md | 6 +- ...a.components.reciprocals.LookupRotation.md | 6 +- ....aqua.components.reciprocals.Reciprocal.md | 6 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 4 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 6 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 4 +- ...els.MultivariateVariationalDistribution.md | 6 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 4 +- ....uncertainty_models.UniformDistribution.md | 8 +- ...certainty_models.UnivariateDistribution.md | 6 +- ...odels.UnivariateVariationalDistribution.md | 6 +- ...ncertainty_problems.MultivariateProblem.md | 8 +- ...uncertainty_problems.UncertaintyProblem.md | 4 +- ...lems.UnivariatePiecewiseLinearObjective.md | 8 +- ....uncertainty_problems.UnivariateProblem.md | 8 +- ...nents.variational_forms.VariationalForm.md | 8 +- .../qiskit.aqua.operators.OperatorBase.md | 36 +-- ...qua.operators.converters.AbelianGrouper.md | 6 +- ...qua.operators.converters.CircuitSampler.md | 8 +- ...aqua.operators.converters.ConverterBase.md | 4 +- ...a.operators.converters.DictToCircuitSum.md | 4 +- ...a.operators.converters.PauliBasisChange.md | 22 +- ...aqua.operators.evolutions.EvolutionBase.md | 4 +- ...a.operators.evolutions.EvolutionFactory.md | 4 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 30 +-- ...ua.operators.evolutions.MatrixEvolution.md | 4 +- ...rators.evolutions.PauliTrotterEvolution.md | 8 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 4 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 4 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 4 +- ...rators.evolutions.TrotterizationFactory.md | 4 +- ...rators.expectations.AerPauliExpectation.md | 6 +- ....operators.expectations.CVaRExpectation.md | 6 +- ....operators.expectations.ExpectationBase.md | 6 +- ...erators.expectations.ExpectationFactory.md | 4 +- ...perators.expectations.MatrixExpectation.md | 6 +- ...operators.expectations.PauliExpectation.md | 6 +- ...qua.operators.gradients.CircuitGradient.md | 4 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 4 +- ...aqua.operators.gradients.DerivativeBase.md | 8 +- ...iskit.aqua.operators.gradients.Gradient.md | 6 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 6 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 4 +- .../qiskit.aqua.operators.gradients.QFI.md | 4 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 16 +- ...it.aqua.operators.legacy.MatrixOperator.md | 24 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 10 +- ....operators.legacy.WeightedPauliOperator.md | 50 ++--- ...skit.aqua.operators.legacy.Z2Symmetries.md | 14 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 14 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 46 ++-- ...qiskit.aqua.operators.list_ops.SummedOp.md | 18 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 10 +- ....aqua.operators.primitive_ops.CircuitOp.md | 30 +-- ...t.aqua.operators.primitive_ops.MatrixOp.md | 28 +-- ...it.aqua.operators.primitive_ops.PauliOp.md | 34 +-- ...qua.operators.primitive_ops.PrimitiveOp.md | 46 ++-- ...qua.operators.state_fns.CVaRMeasurement.md | 30 +-- ...aqua.operators.state_fns.CircuitStateFn.md | 36 +-- ...it.aqua.operators.state_fns.DictStateFn.md | 24 +- ...qua.operators.state_fns.OperatorStateFn.md | 24 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 40 ++-- ....aqua.operators.state_fns.VectorStateFn.md | 26 +-- .../0.31/qiskit.aqua.utils.CircuitFactory.md | 26 +-- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.31/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.31/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.31/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.31/qiskit.aqua.utils.name_args.md | 2 +- .../0.31/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.31/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.31/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.31/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.31/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.31/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.31/qiskit.assembler.disassemble.md | 2 +- .../0.31/qiskit.chemistry.BosonicOperator.md | 8 +- .../qiskit.chemistry.FermionicOperator.md | 18 +- .../qiskit/0.31/qiskit.chemistry.MP2Info.md | 6 +- .../qiskit/0.31/qiskit.chemistry.QMolecule.md | 24 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 6 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 4 +- ...chemistry.algorithms.EigensolverFactory.md | 4 +- ...try.algorithms.ExcitedStatesEigensolver.md | 4 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 4 +- ...istry.algorithms.GroundStateEigensolver.md | 8 +- ....chemistry.algorithms.GroundStateSolver.md | 8 +- ...ry.algorithms.MinimumEigensolverFactory.md | 6 +- ...stry.algorithms.NumPyEigensolverFactory.md | 4 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 6 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 6 +- .../0.31/qiskit.chemistry.algorithms.QEOM.md | 4 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 8 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 6 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 6 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 4 +- ...s.pes_samplers.DifferentialExtrapolator.md | 4 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 12 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 12 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 6 +- ...gorithms.pes_samplers.HarmonicPotential.md | 24 +- ....algorithms.pes_samplers.MorsePotential.md | 24 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 4 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 4 +- ...y.algorithms.pes_samplers.PotentialBase.md | 8 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 4 +- ...thms.pes_samplers.VibronicStructureBase.md | 10 +- ...orithms.pes_samplers.WindowExtrapolator.md | 4 +- ...applications.MolecularGroundStateEnergy.md | 6 +- ...y.components.bosonic_bases.BosonicBasis.md | 4 +- ....components.bosonic_bases.HarmonicBasis.md | 4 +- ...y.components.initial_states.HartreeFock.md | 4 +- ...hemistry.components.initial_states.VSCF.md | 4 +- ...mistry.components.variational_forms.CHC.md | 4 +- ...stry.components.variational_forms.UCCSD.md | 22 +- ...istry.components.variational_forms.UVCC.md | 8 +- ...qiskit.chemistry.core.ChemistryOperator.md | 6 +- .../0.31/qiskit.chemistry.core.Hamiltonian.md | 4 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 6 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 4 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 6 +- ...iskit.chemistry.drivers.FermionicDriver.md | 4 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 4 +- ....chemistry.drivers.GaussianForcesDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogResult.md | 4 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 4 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.31/qiskit.chemistry.drivers.Molecule.md | 14 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 4 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 4 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 4 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 4 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 6 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 10 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 10 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 10 +- .../0.31/qiskit.circuit.AncillaQubit.md | 2 +- .../0.31/qiskit.circuit.AncillaRegister.md | 2 +- .../0.31/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.31/qiskit.circuit.Clbit.md | 2 +- .../0.31/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.31/qiskit.circuit.Delay.md | 12 +- .../0.31/qiskit.circuit.EquivalenceLibrary.md | 12 +- docs/api/qiskit/0.31/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.31/qiskit.circuit.Instruction.md | 28 +-- .../0.31/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.31/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.31/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 30 +-- .../0.31/qiskit.circuit.ParameterVector.md | 6 +- .../0.31/qiskit.circuit.QuantumCircuit.md | 206 +++++++++--------- .../0.31/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.31/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.31/qiskit.circuit.Reset.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.AND.md | 2 +- .../0.31/qiskit.circuit.library.Barrier.md | 8 +- .../0.31/qiskit.circuit.library.C3SXGate.md | 4 +- .../0.31/qiskit.circuit.library.C3XGate.md | 6 +- .../0.31/qiskit.circuit.library.C4XGate.md | 6 +- .../0.31/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.31/qiskit.circuit.library.CHGate.md | 4 +- .../0.31/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.31/qiskit.circuit.library.CRXGate.md | 4 +- .../0.31/qiskit.circuit.library.CRYGate.md | 4 +- .../0.31/qiskit.circuit.library.CRZGate.md | 4 +- .../0.31/qiskit.circuit.library.CSXGate.md | 2 +- .../0.31/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.31/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.31/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.31/qiskit.circuit.library.CUGate.md | 4 +- .../0.31/qiskit.circuit.library.CXGate.md | 6 +- .../0.31/qiskit.circuit.library.CYGate.md | 4 +- .../0.31/qiskit.circuit.library.CZGate.md | 4 +- .../0.31/qiskit.circuit.library.DCXGate.md | 2 +- .../0.31/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.31/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.GRZ.md | 2 +- .../0.31/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.31/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.31/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.31/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.31/qiskit.circuit.library.MCMT.md | 6 +- .../0.31/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.31/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.31/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.31/qiskit.circuit.library.MSGate.md | 2 +- .../0.31/qiskit.circuit.library.Measure.md | 4 +- .../0.31/qiskit.circuit.library.NLocal.md | 12 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.31/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.31/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.31/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.31/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.31/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.31/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.31/qiskit.circuit.library.RGate.md | 4 +- .../0.31/qiskit.circuit.library.RVGate.md | 6 +- .../0.31/qiskit.circuit.library.RXGate.md | 6 +- .../0.31/qiskit.circuit.library.RXXGate.md | 4 +- .../0.31/qiskit.circuit.library.RYGate.md | 6 +- .../0.31/qiskit.circuit.library.RYYGate.md | 4 +- .../0.31/qiskit.circuit.library.RZGate.md | 6 +- .../0.31/qiskit.circuit.library.RZXGate.md | 4 +- .../0.31/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.31/qiskit.circuit.library.Reset.md | 4 +- .../0.31/qiskit.circuit.library.SGate.md | 4 +- .../0.31/qiskit.circuit.library.SXGate.md | 6 +- .../0.31/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.31/qiskit.circuit.library.SdgGate.md | 4 +- .../0.31/qiskit.circuit.library.SwapGate.md | 6 +- .../0.31/qiskit.circuit.library.TGate.md | 4 +- .../0.31/qiskit.circuit.library.TdgGate.md | 4 +- .../0.31/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.31/qiskit.circuit.library.U1Gate.md | 6 +- .../0.31/qiskit.circuit.library.U2Gate.md | 4 +- .../0.31/qiskit.circuit.library.U3Gate.md | 6 +- .../0.31/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.UniformDistribution.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.31/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.31/qiskit.circuit.library.XOR.md | 2 +- .../0.31/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.31/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.31/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.31/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.31/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.31/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.31/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.31/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.31/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.qpy_serialization.dump.md | 2 +- .../qiskit.circuit.qpy_serialization.load.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.31/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.31/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.31/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.31/qiskit.compiler.transpile.md | 2 +- .../0.31/qiskit.converters.ast_to_dag.md | 2 +- .../0.31/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.31/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.31/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.31/qiskit.dagcircuit.DAGCircuit.md | 126 +++++------ .../0.31/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.31/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.31/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../qiskit/0.31/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.31/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.31/qiskit.extensions.Initialize.md | 8 +- .../qiskit/0.31/qiskit.extensions.Snapshot.md | 8 +- .../0.31/qiskit.extensions.UnitaryGate.md | 16 +- .../0.31/qiskit.finance.QiskitFinanceError.md | 2 +- ....uncertainty_problems.EuropeanCallDelta.md | 8 +- ...inty_problems.EuropeanCallExpectedValue.md | 8 +- ...ainty_problems.FixedIncomeExpectedValue.md | 10 +- ...finance.data_providers.BaseDataProvider.md | 16 +- ...nce.data_providers.DataOnDemandProvider.md | 4 +- ...nce.data_providers.ExchangeDataProvider.md | 4 +- ...nance.data_providers.RandomDataProvider.md | 4 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 4 +- ...inance.data_providers.YahooDataProvider.md | 4 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.31/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.31/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 6 +- .../0.31/qiskit.ignis.verification.BConfig.md | 18 +- .../qiskit.ignis.verification.CNOTDihedral.md | 34 +-- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.31/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.31/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 6 +- .../0.31/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.31/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.31/qiskit.ml.datasets.digits.md | 2 +- .../0.31/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.31/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.31/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.31/qiskit.opflow.OperatorBase.md | 40 ++-- .../qiskit/0.31/qiskit.opflow.OpflowError.md | 2 +- .../0.31/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.31/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.31/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.31/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.31/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.31/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.31/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.31/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 4 +- .../0.31/qiskit.opflow.gradients.QFI.md | 4 +- .../0.31/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.31/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.31/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.31/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.31/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +-- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 38 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +-- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.31/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +-- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 76 +++---- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 6 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 6 +- ....optimization.algorithms.CplexOptimizer.md | 8 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 6 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 4 +- ...zation.algorithms.MinimumEigenOptimizer.md | 6 +- ...mization.algorithms.MultiStartOptimizer.md | 4 +- ...zation.algorithms.OptimizationAlgorithm.md | 8 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 6 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 6 +- ....optimization.algorithms.SolutionSample.md | 2 +- ...ization.converters.InequalityToEquality.md | 6 +- ...optimization.converters.IntegerToBinary.md | 6 +- ...tion.converters.LinearEqualityToPenalty.md | 6 +- ...on.converters.QuadraticProgramConverter.md | 6 +- ...ation.converters.QuadraticProgramToQubo.md | 10 +- ...qiskit.optimization.problems.Constraint.md | 4 +- ....optimization.problems.LinearConstraint.md | 4 +- ....optimization.problems.LinearExpression.md | 10 +- ...timization.problems.QuadraticConstraint.md | 4 +- ...timization.problems.QuadraticExpression.md | 10 +- ...ptimization.problems.QuadraticObjective.md | 6 +- ....optimization.problems.QuadraticProgram.md | 76 +++---- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 4 +- .../qiskit/0.31/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.31/qiskit.providers.BackendV1.md | 16 +- .../0.31/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.31/qiskit.providers.BaseJob.md | 24 +- .../0.31/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.31/qiskit.providers.Job.md | 2 +- .../qiskit/0.31/qiskit.providers.JobError.md | 2 +- .../qiskit/0.31/qiskit.providers.JobStatus.md | 2 +- .../0.31/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.31/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.31/qiskit.providers.Options.md | 6 +- .../qiskit/0.31/qiskit.providers.Provider.md | 2 +- .../0.31/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.31/qiskit.providers.aer.AerError.md | 2 +- .../0.31/qiskit.providers.aer.AerProvider.md | 6 +- .../0.31/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.31/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 28 +-- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.31/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 10 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.31/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.31/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.31/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.31/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...skit.providers.ibmq.random.CQCExtractor.md | 10 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 6 +- ...providers.ibmq.random.IBMQRandomService.md | 6 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 24 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.31/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.31/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- docs/api/qiskit/0.31/qiskit.pulse.Acquire.md | 4 +- .../0.31/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.31/qiskit.pulse.Call.md | 8 +- docs/api/qiskit/0.31/qiskit.pulse.Constant.md | 6 +- .../0.31/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.31/qiskit.pulse.Delay.md | 4 +- docs/api/qiskit/0.31/qiskit.pulse.Drag.md | 6 +- .../qiskit/0.31/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.31/qiskit.pulse.Gaussian.md | 6 +- .../0.31/qiskit.pulse.GaussianSquare.md | 6 +- .../qiskit/0.31/qiskit.pulse.Instruction.md | 22 +- .../qiskit.pulse.InstructionScheduleMap.md | 20 +- .../0.31/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.31/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.31/qiskit.pulse.Play.md | 6 +- .../qiskit/0.31/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.31/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.31/qiskit.pulse.Schedule.md | 30 +-- .../qiskit/0.31/qiskit.pulse.ScheduleBlock.md | 30 +-- .../qiskit/0.31/qiskit.pulse.SetFrequency.md | 4 +- docs/api/qiskit/0.31/qiskit.pulse.SetPhase.md | 4 +- .../0.31/qiskit.pulse.ShiftFrequency.md | 4 +- .../qiskit/0.31/qiskit.pulse.ShiftPhase.md | 4 +- docs/api/qiskit/0.31/qiskit.pulse.Snapshot.md | 4 +- docs/api/qiskit/0.31/qiskit.pulse.Waveform.md | 6 +- .../0.31/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.31/qiskit.pulse.builder.align_func.md | 2 +- .../0.31/qiskit.pulse.builder.align_left.md | 2 +- .../0.31/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.31/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.delay.md | 2 +- .../0.31/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.31/qiskit.pulse.builder.inline.md | 2 +- .../0.31/qiskit.pulse.builder.measure.md | 2 +- .../0.31/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.31/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.pad.md | 2 +- .../0.31/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.31/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.31/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.31/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.31/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.31/qiskit.pulse.builder.x.md | 2 +- .../0.31/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.31/qiskit.pulse.instructions.Call.md | 8 +- .../0.31/qiskit.pulse.instructions.Delay.md | 4 +- .../qiskit.pulse.instructions.Instruction.md | 22 +- .../0.31/qiskit.pulse.instructions.Play.md | 6 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.31/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.31/qiskit.pulse.library.Drag.md | 6 +- .../0.31/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.31/qiskit.pulse.library.Waveform.md | 6 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.31/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.31/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.31/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.31/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.31/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.31/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.31/qiskit.qobj.GateCalibration.md | 6 +- .../0.31/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.md | 6 +- .../0.31/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.31/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.31/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.31/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.31/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.31/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.31/qiskit.qobj.Qobj.md | 2 +- .../0.31/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.31/qiskit.qobj.QobjHeader.md | 2 +- .../0.31/qiskit.qobj.QobjMeasurementOption.md | 6 +- .../0.31/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.31/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.31/qiskit.quantum_info.Choi.md | 12 +- .../0.31/qiskit.quantum_info.Clifford.md | 32 +-- .../0.31/qiskit.quantum_info.DensityMatrix.md | 38 ++-- .../qiskit/0.31/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.31/qiskit.quantum_info.Operator.md | 26 +-- .../qiskit/0.31/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.31/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.31/qiskit.quantum_info.PauliList.md | 50 ++--- .../0.31/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.31/qiskit.quantum_info.Quaternion.md | 14 +- .../0.31/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.31/qiskit.quantum_info.SparsePauliOp.md | 32 +-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.31/qiskit.quantum_info.Statevector.md | 38 ++-- .../0.31/qiskit.quantum_info.Stinespring.md | 14 +- .../0.31/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.31/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.31/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.31/qiskit.quantum_info.entropy.md | 2 +- .../0.31/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.31/qiskit.quantum_info.partial_trace.md | 2 +- .../0.31/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.31/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.31/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.31/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.31/qiskit.result.Counts.md | 8 +- .../0.31/qiskit.result.ProbDistribution.md | 6 +- .../0.31/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.31/qiskit.result.Result.md | 16 +- .../qiskit/0.31/qiskit.result.ResultError.md | 2 +- .../0.31/qiskit.result.marginal_counts.md | 2 +- .../0.31/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.31/qiskit.tools.backend_monitor.md | 2 +- .../0.31/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.31/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.31/qiskit.tools.parallel_map.md | 2 +- .../0.31/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.31/qiskit.transpiler.CouplingMap.md | 36 +-- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.31/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- .../qiskit/0.31/qiskit.transpiler.Layout.md | 30 +-- .../0.31/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.31/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.31/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.31/qiskit.transpiler.passes.CheckMap.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- .../0.31/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.31/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.31/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.31/qiskit.transpiler.passes.Unroller.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.31/qiskit.transpiler.passes.Width.md | 4 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.31/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.31/qiskit.utils.apply_prefix.md | 2 +- .../0.31/qiskit.utils.deprecate_arguments.md | 2 +- .../0.31/qiskit.utils.deprecate_function.md | 2 +- .../0.31/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.31/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.31/qiskit.utils.has_ibmq.md | 2 +- .../0.31/qiskit.utils.is_main_process.md | 2 +- .../0.31/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.31/qiskit.utils.name_args.md | 2 +- .../0.31/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.31/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1218 files changed, 3890 insertions(+), 3890 deletions(-) diff --git a/docs/api/qiskit/0.31/execute.md b/docs/api/qiskit/0.31/execute.md index 8755b9240c2..3b45799405a 100644 --- a/docs/api/qiskit/0.31/execute.md +++ b/docs/api/qiskit/0.31/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.31/logging.md b/docs/api/qiskit/0.31/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.31/logging.md +++ b/docs/api/qiskit/0.31/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.md index 8ca3e9ac38e..70247e04092 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.md index eda68be3b99..05f5a8abf08 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.md index a56f9b81c5e..f8537131138 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.md index 0ea6cb88896..6a34c5b5e0d 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.md index bd82b5983d1..c3d0fd6bca9 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.md index d9fbb41272f..850ab74790c 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.md index a7d3692f34c..d543bb3f8af 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.md index 9e8af705568..54f056bb323 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.md index 0fa85780d22..e4c1693fee6 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.md index 4f8c63f8969..4270c11ca57 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7e80483cdc3..13261c39680 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.31/qiskit.algorithms.Grover.md index 04092050b25..c04b18e612b 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -109,7 +109,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -135,7 +135,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.md index 0d3262e9fe5..546a9de563a 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.31/qiskit.algorithms.HHL.md index af337f8969a..f2f4e2ccd9e 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -88,7 +88,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4d3d66e1511..ff05137ad29 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index ffd8680ce2a..dac975d8447 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.md index 4dfd18a7771..7107d4fbff1 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 786a28ca73f..cc26a05cb50 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.md index 2631fb0bc71..22110d83383 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.md index b467025bb12..95cc165d6df 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.md index e94e8c97d93..6bdc92cbd2d 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index b4972dfc894..1f2f35e7a5c 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index a4549d470bf..07d3d3a29bb 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.md index 1fa59d6cbab..6efe690ec1c 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.md index 434d8f1b250..f461d953178 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.md index 9bbfcc4d1e1..53d3a4858fc 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.md index 40aedeb0213..94ac1589c69 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.md index a468cd4132d..6ac7e2745a0 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.md index ac096712608..ce8760a0502 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.md index 9b7c64c8742..8264f0cdd4d 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.md index 6b02367ef38..0607e4db3f0 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.md index 1e4bf1d9fa5..f785d53d780 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.31/qiskit.algorithms.Shor.md index 081dc9ef8ee..9c7cb506b19 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.md index 301ee26f92b..aadac8890b7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.31/qiskit.algorithms.VQE.md index 323d4c93a7b..81b9b4d4661 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -51,7 +51,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -93,7 +93,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -148,7 +148,7 @@ dict -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -175,7 +175,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -187,7 +187,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -199,7 +199,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -227,7 +227,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -243,7 +243,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.md index 91320d37127..67bde1016da 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -121,7 +121,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -159,7 +159,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.md index 9eb6256f9ba..72f65b1b1c7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.md index 6db1b85881e..36824db4a70 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.md index e4899ab96e1..fd95ce853d8 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.md index 85f09e4e59c..55db3a940b3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.md index f52e1dd72f6..7fee2cbbfb1 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.md index dccc95dd453..8f7466e1deb 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5a424cb5965..5ef96d11579 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.md index d6e70b8e91a..e3a883d3222 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.md index 8f47f9e5d2c..f1bae1797c3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -172,7 +172,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -196,7 +196,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.md index 3932cff062c..a6b80c6390f 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.md index 499edc4598c..0b65a1220ed 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.md index c3a40820c6b..d9140d08e01 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.md index 7da978ade93..3a2c93d82f2 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.md index f24e582865f..89b376cb8a7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.md index cce399c08cb..8613db5a039 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.md index f3e2efd0371..8aa53bca58d 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 948f5158c5f..980594e2fe5 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.md index 2e38bcf0b6a..2107f37d0c3 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.md index 98dd1037f06..4837f9b9422 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.md index 01e413fbba3..4d0e65b0ebf 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -123,7 +123,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.md index a630c804619..30a2c283d1d 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.md index 3f7ed381506..86c66895db7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.md index a5555c44b15..30993b5e0fa 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -101,7 +101,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -136,7 +136,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -148,7 +148,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -179,7 +179,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.md index 72a75110049..6de668be969 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.md index 1f76b2e70b7..559898217d7 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.31/qiskit.aqua.AquaError.md index c2c87a14da5..b4579f16ed6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.md index a6654a15886..ae091b23fe5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.md index 4b2f505ac55..604dfb78a3a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") assemble circuits @@ -64,7 +64,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -84,7 +84,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -109,7 +109,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -129,7 +129,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Reset execution results @@ -141,7 +141,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -149,7 +149,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :type circuits: `Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]] :param circuits: circuits to transpile diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.md index b10e0ebc8ca..ccb94b46591 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -56,7 +56,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -82,7 +82,7 @@ The (1 - alpha) confidence interval of the specified kind. -`AmplitudeEstimation.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 2a74e74f268..0111c5beb77 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 214b669ba8c..9c38c01fbd8 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.md index bdf6a6a2030..1f8bd38fd94 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -29,7 +29,7 @@ The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jo -`BernsteinVazirani.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 3a85fe02cfa..d471a48f4d1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for Classical Algorithms. -`ClassicalAlgorithm.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Execute the classical algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.md index f5ad0c57f4e..b2d1ddbef94 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.md index 40b26aa0800..8a4fe2dbd30 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`DeutschJozsa.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.md index 6005a5c125b..ac96edbb4e6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -35,7 +35,7 @@ EOH provides the lower-level building blocks for simulating universal quantum sy -`EOH.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.md index 36a981429d0..c135dc4ece6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.md index 03e2bee0c4e..5fd16785333 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static EigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`static EigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.md index 05f0ff863d5..206dce3fd08 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -100,7 +100,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.construct_circuit(power=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(power=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -121,7 +121,7 @@ the QuantumCircuit object for the constructed circuit -`Grover.is_good_state(bitstr)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.is_good_state(bitstr)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Check whether a provided bitstring is a good state or not. @@ -141,7 +141,7 @@ True if the measurement is a good state, False otherwise. -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. @@ -162,7 +162,7 @@ The optimal number of iterations for Grover’s algorithm to succeed. -`Grover.post_processing(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.post_processing(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Do the post-processing to the measurement result diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.md index 27e2ed48c8b..0621bf4ee5e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static GroverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static GroverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.md index 104509eb4dc..3d4e71cd17c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -61,7 +61,7 @@ See also [https://arxiv.org/abs/0811.3171](https://arxiv.org/abs/0811.3171) -`HHL.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -81,7 +81,7 @@ the QuantumCircuit object for the constructed circuit -`static HHL.expand_to_hermitian(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_hermitian(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. @@ -102,7 +102,7 @@ the expanded matrix, the expanded vector -`static HHL.expand_to_powerdim(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_powerdim(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. @@ -123,7 +123,7 @@ the expanded matrix, the expanded vector -`static HHL.matrix_resize(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.matrix_resize(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Resizes matrix if necessary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.md index bacb695ea73..14d8c1fa1a3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static HHLResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHLResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.md index 2acf9246296..3ec9bf228b6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -41,7 +41,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -62,7 +62,7 @@ MinimumEigensolverResult -`IQPE.construct_circuit(k=None, omega=0, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.construct_circuit(k=None, omega=0, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index f55ec87a6b6..b41888a8ef7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -58,7 +58,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Construct the circuit Q^k A |0>. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index 46017326c36..ece986b79ca 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static IterativeAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`static IterativeAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.md index f9932eafc75..579de6c101c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static LinearsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`static LinearsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index d2fa6b6ec8f..bfe70b347c7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -47,7 +47,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -75,7 +75,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 834bf66fa9f..98c4ae01b1b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.md index 113932d3d9f..0e6660fc029 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.md index e69567d581a..a0a2e3e8146 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MinimumEigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`static MinimumEigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.md index abaf7014801..14fb63b3ae9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ dict -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.md index 869a22babd1..e82deb99e27 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 48320e33e2d..325dc0c2e7b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static NumPyLSsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`static NumPyLSsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index 7e31abd12a8..e9e0330c118 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -28,7 +28,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -65,7 +65,7 @@ dict -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.md index c76832ae833..567c8be2c20 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.md index cba3dfb07e5..9cdb44a756c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -52,7 +52,7 @@ These networks are trained in alternating optimization steps, where the discrimi -`QGAN.get_rel_entr()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.get_rel_entr()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Get relative entropy between target and trained distribution @@ -101,7 +101,7 @@ Sets backend with configuration. -`QGAN.set_discriminator(discriminator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_discriminator(discriminator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize discriminator. @@ -113,7 +113,7 @@ Initialize discriminator. -`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize generator. @@ -132,7 +132,7 @@ Initialize generator. -`QGAN.train()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.train()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Train the qGAN diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.md index 7cd80d2324f..b59e0f51ace 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -36,7 +36,7 @@ QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two -`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -57,7 +57,7 @@ MinimumEigensolverResult -`QPE.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.md index ecf1e8d533a..3dd3054fa81 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/1804.11326](https://arxiv.org/abs/1804.11326) -`QSVM.construct_circuit(x1, x2, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_circuit(x1, x2, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Generate inner product of x1 and x2 with the given feature map. @@ -68,7 +68,7 @@ constructed circuit -`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -98,7 +98,7 @@ numpy.ndarray -`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -126,7 +126,7 @@ numpy.ndarray -`QSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Load a model from a file path. @@ -138,7 +138,7 @@ Load a model from a file path. -`QSVM.predict(data, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.predict(data, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Predict using the svm. @@ -188,7 +188,7 @@ dict -`QSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Save the model to a file path. @@ -212,7 +212,7 @@ Sets backend with configuration. -`QSVM.setup_datapoint(datapoints)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_datapoint(datapoints)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup data points, if the data were there, they would be overwritten. @@ -224,7 +224,7 @@ Setup data points, if the data were there, they would be overwritten. -`QSVM.setup_test_data(test_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_test_data(test_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup test data, if the data were there, they would be overwritten. @@ -236,7 +236,7 @@ Setup test data, if the data were there, they would be overwritten. -`QSVM.setup_training_data(training_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_training_data(training_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup training data, if the data were there, they would be overwritten. @@ -248,7 +248,7 @@ Setup training data, if the data were there, they would be overwritten. -`QSVM.test(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.test(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Test the svm. @@ -274,7 +274,7 @@ float -`QSVM.train(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.train(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Train the svm. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.md index 6469b629d9f..1b4df2b01a5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`QuantumAlgorithm.run(quantum_instance=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.run(quantum_instance=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Execute the algorithm with selected backend. @@ -49,7 +49,7 @@ dict -`QuantumAlgorithm.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.md index 906bf8324e1..c70d9dd55e0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Construct circuit. @@ -64,7 +64,7 @@ Quantum circuit. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.md index 468f6eedbaf..a664949467d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`Simon.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.md index 114b49cd1b4..ea286eea4e7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` @@ -38,7 +38,7 @@ Internally, this algorithm will run the binary classification or multiclass clas -`SklearnSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Load a model from a file path. @@ -50,7 +50,7 @@ Load a model from a file path. -`SklearnSVM.predict(data)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.predict(data)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Predict using the SVM @@ -86,7 +86,7 @@ dict -`SklearnSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Save the model to a file path. @@ -98,7 +98,7 @@ Save the model to a file path. -`SklearnSVM.test(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.test(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Test the SVM @@ -119,7 +119,7 @@ float -`SklearnSVM.train(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.train(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Train the SVM diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.md index 17badab47c3..5b669ef12f5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -50,7 +50,7 @@ Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), -`VQC.batch_data(data, labels=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.batch_data(data, labels=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") batch data @@ -66,7 +66,7 @@ set parameterized circuits to None -`VQC.construct_circuit(x, theta, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.construct_circuit(x, theta, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Construct circuit based on data and parameters in variational form. @@ -120,7 +120,7 @@ dict -`VQC.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal circuit @@ -128,7 +128,7 @@ get optimal circuit -`VQC.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal cost @@ -136,7 +136,7 @@ get optimal cost -`VQC.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal vector @@ -160,7 +160,7 @@ get probabilities for counts -`VQC.is_gradient_really_supported()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.is_gradient_really_supported()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") returns is gradient really supported @@ -168,7 +168,7 @@ returns is gradient really supported -`VQC.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") load model @@ -176,7 +176,7 @@ load model -`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data. @@ -224,7 +224,7 @@ dict -`VQC.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") save model @@ -244,7 +244,7 @@ Sets backend with configuration. -`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data, and test against with ground truth labels. @@ -268,7 +268,7 @@ float -`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Train the models, and save results. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.md index 177f46fdf74..ec982849070 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -56,7 +56,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -77,7 +77,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -97,7 +97,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -149,7 +149,7 @@ dict -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -161,7 +161,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -173,7 +173,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -201,7 +201,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -254,7 +254,7 @@ Sets backend with configuration. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.md index 48fc6aa2731..f96e6e94ef1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.md index f45e1493fbd..55ada47cc05 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.md index cf2e01fee26..10d86130fc8 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 9b19c13d7f0..988178c03dc 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Quantum Phase Estimation Circuit. -`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Construct the Phase Estimation circuit diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.md index b93db01a246..51752d3e454 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Constructor. -`StateVectorCircuit.construct_circuit(circuit=None, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit.construct_circuit(circuit=None, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Construct the circuit representing the desired state vector. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.md index f03b31602d8..53f485efc6f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -35,7 +35,7 @@ Computes the weighted sum controlled by state qubits -`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`static WeightedSumOperator.get_required_sum_qubits(weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`static WeightedSumOperator.get_required_sum_qubits(weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") get required sum qubits @@ -152,7 +152,7 @@ get required sum qubits -`WeightedSumOperator.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") required ancillas @@ -160,7 +160,7 @@ required ancillas -`WeightedSumOperator.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.md index a33e8c8187a..e0c4d55bcfe 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Eigenvalues.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the eigenvalue estimation quantum circuit. @@ -49,7 +49,7 @@ object for the eigenvalue estimation circuit. -`Eigenvalues.construct_inverse(mode, circuit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues.construct_inverse(mode, circuit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the inverse eigenvalue estimation quantum circuit. @@ -77,7 +77,7 @@ circuit. -`abstract Eigenvalues.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get register sizes @@ -85,7 +85,7 @@ get register sizes -`abstract Eigenvalues.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get scaling diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.md index 2e3a140aed7..c5b9e1d0c41 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` @@ -36,7 +36,7 @@ Specifically, this class is based on PhaseEstimationCircuit with no measurements -`EigsQPE.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Construct the eigenvalues estimation using the PhaseEstimationCircuit @@ -89,7 +89,7 @@ circuit. -`EigsQPE.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get register sizes @@ -97,7 +97,7 @@ get register sizes -`EigsQPE.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get scaling diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.md index 0cbf5d6c13b..9319bd9c2eb 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Construct the variational form, given its parameters. @@ -46,7 +46,7 @@ a quantum circuit. -`static FeatureMap.get_entangler_map(map_type, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.get_entangler_map(map_type, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") get entangle map @@ -54,7 +54,7 @@ get entangle map -`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 409c3da2478..bb3b603b8a6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` @@ -28,7 +28,7 @@ The Raw Feature Vector can be directly used as a feature map, where the raw feat -`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Construct the second order expansion based on given data. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.md index 4517c472243..57ae062836a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -43,7 +43,7 @@ The custom initial state will be set from the *circuit*, the *state\_vector*, or -`Custom.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.md index c73507555a2..8cd086c95d1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract InitialState.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`abstract InitialState.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.md index e35c15f2541..04386860f9f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutoria -`VarFormBased.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.md index 2e66ab01606..b37e7959a31 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ This is suitable for those situations in which the all-zeros state is the desire -`Zero.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.md index 4e56d2102d5..9cbddbab79c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a -`AllPairs.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`AllPairs.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`AllPairs.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 603a21c221f..92f4f3b54bb 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -38,7 +38,7 @@ The table above shows a 6-bit ECC for a 3-class problem. Each class is assigned -`ErrorCorrectingCode.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Applying multiple estimators for prediction. @@ -70,7 +70,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`ErrorCorrectingCode.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -91,7 +91,7 @@ float -`ErrorCorrectingCode.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 4e5bfee3b20..c58a47d8259 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract MulticlassExtension.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Applying multiple estimators for prediction. @@ -36,7 +36,7 @@ Applying multiple estimators for prediction. -`MulticlassExtension.set_estimator(estimator_cls, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension.set_estimator(estimator_cls, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Called internally to set `Estimator` and parameters :type estimator\_cls: `Callable`\[\[`List`], `Estimator`] :param estimator\_cls: An `Estimator` class :type params: `Optional`\[`List`] :param params: Parameters for the estimator @@ -48,7 +48,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`abstract MulticlassExtension.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -61,7 +61,7 @@ Testing multiple estimators each for distinguishing a pair of classes. -`abstract MulticlassExtension.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99912cbdeaa..5746e6c21ed 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM cla -`OneAgainstRest.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`OneAgainstRest.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`OneAgainstRest.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index 8598a8a962c..27dff35e801 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module but raise an exception if a required co -`abstract DiscriminativeNetwork.get_label(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.get_label(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Apply quantum/classical neural network to the given input sample and compute the respective data label @@ -40,7 +40,7 @@ Apply quantum/classical neural network to the given input sample and compute the -`abstract DiscriminativeNetwork.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Loss function used for optimization @@ -62,7 +62,7 @@ Loss w\.r.t to the generated data points. -`abstract DiscriminativeNetwork.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Save discriminator model @@ -78,7 +78,7 @@ Save discriminator model -`abstract DiscriminativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Set seed. @@ -94,7 +94,7 @@ Set seed. -`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 87525ae962a..5cafb9ee98b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module, but raise an exception if a required c -`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Apply quantum/classical neural network to given input and get the respective output @@ -46,7 +46,7 @@ Neural network output -`abstract GenerativeNetwork.loss()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.loss()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Loss function used for optimization @@ -54,7 +54,7 @@ Loss function used for optimization -`abstract GenerativeNetwork.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set discriminator network. @@ -70,7 +70,7 @@ Set discriminator network. -`abstract GenerativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set seed. @@ -86,7 +86,7 @@ Set seed. -`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 508e3037633..51189161446 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -27,7 +27,7 @@ Discriminator based on NumPy -`NumPyDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -48,7 +48,7 @@ numpy.ndarray -`NumPyDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Load discriminator model @@ -60,7 +60,7 @@ Load discriminator model -`NumPyDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Loss function :param x: sample label (equivalent to discriminator output) :type x: numpy.ndarray :param y: target label :type y: numpy.ndarray :param weights: customized scaling for each sample (optional) :type weights: numpy.ndarray @@ -76,7 +76,7 @@ float -`NumPyDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Save discriminator model @@ -88,7 +88,7 @@ Save discriminator model -`NumPyDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Set seed. :param seed: seed :type seed: int @@ -96,7 +96,7 @@ Set seed. :param seed: seed :type seed: int -`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index 914d5fad9e0..09ec0d6fa91 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -31,7 +31,7 @@ Discriminator based on PyTorch -`PyTorchDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -52,7 +52,7 @@ torch.Tensor -`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Compute gradient penalty for discriminator optimization @@ -75,7 +75,7 @@ torch.Tensor -`PyTorchDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Load discriminator model @@ -87,7 +87,7 @@ Load discriminator model -`PyTorchDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Loss function @@ -109,7 +109,7 @@ torch.Tensor -`PyTorchDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Save discriminator model @@ -121,7 +121,7 @@ Save discriminator model -`PyTorchDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 11da90e6808..5b063c0b256 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` @@ -38,7 +38,7 @@ The quantum generator is a parametrized quantum circuit which can be trained wit -`QuantumGenerator.construct_circuit(params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.construct_circuit(params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Construct generator circuit. @@ -58,7 +58,7 @@ construct the quantum circuit and return as gate -`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Get classical data samples from the generator. Running the quantum generator circuit results in a quantum state. To train this generator with a classical discriminator, we need to sample classical outputs by measuring the quantum state and mapping them to feature space defined by the training data. @@ -80,7 +80,7 @@ list -`QuantumGenerator.loss(x, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.loss(x, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Loss function for training the generator’s parameters. @@ -101,7 +101,7 @@ float -`QuantumGenerator.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set discriminator network. @@ -117,7 +117,7 @@ Set discriminator network. -`QuantumGenerator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`QuantumGenerator.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.md index 1642282382a..c1aa6dbfde6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -48,7 +48,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -79,7 +79,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -95,7 +95,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -117,7 +117,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -155,7 +155,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.md index 82687ee457d..cb07e980296 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -45,7 +45,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Support level dictionary @@ -86,7 +86,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.md index 8a986e3c761..17ffb681269 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.md index 588d71e1e95..8389e09586c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize CG. For further detail, please refer to [https://do -`CG.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.md index 16da45b4d73..a0337c770a4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.minimize COBYLA. For further detail, please refer to [https: -`COBYLA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Return support level dictionary @@ -64,7 +64,7 @@ grad -`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.md index 771ae3eec74..c18de079b05 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.md index 3e2c4524bea..8128d75bb13 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index ae5dfe2e7b4..9cf5fd1788b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.md index f72728b4531..e18b87cecd3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.md index 40b08824745..e45cf06aa95 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -39,7 +39,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Return support level dictionary. @@ -55,7 +55,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -103,7 +103,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Run the line search optimization. @@ -131,7 +131,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Perform optimization. @@ -169,7 +169,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -193,7 +193,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.md index 503b45666d6..f96aa6e9508 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.md index 2307be651a4..dd96bbeb6a3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.md index 47d39c3177a..225aa2a83a7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -38,7 +38,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`L_BFGS_B.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Return support level dictionary @@ -69,7 +69,7 @@ grad -`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.md index b0a6d556988..951d36f56bd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize Nelder-Mead. For further detail, please refer to Se -`NELDER_MEAD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Return support level dictionary @@ -68,7 +68,7 @@ grad -`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.md index 8d818bbdf2f..e541f8173b4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -43,7 +43,7 @@ K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization fo -`NFT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") return support level dictionary @@ -74,7 +74,7 @@ grad -`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.md index 80e98a1d35c..c6705741607 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index 63d60f8c139..8c787fe12f7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.md index 74d8f777c17..bc33b3646a3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize Powell. For further detail, please refer to See [ht -`POWELL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.md index 9f7e665caea..fa6cfb71f22 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`P_BFGS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") return support level dictionary @@ -64,7 +64,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.md index d4cf3418d3a..271594803ec 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -36,7 +36,7 @@ Uses scipy.optimize.minimize SLSQP. For further detail, please refer to See [htt -`SLSQP.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Return support level dictionary @@ -67,7 +67,7 @@ grad -`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.md index c12fdcc6f6e..ba81d9e236b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.md index 9ea7dcf9cbe..57b9cda4881 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -51,7 +51,7 @@ For further details, please refer to [https://arxiv.org/pdf/1704.05018v2.pdf#sec -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") return support level dictionary @@ -82,7 +82,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.md index 86a951cf3ff..5ce0ad96d08 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize TNC For further detail, please refer to See [https: -`TNC.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") return support level dictionary @@ -68,7 +68,7 @@ grad -`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 95a27575e64..71443988da0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ This class is provided for easy creation of oracles using custom circuits. It is -`CustomCircuitOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index af31497f164..a17dc76baa0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -58,7 +58,7 @@ By default, the Logical Expression oracle will not try to apply any optimization -`LogicalExpressionOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") construct circuit @@ -66,7 +66,7 @@ construct circuit -`LogicalExpressionOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") evaluate classically diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.md index bc8909a4dd2..6f3f2f313a4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ This method should initialize the module and use an exception if a component of -`abstract Oracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`abstract Oracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.md index 83f64fb7476..d75f233bad4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ Regarding circuit optimization and mct usages, the truth table oracle is similar -`TruthTableOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") construct circuit @@ -54,7 +54,7 @@ construct circuit -`TruthTableOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") evaluate classical diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.md index ba457478c4f..5a4caa52a33 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -36,7 +36,7 @@ It finds the reciprocal with long division method and rotates the ancillary qubi -`LongDivision.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Construct the Long Division Rotation circuit. @@ -62,7 +62,7 @@ containing the Long Division Rotation circuit. -`LongDivision.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.md index d8db023f7f4..21c0acbde68 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -35,7 +35,7 @@ A calculation of reciprocals of eigenvalues is performed and controlled rotation -`LookupRotation.construct_circuit(mode, inreg)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.construct_circuit(mode, inreg)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Construct the Lookup Rotation circuit. @@ -60,7 +60,7 @@ NotImplementedError: mode not supported -`LookupRotation.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.md index fe08d1e0579..8c0ba818e7d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Construct the initial state circuit. @@ -42,7 +42,7 @@ The reciprocal circuit. -`abstract Reciprocal.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 545dc579533..a761e167b55 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 91cc535509c..748f3c73eab 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -35,7 +35,7 @@ Dependency between individual risk variables and latent variable is approximated -`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index c8f212d4df1..4355ff2fc65 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 6b9bc9c32d7..dda3b6f9e05 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -29,7 +29,7 @@ This module contains the definition of a base class for multivariate distributio -`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") ### build\_controlled @@ -129,7 +129,7 @@ returns number of qubits controlled -`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") pdf to probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index b0da929a0d1..0c92d70e77c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 56b5c191c73..9b1ad691dd2 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index e9517faa06b..0c07823fa19 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ Although this just results in a Hadamard gate on all involved qubits, the lower -`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index 82225843582..8b611c1f0c4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ The Multivariate Variational Distribution. -`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") ### build\_controlled @@ -154,7 +154,7 @@ returns required ancillas controlled -`MultivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index 574d76b9062..816a8c3ebc0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 3d78ef0f430..0efcb0c9223 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -22,7 +22,7 @@ The abstract Uncertainty Model -`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Adds corresponding sub-circuit to given circuit diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 7cca0f927c4..db8ec72852d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ Uniform distribution is defined by the number of qubits that should be used to r -`UniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") ### build\_controlled @@ -153,7 +153,7 @@ list -`UniformDistribution.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas @@ -161,7 +161,7 @@ returns required ancillas -`UniformDistribution.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index a7f59c743ae..098a1402e22 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -33,7 +33,7 @@ This module contains the definition of a base class for univariate distributions -`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") ### build\_controlled @@ -133,7 +133,7 @@ returns number of qubits controlled -`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 040089b5059..c5acc1805cb 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ The Univariate Variational Distribution. -`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") ### build\_controlled @@ -169,7 +169,7 @@ returns required ancillas controlled -`UnivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 7601ab629f2..d7d33f0762c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`MultivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`MultivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 250bbe128ad..88b518dfb92 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -147,7 +147,7 @@ returns required ancillas controlled -`UncertaintyProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 63199cf7444..0252c577e63 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -42,7 +42,7 @@ $$ -`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") ### build\_controlled @@ -142,7 +142,7 @@ returns number of qubits controlled -`UnivariatePiecewiseLinearObjective.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") requires ancillas @@ -158,7 +158,7 @@ returns required ancillas controlled -`UnivariatePiecewiseLinearObjective.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") value to estimation diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index 795745b2220..2cee7d25a27 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`UnivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`UnivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.md index 56c44d14c26..a6f628f93f6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract VariationalForm.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`abstract VariationalForm.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Construct the variational form, given its parameters. @@ -45,7 +45,7 @@ A quantum circuit. -`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") returns entangler map @@ -53,7 +53,7 @@ returns entangler map -`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.md index 78d926e0bb7..52f300b1ca7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -140,7 +140,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -162,7 +162,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -182,7 +182,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -198,7 +198,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Permutes the qubits of the operator. @@ -222,7 +222,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -242,7 +242,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -258,7 +258,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -270,7 +270,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -294,7 +294,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -314,7 +314,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -336,7 +336,7 @@ The `LegacyBaseOperator` representing this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.md index b6368fa370e..08c02698d7b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.md index e9783f821f1..1d28761a3f7 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -35,7 +35,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -60,7 +60,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. @@ -85,7 +85,7 @@ The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. -`CircuitSampler.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.md index 2107b6a1d2d..804264fbf74 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.md index 87540049609..dce2cbcb935 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.md index fbc3778b8d2..be149136d09 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TBP stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.md index 217601fddc1..f4b3fe51472 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.md index 54f196a9083..efede772208 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.md index 9fb3de17e9c..1cffa046041 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -95,7 +95,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -123,7 +123,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -143,7 +143,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -177,7 +177,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to the negation of self. -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -269,7 +269,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -285,7 +285,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -301,7 +301,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -403,7 +403,7 @@ The `LegacyBaseOperator` representing this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -419,7 +419,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.md index 67bc05bd33f..3304c4c1bb2 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index 8e276a706ab..f176beedf72 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.md index a3c8f15543f..5ad24fd7bff 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.md index 2b2083745e9..1235021c257 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.md index 6ac9cd1ce64..3fb5b235bb3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.md index aca978cce4a..1357669efc6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index a211e007991..e557805d407 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.md index 4a47649405a..88d453f3f7d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.md index eb85fc18bfa..67f3bef26cd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.md index d4ebaffdd5d..ca8eaabee5c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.md index 899b706f36e..f145817d2da 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.md index 1ed2fe426da..6b0d349e38b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.md index 115a7fef8a6..baa3f571a7c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.md index a902b5ae962..3665bc06a86 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.md index 2c755ac3ec0..5409b312c4f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.md index b8978323d97..9a156503c79 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -74,7 +74,7 @@ callable(param\_values) -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.md index 9a3aef0c97e..64476eeaabf 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.md index 55ab93c2325..cd419722bd4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.md index 31aa592b695..2484984c874 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.md index b1f14fb3936..0ad4946a2d5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.md index 6d7b8d64b4a..3a552c00d70 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.md index e11efc85ae5..96c2f27fc2f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.md index 1231b401a6e..e82979d6745 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 0a325af00ff..e163e07a261 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Bases: `abc.ABC` @@ -24,13 +24,13 @@ Constructor. -`abstract LegacyBaseOperator.chop(threshold, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.chop(threshold, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") ### construct\_evaluation\_circuit -`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Build circuits to compute the expectation w\.r.t the wavefunction. @@ -38,7 +38,7 @@ Build circuits to compute the expectation w\.r.t the wavefunction. -`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. @@ -46,7 +46,7 @@ Consume the result from the quantum computer to build the expectation, will be o -`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Time evolution, exp^(-jt H). @@ -54,7 +54,7 @@ Time evolution, exp^(-jt H). -`abstract LegacyBaseOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Check Operator is empty or not @@ -62,7 +62,7 @@ Check Operator is empty or not -`abstract LegacyBaseOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") print details @@ -70,7 +70,7 @@ print details -`abstract LegacyBaseOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Convert to new Operator format. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.md index d24a16a9769..ae1ad60213e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -34,13 +34,13 @@ Operators relevant for quantum applications -`MatrixOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### chop -`MatrixOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Eliminate the real and imagine part of coeff in each pauli by threshold. If pauli’s coeff is less then threshold in both real and imagine parts, the pauli is removed. To align the internal representations, all available representations are chopped. The chopped result is stored back to original property. Note: if coeff is real-only, the imag part is skipped. @@ -61,7 +61,7 @@ self or copy -`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Construct the circuits for evaluation. @@ -86,7 +86,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`MatrixOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Get a copy of self. @@ -94,7 +94,7 @@ Get a copy of self. -`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Use the executed result with operator to get the evaluated value. @@ -121,7 +121,7 @@ float -`MatrixOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Parameters** @@ -143,7 +143,7 @@ float -`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -172,7 +172,7 @@ numpy.array -`MatrixOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Check Operator is empty or not. @@ -188,7 +188,7 @@ bool -`MatrixOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Returns** @@ -202,13 +202,13 @@ str -`MatrixOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### to\_opflow -`MatrixOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.md index 58edb0b9a98..43ff09e9970 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 65630538d2f..bf4012a9ea0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` @@ -373,7 +373,7 @@ bool -`TPBGroupedWeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Perform self \* other. @@ -395,7 +395,7 @@ the multiplied operator -`TPBGroupedWeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -472,7 +472,7 @@ the simplified operator -`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Largest-Degree First Coloring for grouping paulis. @@ -550,7 +550,7 @@ to op flow -`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Greedy and unsorted grouping paulis. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 4130ae96338..4d1f948fa31 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -30,7 +30,7 @@ Weighted Pauli Operator -`WeightedPauliOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self + other. @@ -51,7 +51,7 @@ operator -`WeightedPauliOperator.anticommute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.anticommute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Anti commutes with @@ -59,7 +59,7 @@ Anti commutes with -`WeightedPauliOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminate the real and imagine part of weight in each pauli by threshold. If pauli’s weight is less then threshold in both real and imaginary parts, the pauli is removed. @@ -86,7 +86,7 @@ the operator is mutated. -`WeightedPauliOperator.commute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.commute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Commutes with @@ -94,7 +94,7 @@ Commutes with -`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Construct the circuits for evaluation, which calculating the expectation \. @@ -129,7 +129,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`WeightedPauliOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self @@ -137,7 +137,7 @@ Get a copy of self -`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.WeightedPauliOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. @@ -166,7 +166,7 @@ float -`WeightedPauliOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -188,7 +188,7 @@ float -`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -212,7 +212,7 @@ dict -`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -242,7 +242,7 @@ The constructed circuit. -`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -271,7 +271,7 @@ The constructed QuantumCircuit. -`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: @@ -308,7 +308,7 @@ the operator created from the input dictionary. -`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis in a file to construct an Operator. @@ -329,7 +329,7 @@ the loaded operator. -`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Create a WeightedPauliOperator via a pair of list. @@ -355,7 +355,7 @@ operator -`WeightedPauliOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check Operator is empty or not. @@ -371,7 +371,7 @@ bool -`WeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self \* other, and the phases are tracked. @@ -391,7 +391,7 @@ the multiplied operator -`WeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -407,7 +407,7 @@ str -`WeightedPauliOperator.reorder_paulis()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.reorder_paulis()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Reorder the paulis based on the basis and return the reordered paulis. @@ -423,7 +423,7 @@ the ordered paulis based on the basis. -`WeightedPauliOperator.rounding(decimals, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.rounding(decimals, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Rounding the weight. @@ -444,7 +444,7 @@ operator -`WeightedPauliOperator.simplify(copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.simplify(copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. @@ -468,7 +468,7 @@ the simplified operator -`WeightedPauliOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self - other. @@ -489,7 +489,7 @@ operator -`WeightedPauliOperator.to_dict()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_dict()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a dict in pauli representation. @@ -505,7 +505,7 @@ dict -`WeightedPauliOperator.to_file(file_name)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_file(file_name)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a file in pauli representation. @@ -517,7 +517,7 @@ Save operator to a file in pauli representation. -`WeightedPauliOperator.to_opflow(reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_opflow(reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.md index 07bd6621292..fad511f194a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ TaperedWeightedPauliOperator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self. @@ -73,7 +73,7 @@ copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -89,7 +89,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check the z2\_symmetries is empty or not. @@ -105,7 +105,7 @@ bool -`Z2Symmetries.taper(operator, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.taper(operator, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -132,7 +132,7 @@ list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`static Z2Symmetries.two_qubit_reduction(operator, num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`static Z2Symmetries.two_qubit_reduction(operator, num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.md index 2a15f7437f5..400e3845c24 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -96,7 +96,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -232,7 +232,7 @@ An `OperatorBase` equivalent to the negation of self. -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -308,7 +308,7 @@ A set of strings describing the primitives contained within the Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -368,7 +368,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.md index 234d33c0976..a21d9e5c3c4 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -105,7 +105,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -133,7 +133,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ListOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -241,7 +241,7 @@ An `OperatorBase` equivalent to the negation of self. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -265,7 +265,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -285,7 +285,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -301,7 +301,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -317,7 +317,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -341,7 +341,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -361,7 +361,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -373,7 +373,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -395,7 +395,7 @@ The `LegacyBaseOperator` representing this Operator. -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -411,7 +411,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -423,7 +423,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -435,7 +435,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -451,7 +451,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.md index 0d44bd127d9..41ccfd150e1 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -146,7 +146,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -328,7 +328,7 @@ A set of strings describing the primitives contained within the Operator. -`SummedOp.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Print out the operator in details. :returns: a formatted string describes the operator. :rtype: str @@ -336,7 +336,7 @@ Print out the operator in details. :returns: a formatted string describes the op -`SummedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -398,7 +398,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parametrized PrimitiveOps (in that case, AquaError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -431,7 +431,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`SummedOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -469,7 +469,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.md index 50a67ce9a69..ed9579963e6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -292,7 +292,7 @@ A set of strings describing the primitives contained within the Operator. -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -308,7 +308,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -352,7 +352,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0845d8186f3..972105875c3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -270,7 +270,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -286,7 +286,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -302,7 +302,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -346,7 +346,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -358,7 +358,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -370,7 +370,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -404,7 +404,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c06b5d15c6f..db393ba67f0 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -274,7 +274,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -306,7 +306,7 @@ The reduced `OperatorBase`. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -374,7 +374,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -386,7 +386,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -408,7 +408,7 @@ The `LegacyBaseOperator` representing this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -424,7 +424,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.md index 0e779e37344..0a29af1539e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -99,7 +99,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PauliOp.commutes(other_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.commutes(other_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns whether self commutes with other\_op. @@ -119,7 +119,7 @@ A bool equaling whether self commutes with other\_op -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -147,7 +147,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -167,7 +167,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -189,7 +189,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -249,7 +249,7 @@ An `OperatorBase` equivalent to the negation of self. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -293,7 +293,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -325,7 +325,7 @@ The reduced `OperatorBase`. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -393,7 +393,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -405,7 +405,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -427,7 +427,7 @@ The `LegacyBaseOperator` representing this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -455,7 +455,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -467,7 +467,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 06bb537c7b0..c29f249d801 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -97,7 +97,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -125,7 +125,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -145,7 +145,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -167,7 +167,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -179,7 +179,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -191,7 +191,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -227,7 +227,7 @@ An `OperatorBase` equivalent to the negation of self. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -251,7 +251,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -271,7 +271,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -287,7 +287,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -303,7 +303,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -327,7 +327,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -347,7 +347,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -359,7 +359,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -371,7 +371,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -383,7 +383,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -405,7 +405,7 @@ The `LegacyBaseOperator` representing this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -421,7 +421,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -433,7 +433,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 8fb7e91a1a3..15616f8ab35 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -136,7 +136,7 @@ An Operator equivalent to the function composition of self and other. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -185,7 +185,7 @@ A bool equal to the equality of self and other. -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -231,7 +231,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -257,7 +257,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -365,7 +365,7 @@ The reduced `OperatorBase`. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -387,7 +387,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -431,7 +431,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -443,7 +443,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -477,7 +477,7 @@ The `LegacyBaseOperator` representing this Operator. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -489,7 +489,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -501,7 +501,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.md index a6291c4b3ea..2acb13e731d 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -168,7 +168,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -188,7 +188,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -244,7 +244,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -284,7 +284,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -300,7 +300,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -316,7 +316,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -328,7 +328,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -372,7 +372,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -384,7 +384,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -396,7 +396,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -408,7 +408,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -438,7 +438,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.md index c7f657ffc46..7753ab1914e 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -204,7 +204,7 @@ An `OperatorBase` equivalent to the negation of self. -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -244,7 +244,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -298,7 +298,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -342,7 +342,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -354,7 +354,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -400,7 +400,7 @@ The `LegacyBaseOperator` representing this Operator. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -436,7 +436,7 @@ A VectorStateFn equivalent to self. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.md index d00c5e512aa..1e96869be1f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -384,7 +384,7 @@ The `LegacyBaseOperator` representing this Operator. -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -410,7 +410,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.md index 511b06e8ac4..f200f3a35ce 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -102,7 +102,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -128,7 +128,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -206,7 +206,7 @@ An `OperatorBase` equivalent to the negation of self. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -226,7 +226,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -246,7 +246,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -262,7 +262,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -278,7 +278,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -300,7 +300,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -324,7 +324,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -344,7 +344,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -368,7 +368,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -390,7 +390,7 @@ The `LegacyBaseOperator` representing this Operator. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -406,7 +406,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -426,7 +426,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.md index 1557aa5d657..afab35e8a34 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -374,7 +374,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -412,7 +412,7 @@ The `LegacyBaseOperator` representing this Operator. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -428,7 +428,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.md index 17e5fc4f133..34b0a0e40f6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for CircuitFactories -`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding sub-circuit to given circuit @@ -37,7 +37,7 @@ Adds corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding controlled sub-circuit to given circuit @@ -53,7 +53,7 @@ Adds corresponding controlled sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled inverse of corresponding sub-circuit to given circuit @@ -69,7 +69,7 @@ Adds controlled inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -77,7 +77,7 @@ Adds controlled, inverse, power of corresponding circuit. May be overridden if a -`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -85,7 +85,7 @@ Adds controlled power of corresponding circuit. May be overridden if a more effi -`CircuitFactory.build_inverse(qc, q, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse(qc, q, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse of corresponding sub-circuit to given circuit @@ -99,7 +99,7 @@ Adds inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -107,7 +107,7 @@ Adds inverse power of corresponding circuit. May be overridden if a more efficie -`CircuitFactory.build_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -115,7 +115,7 @@ Adds power of corresponding circuit. May be overridden if a more efficient imple -`CircuitFactory.get_num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits @@ -123,7 +123,7 @@ returns number of qubits -`CircuitFactory.get_num_qubits_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits controlled @@ -131,7 +131,7 @@ returns number of qubits controlled -`CircuitFactory.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas @@ -139,7 +139,7 @@ returns required ancillas -`CircuitFactory.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.31/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.31/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.31/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.md index f08a8c2467f..db0fe7be543 100644 --- a/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.31/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.31/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.31/qiskit.assembler.assemble_circuits.md index 0b7badfe8e7..91302eba922 100644 --- a/docs/api/qiskit/0.31/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.31/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.31/qiskit.assembler.assemble_schedules.md index 174896e6b6b..25ff21249a3 100644 --- a/docs/api/qiskit/0.31/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.31/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.31/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.31/qiskit.assembler.disassemble.md index acbe0abbd5d..d27cfe3c9e2 100644 --- a/docs/api/qiskit/0.31/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.31/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.md index d2285896e8f..362e19bbb2c 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ The Bosonic operator in this class is written in the n-mode second quantization -`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Filters out the states of irrelevant symmetries @@ -57,7 +57,7 @@ True if the state is has one and only one modal occupied per mode meaning that t -`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Maps a bosonic operator into a qubit operator. @@ -82,7 +82,7 @@ A qubit operator -`BosonicOperator.number_occupied_modals_per_mode(mode)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.number_occupied_modals_per_mode(mode)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A bosonic operator which can be used to evaluate the number of occupied modals in a given mode diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.md index 8852f24734c..88871eb1517 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ The [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") class -`FermionicOperator.fermion_mode_elimination(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_elimination(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Eliminate modes. @@ -72,7 +72,7 @@ Fermionic Hamiltonian -`FermionicOperator.fermion_mode_freezing(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_freezing(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Freezing modes and extracting its energy. @@ -94,7 +94,7 @@ tuple([FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.F -`FermionicOperator.mapping(map_type, threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.mapping(map_type, threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Map fermionic operator to qubit operator. @@ -121,7 +121,7 @@ create an Operator object in Paulis form. -`FermionicOperator.particle_hole_transformation(num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.particle_hole_transformation(num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") The ‘standard’ second quantized Hamiltonian can be transformed in the particle-hole (p/h) picture, which makes the expansion of the trail wavefunction from the HF reference state more natural. In fact, for both trail wavefunctions implemented in q-lib (‘heuristic’ hardware efficient and UCCSD) the p/h Hamiltonian improves the speed of convergence of the VQE algorithm for the calculation of the electronic ground state properties. For more information on the p/h formalism see: P. Barkoutsos, arXiv:1805.04340([https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340)). @@ -141,7 +141,7 @@ tuple -`FermionicOperator.total_angular_momentum()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_angular_momentum()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Total angular momentum. @@ -159,7 +159,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_magnetization()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_magnetization()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the magnetization of the given eigenstate. @@ -175,7 +175,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_particle_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_particle_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the number of particle of the given eigenstate. @@ -191,7 +191,7 @@ Fermionic Hamiltonian -`FermionicOperator.transform(unitary_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.transform(unitary_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Transform the one and two body term based on unitary\_matrix. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.md index 7767ac98360..a2386ddd296 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Bases: `object` @@ -41,7 +41,7 @@ A utility class for MP2 info -`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") With a reduced active space the set of used excitations can be less than allowing all available excitations. Given a (sub)set of excitations in the space this will return a list of correlation coefficients and a list of correlation energies ordered as per the excitation list provided. @@ -67,7 +67,7 @@ Tuple(list, list) -`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Gets the set of MP2 terms for the molecule taking into account index adjustments due to frozen core and/or other orbital reduction diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.md index e979a66297d..a35cd660fc7 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Bases: `object` @@ -28,13 +28,13 @@ This class provides methods to save it and load it again from an HDF5 file -`QMolecule.Z(natom)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.Z(natom)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ### has\_dipole\_integrals -`QMolecule.has_dipole_integrals()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.has_dipole_integrals()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Check if dipole integrals are present. @@ -42,7 +42,7 @@ Check if dipole integrals are present. -`QMolecule.load()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.load()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") loads info saved. @@ -50,7 +50,7 @@ loads info saved. -`QMolecule.log()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.log()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") log properties @@ -58,7 +58,7 @@ log properties -`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert one-body MO integrals to spin orbital basis @@ -82,7 +82,7 @@ numpy.ndarray -`static QMolecule.oneeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.oneeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts one-body integrals from AO to MO basis @@ -105,7 +105,7 @@ numpy.ndarray -`QMolecule.remove_file(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.remove_file(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") remove file @@ -113,7 +113,7 @@ remove file -`QMolecule.save(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.save(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Saves the info from the driver. @@ -121,7 +121,7 @@ Saves the info from the driver. -`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert two-body MO integrals to spin orbital basis @@ -146,7 +146,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts two-body integrals from AO to MO basis @@ -169,7 +169,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.md index 44ca4ce3362..1e48cd816ea 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.md index acff494f47e..cc29e688ef5 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.md index 4a12aea1ebf..2c9ac46295f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -51,7 +51,7 @@ The expectation value of the given operator(s). The return type will be identica -`AdaptVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -63,7 +63,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`AdaptVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Computes the ground state. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.md index 7f9d388d608..b20341d7dc0 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.md index 254c2c52a7a..e9d6ee9646a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a eigensolver based on a qubit operator transformation. -`abstract EigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`abstract EigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Returns a eigensolver, based on the qubit operator transformation. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index 7dad604602c..3ce3db48c4e 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via an Eigensolver algorithm -`ExcitedStatesEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Compute Ground and Excited States properties. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index e91e7836bc5..663ed080638 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The excited states calculation interface -`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Compute the excited states energies of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 02f4dbe380a..18e83d40eed 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` @@ -27,7 +27,7 @@ Ground state computation using a minimum eigensolver. -`GroundStateEigensolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Evaluates additional operators at the given state. @@ -48,7 +48,7 @@ The expectation value of the given operator(s). The return type will be identica -`GroundStateEigensolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -60,7 +60,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`GroundStateEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.md index 101256b9a3a..45cab346ef3 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ The ground state calculation interface -`abstract GroundStateSolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Evaluates additional operators at the given state. @@ -47,7 +47,7 @@ The expectation value of the given operator(s). The return type will be identica -`abstract GroundStateSolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Whether this class returns only the ground state energy or also the ground state itself. @@ -63,7 +63,7 @@ True, if this class also returns the ground state in the results object. False o -`abstract GroundStateSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index db1be79349d..eb9e42dbd54 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a minimum eigensolver based on a qubit operator transform -`abstract MinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns a minimum eigensolver, based on the qubit operator transformation. @@ -42,7 +42,7 @@ A minimum eigensolver suitable to compute the ground state of the molecule trans -`abstract MinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index e915859b2a4..c5759900f38 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` @@ -29,7 +29,7 @@ A factory to construct a NumPyEigensolver. -`NumPyEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Returns a NumPyEigensolver with the desired filter diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index f9cc83c2cc8..0587bb64afa 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -27,7 +27,7 @@ A factory to construct a NumPyMinimumEigensolver. -`NumPyMinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the `transformation`. @@ -47,7 +47,7 @@ A NumPyMinimumEigensolver suitable to compute the ground state of the molecule t -`NumPyMinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 0a0362652d0..1507f8c4edd 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -57,7 +57,7 @@ The expectation value of the given operator(s). The return type will be identica -`OrbitalOptimizationVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -69,7 +69,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`OrbitalOptimizationVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.md index 73920f5628b..2647a4e4f81 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via the qEOM algorithm -`QEOM.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Run the excited-states calculation. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.md index a80b38b913e..6e661775e3d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.md index 3bdfaeaae9a..caac0014a78 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.md index 25460147fc0..06e893291e1 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -79,7 +79,7 @@ dict -`VQEAdapt.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal circuit @@ -87,7 +87,7 @@ get optimal circuit -`VQEAdapt.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal cost @@ -95,7 +95,7 @@ get optimal cost -`VQEAdapt.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal vector diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 8d20352d9dc..134cd6fbcdd 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -35,7 +35,7 @@ A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. -`VQEUCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns a VQE with a UCCSD wavefunction ansatz, based on `transformation`. This works only with a `FermionicTransformation`. @@ -59,7 +59,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index db186bdd442..fe9d34414fd 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -31,7 +31,7 @@ A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction -`VQEUVCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns a VQE with a UVCCSD wavefunction ansatz, based on `transformation`. This works only with a `BosonicTransformation`. @@ -51,7 +51,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUVCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 9c6a5773253..7fd983696f2 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 6e977f009de..ebb790bcde3 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`DifferentialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Each parameter list and list of numerical gradients is treated as a single point in vector space. The regression model tries to fit a Hamiltonian that describes the evolution from one parameter set (and its gradient features) at point r, to another parameter set at point, r + epsilon. The regression model is then used to predict the parameter set at the point of interest. Note that this extrapolation technique does not explicitly use the spacing of the points (step size) but rather infers it from the list of parameter values. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index 8d04afed4fd..eda9274f2b4 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` @@ -26,7 +26,7 @@ This allows for fitting BOPES sampler results or potential energy surfaces. -`EnergySurface1DSpline.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -46,7 +46,7 @@ Value of surface fit in point x. -`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Fits surface to data. @@ -65,7 +65,7 @@ Fits surface to data. -`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. :type scaling: `float` :param scaling: scaling factor @@ -81,7 +81,7 @@ equilibrium geometry -`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. :type scaling: `float` :param scaling: scaling factor @@ -97,7 +97,7 @@ minimum energy -`EnergySurface1DSpline.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 589d66f534e..ecb8e7b2446 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a potential energy surface -`abstract EnergySurfaceBase.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -42,7 +42,7 @@ value of surface in point x -`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Fits surface to data @@ -61,7 +61,7 @@ Fits surface to data -`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the equilibrium energy. @@ -83,7 +83,7 @@ equilibrium geometry -`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the minimal energy. @@ -105,7 +105,7 @@ minimum energy -`abstract EnergySurfaceBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index 12098ea57e2..79f3c17b80d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ There are two types of Extrapolators: external/wrapper and internal. The externa -`abstract Extrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`abstract Extrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Abstract method to extrapolate point(s) of interest. @@ -47,7 +47,7 @@ Dictionary of variational parameters for extrapolated point(s). -`static Extrapolator.factory(mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`static Extrapolator.factory(mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Factory method for constructing extrapolators. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index 7916ddc3e05..5c81143c12a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -32,7 +32,7 @@ Input units are Angstroms (distance between the two atoms), and output units are -`HarmonicPotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the estimated dissociation energy for the current fit. @@ -52,7 +52,7 @@ estimated dissociation energy -`HarmonicPotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -72,7 +72,7 @@ value of potential in point x -`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Fits a potential to computed molecular energies. @@ -91,7 +91,7 @@ Fits a potential to computed molecular energies. -`static HarmonicPotential.fit_function(x, k, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`static HarmonicPotential.fit_function(x, k, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Functional form of the potential. @@ -114,7 +114,7 @@ harmonic potential functional form -`HarmonicPotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -130,7 +130,7 @@ fundamental frequency for the current fit -`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -170,7 +170,7 @@ maximum\_trusted\_level setted -`HarmonicPotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -214,7 +214,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`classmethod HarmonicPotential.process_fit_data(xdata, ydata)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`classmethod HarmonicPotential.process_fit_data(xdata, ydata)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() @@ -237,7 +237,7 @@ the processed data that fit better to a harmonic potential -`HarmonicPotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Updates the underlying molecule. @@ -257,7 +257,7 @@ Updates the underlying molecule. -`HarmonicPotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -277,7 +277,7 @@ vibrational energy level for the current fit -`HarmonicPotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 39f5a6ac5fd..f00c34443a6 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -34,7 +34,7 @@ Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algor -`MorsePotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the calculated dissociation energy for the current fit. @@ -54,7 +54,7 @@ calculated dissociation energy for the current fit -`MorsePotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -74,7 +74,7 @@ value of surface in point x -`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Fits a potential to computed molecular energies. @@ -93,7 +93,7 @@ Fits a potential to computed molecular energies. -`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Functional form of the potential. @@ -117,7 +117,7 @@ potential functional form -`MorsePotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -133,7 +133,7 @@ fundamental frequency for the current fit -`MorsePotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -153,7 +153,7 @@ interatomic distance corresponding to minimal energy -`MorsePotential.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. @@ -173,7 +173,7 @@ maximum\_trusted\_level estimated -`MorsePotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -217,7 +217,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`MorsePotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Updates the underlying molecule. @@ -237,7 +237,7 @@ Updates the underlying molecule. -`MorsePotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -257,7 +257,7 @@ vibrational energy level for the current fit -`MorsePotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index b9c05c60048..826a345addf 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -34,7 +34,7 @@ Constructor. -`PCAExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. This method transforms the parameters in PCA space before performing the internal extrapolation. The parameters are transformed back to regular space after extrapolation. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 67bf8bd84fa..3e3cb04837b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -30,7 +30,7 @@ Constructor. -`PolynomialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Extrapolation is based on a polynomial function/spline fitting with a user-specified degree. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 27e02c06513..362ee9caa30 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` @@ -22,7 +22,7 @@ Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of fr -`abstract PotentialBase.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract PotentialBase.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the dissociation energy (scaled by ‘scaling’) @@ -137,7 +137,7 @@ minimum energy -`PotentialBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") This (1D) potential represents a single vibrational mode @@ -149,7 +149,7 @@ This (1D) potential represents a single vibrational mode -`PotentialBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. Redefine in derived classes if needed. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index 2f59b46bb2c..4e0858f71f4 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -31,7 +31,7 @@ Constructor. -`SieveExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method finds a cutoff distance based on the maximum average distance or ‘gap’ between the average values of the variational parameters. This cutoff distance is used as a criteria to divide the parameters into two clusters by setting all parameters that are below the cutoff distance to zero. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index 6a795448f01..23343a3d42a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a molecular vibronic structure providing access to vibrational mod -`VibronicStructureBase.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. Default value of 100. Redefined where needed (see e.g. Morse). @@ -42,7 +42,7 @@ maximum\_trusted\_level setted -`abstract VibronicStructureBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the number of vibrational modes for the molecule. @@ -58,7 +58,7 @@ the number of vibrational modes -`VibronicStructureBase.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Wipe state if molecule changes, and check validity of molecule for potential. @@ -78,7 +78,7 @@ molecule used -`abstract VibronicStructureBase.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the n-th vibrational energy level for a given mode. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 681fb8420fb..434ae7bed14 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`WindowExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method defines the data window before performing the internal extrapolation. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index 3d7e0169b30..705c3b2b0c3 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Molecular ground state energy chemistry application -`MolecularGroundStateEnergy.compute_energy(callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy.compute_energy(callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver @@ -57,7 +57,7 @@ A molecular ground state result -`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index efe575f1e23..42af0c7e1c5 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Basis to express a second quantization Bosonic Hamiltonian. -`BosonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 36779a993cf..ef39732a053 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` @@ -34,7 +34,7 @@ This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) -`HarmonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.md index 2ffac17ec3c..d9d4dcec315 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -35,7 +35,7 @@ A Hartree-Fock initial state. -`HartreeFock.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.md index 2e0c0af3104..522b7cc0aa5 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ Creates an occupation number vector as defined in Ollitrault Pauline J., Chemica -`VSCF.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.md index 357ad749e4b..d1ef9c870cd 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -37,7 +37,7 @@ The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science -`CHC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.md index e709b18e9e7..c6cb6f62aa5 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -66,7 +66,7 @@ Constructor. -`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Computes single and double excitation lists. @@ -98,7 +98,7 @@ list -`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. @@ -119,7 +119,7 @@ list -`UCCSD.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Construct the variational form, given its parameters. @@ -152,7 +152,7 @@ returns entangler map -`static UCCSD.group_excitations(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. @@ -173,7 +173,7 @@ tuple -`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. @@ -194,7 +194,7 @@ list -`UCCSD.manage_hopping_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.manage_hopping_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Triggers the adaptive behavior of this UCCSD instance. This function is used by the Adaptive VQE algorithm. It stores the full list of available hopping operators in a so called “excitation pool” and clears the previous list to be empty. Furthermore, the depth is asserted to be 1 which is required by the Adaptive VQE algorithm. @@ -202,7 +202,7 @@ Triggers the adaptive behavior of this UCCSD instance. This function is used by -`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. @@ -223,7 +223,7 @@ list -`UCCSD.pop_hopping_operator()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.pop_hopping_operator()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pops the hopping operator that was added last. @@ -231,7 +231,7 @@ Pops the hopping operator that was added last. -`UCCSD.push_hopping_operator(excitation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.push_hopping_operator(excitation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pushes a new hopping operator. @@ -243,7 +243,7 @@ Pushes a new hopping operator. -`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Regroups the excitations that involve same spatial orbitals for example, with labeling. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.md index bee952ab726..f5d200aca47 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -34,7 +34,7 @@ This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Doub -`static UVCC.compute_excitation_lists(basis, degrees)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`static UVCC.compute_excitation_lists(basis, degrees)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Compute the list with all possible excitation for given orders @@ -59,7 +59,7 @@ List of excitation indexes in terms of modes and modals -`UVCC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Construct the variational form, given its parameters. @@ -85,7 +85,7 @@ Quantum Circuit a quantum circuit with given parameters -`UVCC.excitations_in_qubit_format()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.excitations_in_qubit_format()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") #### Gives the list of excitation indexes in terms of qubit indexes rather diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.md index 878f1ea509f..4061b4093bb 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for ChemistryOperator. -`ChemistryOperator.process_algorithm_result(algo_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator.process_algorithm_result(algo_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Takes the algorithm result and processes it as required, e.g. by combination of any parts that were classically computed, for the final result. @@ -42,7 +42,7 @@ Final chemistry result computed from the algorithm result -`abstract ChemistryOperator.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`abstract ChemistryOperator.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.md index c03444567c8..eb31d2657af 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` @@ -55,7 +55,7 @@ Final chemistry result computed from the algorithm result -`Hamiltonian.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") run method diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.md index 32e2f1c0875..a8f9f08f3e0 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.md index fd533f4dcab..e6b07622e9b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.md index 1302c42392b..2c4cd73fc6b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` @@ -68,7 +68,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`MolecularGroundStateResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether dipole moment is present in result or not @@ -80,7 +80,7 @@ Returns whether dipole moment is present in result or not -`MolecularGroundStateResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.md index bfb15314061..6ac9c24805a 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.md index d5c63c9d4f0..228ffac5f39 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.md index 39426cd2514..47f776191ca 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.md index b5df8909308..7f58d2463e8 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.md index 4da4e20d1af..8ec3e686c63 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry bosonic drivers. -`abstract BosonicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`abstract BosonicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.md index d79f936dd16..23caf4fba8b 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -39,7 +39,7 @@ A determinant based full configuration interaction program, Computer Physics Com -`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Convenience method to produce an FCIDump output file. @@ -58,7 +58,7 @@ Convenience method to produce an FCIDump output file. -`FCIDumpDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Constructs a QMolecule instance out of a FCIDump file. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.md index 174374675eb..3a4d06230a7 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry fermionic drivers. -`abstract FermionicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`abstract FermionicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.md index fe1cff4b4bf..37f1b1a1b71 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -37,7 +37,7 @@ This driver uses the Gaussian open-source Gaussian 16 interfacing code in order -`GaussianDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.md index 5b04ce5ae68..0f66d0991e1 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` @@ -34,7 +34,7 @@ Gaussian™ 16 forces driver. -`GaussianForcesDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.md index 5fc824ad1b9..6b7177cfdb7 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -36,7 +36,7 @@ This driver does not use Gaussian 16 interfacing code, as certain data such as f -`GaussianLogDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Runs the driver to produce a result given the supplied job control file. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.md index 40d7a5481cd..0e112c3acbd 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This result allows access to selected data from the log file that is not availab -`GaussianLogResult.get_watson_hamiltonian(normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult.get_watson_hamiltonian(normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Get the force constants as a WatsonHamiltonian diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.md index 9582539afdb..64e565da608 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -28,7 +28,7 @@ The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiski -`HDF5Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.md index 6289aa7eb45..928663b500f 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.md index 410096c76a9..3de633535df 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.md index ec18e83e10f..5796d2cf1bf 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ This module implements an interface for a driver-independent, i.e. generic molec -`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -56,7 +56,7 @@ end geometry -`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -76,7 +76,7 @@ end geometry -`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -96,7 +96,7 @@ end geometry -`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -116,7 +116,7 @@ end geometry -`classmethod Molecule.relative_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -136,7 +136,7 @@ end geometry -`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.md index d0a06fbbb14..ddb4af9d64d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -35,7 +35,7 @@ See [http://www.psicode.org/](http://www.psicode.org/) -`PSI4Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.md index 16d9f65e178..caea9901606 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -40,7 +40,7 @@ See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante -`PyQuanteDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.md index f4c64cdc041..55b44e98b06 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -42,7 +42,7 @@ See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) -`PySCFDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.md index 469b40c1e2a..6b4dc597ca3 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.md index 67d1f416cb9..1fb4cf470c9 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Creates an new instance of the result. :type points: `List`\[`float`] :param poi -`BOPESSamplerResult.point_results(point)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult.point_results(point)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") returns all results for a specific point. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.md index 767ebecf173..7a864fe5ae2 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.md index 71c4ad2f861..8a0b96613b1 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` @@ -66,7 +66,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`ElectronicStructureResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether dipole moment is present in result or not @@ -78,7 +78,7 @@ Returns whether dipole moment is present in result or not -`ElectronicStructureResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.md index cddb6391c36..cc2af141495 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.md index ce3d3d3d772..38002efdb4d 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.md index 3127a618daa..f908cca5d33 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -29,7 +29,7 @@ A vibronic Hamiltonian operator representing the energy of the nuclei in the mol -`BosonicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") **Parameters** @@ -47,7 +47,7 @@ Dict of hopping operators, dict of commutativity types and dict of excitation in -`BosonicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. In the fermionic case the default filter ensures that the number of particles is being preserved. @@ -59,7 +59,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`BosonicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -79,7 +79,7 @@ An vibronic structure result. -`BosonicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Transformation to qubit operator from the driver diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.md index bb6afdb8bce..58c401fa05c 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3ef9d847003..7b4deefdc79 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.md index 10bb4baa0fe..600ab26cb11 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -35,7 +35,7 @@ A transformation from a fermionic problem, represented by a driver, to a qubit o -`FermionicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -55,7 +55,7 @@ A tuple containing the hopping operators, the types of commutativities and the e -`FermionicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -69,7 +69,7 @@ In the fermionic case the default filter ensures that the number of particles is -`FermionicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -89,7 +89,7 @@ An electronic structure result. -`FermionicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.md index 2ae6f6416e7..fffc7533ce6 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.md index db32514f369..57e0ad41d45 100644 --- a/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.31/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for transformation to qubit operators for chemistry problems -`abstract Transformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -40,7 +40,7 @@ Returns: -`Transformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -52,7 +52,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`abstract Transformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -72,7 +72,7 @@ An “interpreted” eigenstate result. -`abstract Transformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.md index 8cd7b485d02..d3b4f754286 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.md index 634b2bed559..e53e9a58a06 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.md index bf25a7cff82..6bd13e1cfce 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.31/qiskit.circuit.Clbit.md index cf55bda3d15..43a6f8a46bd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.md index eb392cf3a31..092856d8c38 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -220,7 +220,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Delay.md b/docs/api/qiskit/0.31/qiskit.circuit.Delay.md index 4c0eed62094..ad694b6169a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Add classical condition on register or cbit classical and value val. @@ -91,7 +91,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -199,7 +199,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -215,7 +215,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.md index e05c34fb48b..02ce8f97850 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Gate.md b/docs/api/qiskit/0.31/qiskit.circuit.Gate.md index 59769962af3..2f5a5fba5e6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -110,7 +110,7 @@ Add classical condition on register or cbit classical and value val. -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -208,7 +208,7 @@ reversed. -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -306,7 +306,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -326,7 +326,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.31/qiskit.circuit.Instruction.md index 56dcacff5ea..df48ee72209 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add classical condition on register or cbit classical and value val. @@ -83,7 +83,7 @@ Add classical condition on register or cbit classical and value val. -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -105,7 +105,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -129,7 +129,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -137,7 +137,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") DEPRECATED: use instruction.reverse\_ops(). @@ -155,7 +155,7 @@ reversed. -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -165,7 +165,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -189,7 +189,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -209,7 +209,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -229,7 +229,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.md index 26139092e55..99238e090d4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -34,7 +34,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add condition on classical register to all instructions. @@ -42,7 +42,7 @@ Add condition on classical register to all instructions. -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Measure.md b/docs/api/qiskit/0.31/qiskit.circuit.Measure.md index 700d91f1abc..a57e26f4f61 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.31/qiskit.circuit.Parameter.md index 999790ae31b..da59ceeb105 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -175,7 +175,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.md index 1d8ee50f6ce..235fa17e288 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.md index f927e45c737..7828c4cbc07 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.md index 414b2908f3d..38e2c1dacfe 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla_0: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -135,7 +135,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -154,7 +154,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -162,7 +162,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -189,7 +189,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -287,7 +287,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is None, applies to all. @@ -295,7 +295,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`QuantumCircuit.bind_parameters(values, value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values, value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -323,7 +323,7 @@ copy of self with assignment substitution. -`static QuantumCircuit.cast(value, _type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, _type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -331,7 +331,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -351,7 +351,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -359,7 +359,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -367,7 +367,7 @@ Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -375,7 +375,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -383,7 +383,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -391,7 +391,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -419,7 +419,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -474,7 +474,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -500,7 +500,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -520,7 +520,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -536,7 +536,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -544,7 +544,7 @@ Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.C -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -552,7 +552,7 @@ Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -560,7 +560,7 @@ Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -568,7 +568,7 @@ Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -576,7 +576,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -584,7 +584,7 @@ Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -592,7 +592,7 @@ Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -600,7 +600,7 @@ Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -608,7 +608,7 @@ Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -616,7 +616,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -624,7 +624,7 @@ Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -632,7 +632,7 @@ Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -640,7 +640,7 @@ Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate -`QuantumCircuit.decompose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -656,7 +656,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -682,7 +682,7 @@ qiskit.Instruction -`QuantumCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’. @@ -729,7 +729,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -803,7 +803,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -811,7 +811,7 @@ Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -839,7 +839,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -847,7 +847,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -867,7 +867,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -887,7 +887,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -907,7 +907,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -923,7 +923,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -943,7 +943,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -951,7 +951,7 @@ Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1077,7 +1077,7 @@ circuit.draw() -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1183,7 +1183,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1191,7 +1191,7 @@ Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSw -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1261,7 +1261,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1269,7 +1269,7 @@ Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1277,7 +1277,7 @@ Apply `MCU1Gate`. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1312,7 +1312,7 @@ qiskit.Instruction -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -1334,7 +1334,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured. @@ -1356,7 +1356,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). @@ -1364,7 +1364,7 @@ Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -1384,7 +1384,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -1394,7 +1394,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1406,7 +1406,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1414,7 +1414,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -1422,7 +1422,7 @@ Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.Pha -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -1430,7 +1430,7 @@ Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.Pau -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -1457,7 +1457,7 @@ A circuit implementing this circuit raised to the power of `power`. -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -1484,7 +1484,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -1504,7 +1504,7 @@ List(tuple) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1524,7 +1524,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1551,7 +1551,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1578,7 +1578,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -1586,7 +1586,7 @@ Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -1594,7 +1594,7 @@ Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XG -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -1602,7 +1602,7 @@ Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXG -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurement on all qubits if they are present. Deletes the ClassicalRegister that was used to store the values from these measurements if it is idle. @@ -1624,7 +1624,7 @@ Returns circuit with measurements removed when inplace = False. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -1652,7 +1652,7 @@ Reset q. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -1698,7 +1698,7 @@ the circuit with reversed bit order. -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -1742,7 +1742,7 @@ the reversed circuit. -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -1750,7 +1750,7 @@ Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -1758,7 +1758,7 @@ Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -1766,7 +1766,7 @@ Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -1774,7 +1774,7 @@ Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -1782,7 +1782,7 @@ Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -1790,7 +1790,7 @@ Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -1798,7 +1798,7 @@ Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -1806,7 +1806,7 @@ Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -2179,7 +2179,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -2333,7 +2333,7 @@ with attached instruction. -`QuantumCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of gate operations in circuit. @@ -2554,7 +2554,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -2562,7 +2562,7 @@ Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapG -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -2570,7 +2570,7 @@ Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -2578,7 +2578,7 @@ Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgG -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -2586,7 +2586,7 @@ Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -2594,7 +2594,7 @@ Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -2647,7 +2647,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -2668,7 +2668,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -2689,7 +2689,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -2697,7 +2697,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -2705,7 +2705,7 @@ Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -2713,7 +2713,7 @@ Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -2721,7 +2721,7 @@ Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -2850,7 +2850,7 @@ Apply unitary gate to q. -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -2866,7 +2866,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -2874,7 +2874,7 @@ Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -2882,7 +2882,7 @@ Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.md index 631b64d0b63..722180a95cc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.31/qiskit.circuit.Qubit.md index fd6ea387a2e..19f2145d2f9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.Reset.md b/docs/api/qiskit/0.31/qiskit.circuit.Reset.md index db36821fa59..d5ad125a0fa 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.md index 5575c46c0c3..cdc8153858e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -154,7 +154,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -302,7 +302,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -344,7 +344,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.md index ae94f80d436..fc8063c3c3d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -114,7 +114,7 @@ Add classical condition on register or cbit classical and value val. -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -298,7 +298,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -320,7 +320,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -356,7 +356,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 85a2a4729a6..690b52b4c36 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index c691288c43f..b79995d471d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.31/qiskit.circuit.library.AND.md index 648a2389ca2..7f2677e8362 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.md index 4a06432d594..4ab5adee456 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new barrier instruction. -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -45,7 +45,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Add classical condition on register or cbit classical and value val. @@ -53,7 +53,7 @@ Add classical condition on register or cbit classical and value val. -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.md index 23c145e9e74..b81d851ee9e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -36,7 +36,7 @@ Create a new 3-qubit controlled sqrt-X gate. -`C3SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C3X is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.md index 4f5eb579f84..dab626ac268 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.md index 0038fd79bca..53b513d6f96 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.md index f9854e01b74..d753960e13f 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.md index ea639de97f0..eeb3a99ef58 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.md index db9ad0a42b4..516204a66dd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -70,7 +70,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.md index 82f2112954e..d7d969d902e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.md index 0e942b081ea..d5ed8c39cb4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.md index 292afa15c6c..c381a22dfd4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.md index 56c6b377137..a847c538920 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.md index 98942079f30..5276c1ecf8d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.md index 1202f7eeba0..a21a2548b47 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.md index da4776b973c..7970d7e8a25 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.md index 17ef47f3306..a5743476752 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.md index 43b3ad8715d..906ec5cb3ce 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.md index 7b91c381efd..36131fed814 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.md index a378b4b80a7..c4b531b53e8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.md index 52efb1bfa37..24b88e1940c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.md index e7e2290cfc7..a9d87e54627 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.md index 2e490ea940e..69c00e1915b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.md index a953a4e9416..39b77eced97 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.md index 46381f1c63b..1840acc87f7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.md index 148ac42d178..d85c1f18dd6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.md index f7a3859659a..70d9c94e621 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.md index 4bcb1e1beac..1e1629743b4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.md index f4e892c337c..5ca272dd016 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.md index 4d2d9169916..2587327f214 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.md index 5a745088e3c..0efc064dc8a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GR.md index 7209ecc0e08..88471addd14 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.md index 71aa083afec..d71317a0cd6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.md index 6cc06a24d47..af1b23cd589 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.md index 8466600f053..d664f0e14c8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.md index 3a9588f99c8..2508e7ae1f6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.md index f7bf6ce118e..f4e6f51982c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.md index d24f0a4df5b..35169041b9c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.md index 500b209d60c..941dfdc7e08 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.md index 1f5fe56e5ea..9349598046e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.md index ab0a4176c1d..3f44eb54c23 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.md index cb1b17a1357..1657b6fdedf 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.md index 2c236db1c10..10d4c612562 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.md index 3d904625192..dafb19123ec 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.md index 9bc4122037a..17aae70d925 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.md index 74928b7d27a..42a3793e589 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.md index 3a1185f373c..a73e1a3c7ba 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.md index 426d49f6834..a1f966647ea 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.md index aeeda9cf0d0..cad9befc265 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.md index bc67b7ca908..09bff9dc82a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.md index 74b06fd9380..ed6c036caa1 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -56,7 +56,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.md index 18d5c37cb29..7e4aa6039f7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.md index 8dcdd3807ad..a89c06d33c9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.md index 935f91d10df..22d510c1ec4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.md index 0f11bf418ed..dc14bf47721 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.md index 00c1ed0cbf3..78cd4e05a36 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new measurement instruction. -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.md index def9356edec..d732503ade4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.md index 488a4caa893..6487b4a9504 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.31/qiskit.circuit.library.OR.md index f3ee7c97b11..aaf0af23333 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.md index 5c5e6f8db3b..f21509e9eb3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.md index 8a71080853b..e57682cb532 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.md index 7119daf7f7a..43289d23126 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.md index eee3eca569b..805faa49e8d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.md index 9a8009546db..f5a7b24e9d6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.md index fd53a6d8cab..32f9efd9359 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.md index 58771a39d73..166d3fa0577 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.md index 3ab4c697b93..ac6093e9f17 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 94a1cfd492e..2ae019ee8ba 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 20b10508163..93cf5d80a58 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.md index 2ada624c39e..764103c3df9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.md index cafd21b595a..fa44d5455a8 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.md index 932311cba70..ebad93bf9dc 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.md index 4545b2500a6..eda2a66ffb5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.md index fcdcf5d04fa..0c2138024eb 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.md index 0e3f7bac634..b425c7d26d2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.md index 0db3218bc97..88734afdf67 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.md index eab5fe55fe1..9579e5419c2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.md index 6e023f33c0f..83948311cde 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.md index 128c18dcf46..bd51856b2e0 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.md index 2b46955c44e..88fd78628f6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.md index ef77affdaac..987786012e5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.md index 2f2035eae69..1f6ba208e32 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.md index fa44339fb50..0c6126f7086 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.md index e8244085f6b..30d6950547c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.md index 4cfbee61b1f..4593c6a22a4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.md index d38c6c1667b..3e2bbbcb12d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.md index 989de416035..2d3490388db 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.md index c20563ec423..6dd72cc2346 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new reset instruction. -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.md index c6a7b1e06cd..eedca638845 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.md index c657f0ee852..536757393e2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.md index a829101a023..8518ed4751c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.md index d913f0e62cd..2d08b505e5b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.md index f11d7eb6216..cc6e058caa2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.md index b8035708015..db12e700fda 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.md index d03585524b0..f611ea7a707 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.md index e3dbaeb72dd..80e87fb56a1 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.md index 4f10c56dc2b..a78f7f2c8e2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.md index a9e5a1e7145..3e8ada96707 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.md index d908894c93e..20690138ae9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.md index 09a37c12208..b5a4cf7ed64 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.md index 07bb23f2d15..0c4ca373ef7 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.md index 25157118440..d89c12cca70 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.md index 7d5b28937ca..dd6717b85a0 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.md index f18f5ae21b2..d07a7109f78 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.md index 43e734f066e..c4211df1578 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.md index 21f9a64cd0c..a82778ecd28 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.md index c576b3ad645..f979263538b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.md index d1e1747e332..5d76044f233 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.md index df1ea433e53..2f1552e5317 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_1.md index 42cf538c532..22bd668f91f 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_2.md index 5bf66e9f98c..f2c5dd8fc10 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_3.md index 927f19fa200..94d8dfa34f4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_4.md index 8b16e2825d6..b22af4fca25 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_3_1.md index 2c09082d230..4fba3a33436 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_1.md index 07b3612de9c..ecf6ae0b847 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_2.md index 36856209e49..3c8360c05de 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_3.md index d0f5a22555e..b383502f2b2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_4.md index 57ae97f2a84..d05d911fcf2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_5_1.md index 570f78364e6..a13af44ea44 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_1.md index a9b3cb55224..ab33af8a64c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_2.md index 0a9966bb05d..5300850cc44 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_3.md index c979ff290d7..9d98315d660 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_4.md index e48a68c9e45..b60dac07ece 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_5.md index 69364d28f8d..04add82fbe3 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_1.md index 4e11397bbef..5023943cd35 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_2.md index 0485bc05efe..ced38daade6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_3.md index feaaa81f23c..caa0eaa3b81 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.md index 6b4367232a1..22826237cef 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_cy.md index bae210512c6..5cee06c07dd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_xz.md index 6111e4b6d65..41579dc8e27 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_yz.md index f5feb56c245..a09251daecb 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz1.md index f8a2218bc4b..cae37878081 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz2.md index d4d76d03eb4..4771308c6ef 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz3.md index 9ab0e123a91..92dcb301fc6 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index fccc60c5901..6901ced3335 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index bc9dfac625c..79f50d36359 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 9a0f1d6e2e0..8275bd14b9d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index a099d56f93c..6a139dddd79 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 199b0ba73fb..af90757559d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index d8f119d2cde..6a7e2cbba0e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 645f993d038..64eb9dbc638 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index b29f66cbbd3..7d5f16134f9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index cdfab95456d..28a9def5e19 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 42e44c71ccb..38eb6fe0f01 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f2bf2fb8ffd..bfa2880e791 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f5857f8be6d..7bc7fb49e7f 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 54d796c48ea..3c958322aef 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 497c7f651c8..d7857911c5c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 05dd1473bf2..500c3f9542b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index bf4346c45e9..506e1f4c1e5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 143ce700b60..575584da1f5 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index bddea475821..c21c0e0b10b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 1d23abdcba1..dfdf7f93c5e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 5e04b1587b2..31a4609876c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7f827c64901..ad51542d5c9 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 5fd5601a5c9..e8b1fd4612d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index c8b3b9b383b..d6a37940f1a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 5e36d6a1208..86f78e9c92a 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 1340401a8c0..88220d5de36 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 7d6a80af75b..b0ac097f194 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 9d72c54ca1a..19994762b62 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index cfb20db8ead..4e172dfcd3c 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8f053052c41..bf49584b47e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 0dbc8a78f8c..406a990948d 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 767dfc0dc71..4af3a1e4799 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index fbf1fac3a16..cbb0b73f437 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index e00e9a09031..d026edef43f 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 51fafdebc96..e2d6bdcc984 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 7c6acba7de7..9bd4b84a326 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 23417772375..736756f7008 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 1f41755ea0a..4bd9eac06cd 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index f66ad8c3ec1..d55f4e85b13 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 42e65f18b74..7d348ef65a4 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index dcdd118e19e..5c506c0d1a2 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 2eae01bb124..10b935ea263 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 4038dc3d507..83a8fd11254 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 705eded25a9..d07c214552b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4c845969dab..68996fb600e 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index d55538e6a62..80d5f36a9d0 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 4865ff7af80..ca902b97814 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 03d25edc1ff..f2a903e2504 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.dump.md b/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.dump.md index 6e832dbf55e..b5c5db7be06 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.dump.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.dump -`dump(circuits, file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`dump(circuits, file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.load.md b/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.load.md index 5df021c72c7..f3b81e96362 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.load.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.qpy_serialization.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.load -`load(file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`load(file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.31/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.31/qiskit.circuit.random.random_circuit.md index 01b29b3a24c..ff1e7ed924b 100644 --- a/docs/api/qiskit/0.31/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.31/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.31/qiskit.compiler.assemble.md b/docs/api/qiskit/0.31/qiskit.compiler.assemble.md index 5ca3ef24c10..4fe7956f99a 100644 --- a/docs/api/qiskit/0.31/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.31/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.31/qiskit.compiler.schedule.md b/docs/api/qiskit/0.31/qiskit.compiler.schedule.md index 8e7a6cffa9f..6788dfb4f20 100644 --- a/docs/api/qiskit/0.31/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.31/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.31/qiskit.compiler.sequence.md b/docs/api/qiskit/0.31/qiskit.compiler.sequence.md index 5bfaf303b8b..4fceaa00aab 100644 --- a/docs/api/qiskit/0.31/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.31/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.31/qiskit.compiler.transpile.md b/docs/api/qiskit/0.31/qiskit.compiler.transpile.md index 3102cf09b2e..485f96f1b66 100644 --- a/docs/api/qiskit/0.31/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.31/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.31/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.31/qiskit.converters.ast_to_dag.md index 98cd791912d..c2260b00b70 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.31/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dag.md index 5a5d850aec4..a5053e26cce 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dagdependency.md index 15a315afab9..ea1f2e076ca 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_gate.md index 9ec3011bd18..4ec8eb91504 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_instruction.md index 7722625b5ea..c2aabbcddf8 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.31/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.31/qiskit.converters.dag_to_circuit.md index 9fd5e9df0d5..e87a0827eee 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.31/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.31/qiskit.converters.dag_to_dagdependency.md index 1659bc658dd..40903d9c45a 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.31/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_circuit.md index 8bc14e76d3b..a95b2c1d722 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_dag.md index 340e3d702ef..87bb9458172 100644 --- a/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.31/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.md index 494a5dfc982..54c4c701d79 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -112,7 +112,7 @@ the current max node -`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -139,7 +139,7 @@ the current max node -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -147,7 +147,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -155,7 +155,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -167,7 +167,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -200,7 +200,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.compose_back(input_circuit, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose_back(input_circuit, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: use DAGCircuit.compose() instead. @@ -208,7 +208,7 @@ DEPRECATED: use DAGCircuit.compose() instead. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -218,7 +218,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -228,7 +228,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -240,7 +240,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGNodes. @@ -248,7 +248,7 @@ Returns set of the descendants of a node as DAGNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -272,7 +272,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -294,7 +294,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.extend_back(dag, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.extend_back(dag, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: Add dag at the end of self, using edge\_map. @@ -302,7 +302,7 @@ DEPRECATED: Add dag at the end of self, using edge\_map. -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -329,7 +329,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -337,7 +337,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -353,7 +353,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -361,7 +361,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -377,7 +377,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -385,7 +385,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -393,7 +393,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -407,7 +407,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGNodes. @@ -415,7 +415,7 @@ Returns the longest path in the dag as a list of DAGNodes. -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -423,7 +423,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -431,7 +431,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -439,7 +439,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -459,7 +459,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -471,7 +471,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -492,7 +492,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -500,7 +500,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -508,7 +508,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -516,7 +516,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -537,7 +537,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGNodes. @@ -545,7 +545,7 @@ Returns iterator of the predecessors of a node as DAGNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -553,7 +553,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as DAGNodes. @@ -569,7 +569,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -577,7 +577,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -585,7 +585,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -593,7 +593,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -609,7 +609,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -619,7 +619,7 @@ Add edges from predecessors to successors. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -635,7 +635,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -645,7 +645,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -653,7 +653,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a DAGNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -680,7 +680,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -698,7 +698,7 @@ Replace one node with dag. -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGNodes. @@ -706,7 +706,7 @@ Returns iterator of the successors of a node as DAGNodes. -`DAGCircuit.threeQ_or_more_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.threeQ_or_more_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3-or-more-qubit gates: (id, data). @@ -714,7 +714,7 @@ Get list of 3-or-more-qubit gates: (id, data). -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -722,7 +722,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -738,7 +738,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.topological_op_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -754,7 +754,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.twoQ_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.twoQ_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. @@ -762,7 +762,7 @@ Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -770,7 +770,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.md index bb21501298e..5a90ee6e808 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.md index bcd32521e05..a1b007467cd 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.md index fa2fb46df2b..3b7a6b442e9 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.md index f1bc71320da..8347f948010 100644 --- a/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.31/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.md index 6e95a5df69a..12f758d29b9 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.31/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -121,7 +121,7 @@ Add classical condition on register or cbit classical and value val. -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -177,7 +177,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -327,7 +327,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -335,7 +335,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.31/qiskit.extensions.Initialize.md index b853a50324b..90caafc8c78 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.31/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -60,7 +60,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -111,7 +111,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. @@ -251,7 +251,7 @@ bool -`Initialize.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Initialize instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.md index d83db85713b..cc5cd584b18 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.31/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Add classical condition on register or cbit classical and value val. @@ -103,7 +103,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.md index b465d1acd69..a77284cbebb 100644 --- a/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.31/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -120,7 +120,7 @@ Add classical condition on register or cbit classical and value val. -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -128,7 +128,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -177,7 +177,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -327,7 +327,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -335,7 +335,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.md index ab5c5a443aa..ed05ecd5593 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.31/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 05de4ab6cb8..19f5413aa81 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -33,7 +33,7 @@ Constructor. -`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Adds corresponding sub-circuit to given circuit @@ -142,7 +142,7 @@ returns number of qubits controlled -`EuropeanCallDelta.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas @@ -150,7 +150,7 @@ returns required ancillas -`EuropeanCallDelta.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index 392aea5a2ca..9f5b6d2a1bb 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -35,7 +35,7 @@ Constructor. -`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`EuropeanCallExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") returns required ancillas @@ -160,7 +160,7 @@ returns required ancillas controlled -`EuropeanCallExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 316c8b5f2a0..e04857292ee 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.31/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -36,7 +36,7 @@ Constructor. -`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -145,7 +145,7 @@ returns number of qubits controlled -`FixedIncomeExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas @@ -153,7 +153,7 @@ returns required ancillas -`FixedIncomeExpectedValue.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas controlled @@ -161,7 +161,7 @@ returns required ancillas controlled -`FixedIncomeExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.md index fb1cdeb326d..5540c469166 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ To use the subclasses, please see [https://github.com/Qiskit/qiskit-tutorials/bl -`BaseDataProvider.get_coordinates()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_coordinates()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns random coordinates for visualisation purposes. @@ -38,7 +38,7 @@ Returns random coordinates for visualisation purposes. -`BaseDataProvider.get_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns the covariance matrix. @@ -58,7 +58,7 @@ an asset-to-asset covariance matrix. -`BaseDataProvider.get_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -78,7 +78,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -98,7 +98,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -118,7 +118,7 @@ a per-asset mean vector. -`BaseDataProvider.get_similarity_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_similarity_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns time-series similarity matrix computed using dynamic time warping. @@ -138,7 +138,7 @@ an asset-to-asset similarity matrix. -`abstract BaseDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`abstract BaseDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Loads data. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.md index 94753becaed..ad9fb1dd4b5 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -144,7 +144,7 @@ an asset-to-asset similarity matrix. -`DataOnDemandProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.md index e1cc0617a79..d67f4ff88e0 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -143,7 +143,7 @@ an asset-to-asset similarity matrix. -`ExchangeDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.md index 1bcbc4c4948..4d6bbfd435a 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -140,7 +140,7 @@ an asset-to-asset similarity matrix. -`RandomDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Generates data pseudo-randomly, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.md index 52aba5452c7..4828fddcb3f 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.md index f19acad7323..54b205c6808 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`WikipediaDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.md index 2ee584d5c10..f205961b05b 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.31/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`YahooDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.md index dd9d483900a..35f05b36244 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.md index d0f88c08567..0d3fdafef06 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.md index 90e5c8b58f0..7aec65b5119 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.md index fd940e7ee8c..d5e4b734fc6 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.md index c71f6cc0b9a..8d56ebaf63c 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.md index 1cec73b08a3..419df9ac5b1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.md index 2242b5d8764..c057d7d091d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.md index d02ec6dd010..a155df678ed 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.md index c18ff34c92c..2ffb7fe61bb 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.md index 46efe0157ed..5a997c28987 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.md index b7627d45203..b011b738b4d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.md index 3a8aa5098ec..ae5f847fa56 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.31/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.md index 3922362b0f9..b41fdc9b1dc 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.md index 033560eff61..56e9976dfe2 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.md index 54364b12efc..c695dc4b508 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.md index 8584a3a690f..49fe9e2c3c1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.md index 40d7957630a..4b6c2e26112 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.md index ba4bd514893..387f010961b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 3d6f722a7e0..452e3277c6d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.md index 93de99f8d05..eba4d8a9ad6 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 334088e40ef..d3bcce556c0 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0ca0b7b67c0..b3cb9710f5c 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.md index 0f3bba86927..d072e158644 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 57a69ef51fa..2f83a375cb5 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.md index 4bc47d26b5b..a69d4e77ba6 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 49e3ba02622..15cd48b959a 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.md index 2b0a1ce3bd7..d4b3fe51512 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.md index a4bb48a9b8e..ed39147d0d5 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index d81412ceb46..19751a1f08b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.md index 5dc44ca0492..2b8d0b699ec 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -55,7 +55,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.md index 4d41f6e5e23..0577877a3bf 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence @@ -36,7 +36,7 @@ This function computes the bound on variation distance based and the confidence -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single protocol run of accreditation protocol on simul backend diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.md index 01718a5447a..854522ad63e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.md index 7f5ca421e29..ccacdd777f0 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` @@ -29,7 +29,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate transpose of the CNOTDihedral element @@ -37,7 +37,7 @@ Return the conjugate transpose of the CNOTDihedral element -`CNOTDihedral.cnot(i, j)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.cnot(i, j)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. @@ -45,7 +45,7 @@ Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the composed operator. @@ -76,7 +76,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate of the CNOTDihedral element. @@ -92,7 +92,7 @@ Make a deep copy of current operator. -`CNOTDihedral.dot(other, qargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.dot(other, qargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the right multiplied operator self \* other. @@ -118,7 +118,7 @@ The operator self \* other. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: other tensor self. @@ -138,7 +138,7 @@ the tensor product operator: other tensor other. -`CNOTDihedral.flip(i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.flip(i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply X to this element. Left multiply the element by X\_i. @@ -146,7 +146,7 @@ Apply X to this element. Left multiply the element by X\_i. -`CNOTDihedral.from_circuit(circuit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.from_circuit(circuit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -178,7 +178,7 @@ Return tuple of input dimension for specified subsystems. -`CNOTDihedral.is_cnotdihedral()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.is_cnotdihedral()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return True if input is a CNOTDihedral element. @@ -194,7 +194,7 @@ Return tuple of output dimension for specified subsystems. -`CNOTDihedral.phase(k, i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.phase(k, i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply an k-th power of T to this element. Left multiply the element by T\_i^k. @@ -252,7 +252,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: self tensor other. @@ -272,7 +272,7 @@ the tensor product operator: self tensor other. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -297,7 +297,7 @@ Decompose 1 and 2-qubit CNOTDihedral elements. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -305,7 +305,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -313,7 +313,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert to an Operator object. @@ -321,7 +321,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the transpose of the CNOT-Dihedral element. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 754b7eacb30..8b2163e96d9 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.md index b18f6f79193..d7854d7e13b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.md index 62ed38a919d..cb084321e40 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. @@ -56,7 +56,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -76,7 +76,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -96,7 +96,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -120,7 +120,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.md index e82966c03c0..5be47257523 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.md index 3d42ae904cb..087a91924f8 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.md index b74bafa3b11..41820f2d520 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.md index 751d05ee71f..92bd314c40e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.md index 1454540bb20..55810cc5d2f 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.md index 397eae2c7c4..d43065093ae 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.md index a7421af715c..9c90d276cbf 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -47,7 +47,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -71,7 +71,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -79,7 +79,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(reset=True, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(reset=True, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -92,7 +92,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.md index 69e323d90d6..80681d4d48a 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.md index 9ec254be6af..8a8b513d769 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.gates_per_clifford.md index 74ed57d1660..8738586a6b8 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.md index 414f5157850..eb3f02a457b 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.31/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -123,7 +123,7 @@ a handle to the instruction that was just added -`RawFeatureVector.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Call the initialize instruction. @@ -139,7 +139,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`RawFeatureVector.bind_parameters(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.bind_parameters(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bind parameters. diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.31/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.31/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.31/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.31/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.md index 56fc97fec81..0773653dca8 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -194,7 +194,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -210,7 +210,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -234,7 +234,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -250,7 +250,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -262,7 +262,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -286,7 +286,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -306,7 +306,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -318,7 +318,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -334,7 +334,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -346,7 +346,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.md index 28c74b79a54..815ea7ecdde 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.31/qiskit.opflow.anti_commutator.md index 3898db790be..85f54d4274f 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.commutator.md b/docs/api/qiskit/0.31/qiskit.opflow.commutator.md index fee5b93b02a..d2172385ff8 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.md index a00d134ed2c..7ef1f6a17ab 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.md index f2d2e759eed..0a26367547b 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.md index e3684e8963c..ff8184df7d4 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.md index 72f672de34f..573cf535bb1 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.md index 325cb11c1d4..a0e53dbd895 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.md index 93a5e86999e..f2e0bf2a7d2 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.31/qiskit.opflow.double_commutator.md index 4bdc73dda07..b683221f214 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.md index bba55129dca..4fa5d784a81 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.md index ae71ca2719c..54addd5040b 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.md index 4e93b0b8f51..0600758b9f7 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.md index 8993a5179ad..a155c64b246 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c8094df0d06..7be00afa27c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.md index 78ae73fad20..acf94d9f7f3 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.md index e846c732386..2f1524def39 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.md index e781c2e76c8..a33d03b8132 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.md index 95c23779df5..ca6f0b7f2ca 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.md index 161563dd794..dd6c75a56ac 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.md index 79cea305c20..b1225040f62 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.md index 5975abbdf52..5e9dfcf4211 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.md index 33966301d47..b5a981655a4 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.md index afcaea6d4a0..3a013bc4cdd 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.md index f6b8202b43d..79427656c9e 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.md index c07db9f3256..c0b89e29978 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.md index d6afd8ebc0b..0d9fc2a38a1 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.md index f375c3475b6..6b3474abd7c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.md index 598fc181127..20bfc03a64d 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.md index 850df331191..0e6796aed84 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.md index 8d79589afe0..75514ddeefd 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.md index 352d43dd268..3b55901f378 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.md index f4ac8a832c8..e81a6901eab 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.md index 11e541cabb8..78c8e24e3e3 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.md index 08944253b50..68b117566d3 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.md index 407fe1b1b01..15e5bb9139f 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.md index 03cc0694b50..2fcddfb0d4e 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.md index 7f1a289097d..2b91bd07914 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.md index 1d21cfa23b8..107a83d4489 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.md index 773dac11de7..a9b207588fd 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.md index 38ff1eda070..2d0c23c165a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.md index 2b3d38ad8d7..462397fa0d4 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.md index a6a95e2a19d..1b5d915c986 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.md index 27e7660a535..f34c50c98a2 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backend by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -183,7 +183,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -205,7 +205,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -249,7 +249,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -265,7 +265,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -286,7 +286,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -310,7 +310,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -322,7 +322,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -338,7 +338,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -350,7 +350,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.md index adc7134555c..82498bf1023 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index e79d5a51100..2cab71b234e 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.md index 7b5e72bf7c5..5d5d896f45c 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -65,7 +65,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -81,7 +81,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -89,7 +89,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.md index e4d35b103db..4f8ca4cb019 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.md index e1dd3b4e91f..0f322c553c8 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.md index 9206389fb7c..d8cf52cf557 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.md index 33a6664f407..94f60abcd8a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.md index 5e032defd82..039a65f1aed 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.md index 315df2f89ad..a61562894fe 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.md index 5e6a01d2378..d8f21000943 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.md index 9372d7fff09..8fe6bc0d377 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.md index bdaf05c904f..0dc04028355 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 3c0ddee770b..52040836598 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.md index 8c263ce4d89..16b8400a0a4 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -36,7 +36,7 @@ Optimization on Classical and Quantum Computers. arXiv preprint arXiv:2001.02069 -`ADMMOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -80,7 +80,7 @@ Returns True if the problem is compatible, False otherwise. -`ADMMOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Tries to solves the given problem using ADMM algorithm. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.md index 023564a13d5..d3f3337be92 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.md index 1ce1e212854..9175824d009 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.md index 49ea17d7f80..284d526dbdf 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -49,7 +49,7 @@ This initializer takes the algorithmic parameters of COBYLA and stores them for -`CobylaOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -112,7 +112,7 @@ The result of the multi start algorithm applied to the problem. -`CobylaOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.md index 56cf574ed45..b07f8629871 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -45,7 +45,7 @@ Initializes the CplexOptimizer. -`CplexOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -87,7 +87,7 @@ Returns True if the problem is compatible, False otherwise. -`static CplexOptimizer.is_cplex_installed()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`static CplexOptimizer.is_cplex_installed()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Returns True if cplex is installed @@ -95,7 +95,7 @@ Returns True if cplex is installed -`CplexOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.md index f8bec039b40..4f2e129b671 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.md index 0d195bd9c3c..65f95718e35 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -34,7 +34,7 @@ Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. -`GroverOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -76,7 +76,7 @@ Returns True if the problem is compatible, False otherwise. -`GroverOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Tries to solves the given problem using the grover optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.md index c3841732628..7172485413c 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index 0c583aca782..9ede7545b9d 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` @@ -32,7 +32,7 @@ Minimum Eigen Optimizer Result. -`MinimumEigenOptimizationResult.get_correlations()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult.get_correlations()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Get \ correlation matrix from samples. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 7b6b8077e7c..54fc420dd2e 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -53,7 +53,7 @@ This initializer takes the minimum eigen solver to be used to approximate the gr -`MinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -95,7 +95,7 @@ Returns True if the problem is compatible, False otherwise. -`MinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.md index 858b2d9f97a..cf70df4393e 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` @@ -69,7 +69,7 @@ Returns True if the problem is compatible, False otherwise. -`MultiStartOptimizer.multi_start_solve(minimize, problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer.multi_start_solve(minimize, problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Applies a multi start method given a local optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 3a5a2cd46a1..a9163ab5585 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for optimization algorithms in Qiskit’s optimization module. -`abstract OptimizationAlgorithm.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -42,7 +42,7 @@ Returns the incompatibility message. If the message is empty no issues were foun -`OptimizationAlgorithm.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -62,7 +62,7 @@ Returns True if the problem is compatible, False otherwise. -`abstract OptimizationAlgorithm.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.md index a6aa4c989d0..014e77d6c41 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.md index 8bf9832d57f..21613d9ecb6 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index 24c7b4a162f..12d0272ee2d 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index b292156eee5..99c4d5f3534 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -64,7 +64,7 @@ This initializer takes a `MinimumEigenOptimizer`, the parameters to specify unti -`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -106,7 +106,7 @@ Returns True if the problem is compatible, False otherwise. -`RecursiveMinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Tries to solve the given problem using the recursive optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 34ca60acc3c..f8cd40fe775 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.md index d6d8d5db9ae..7136c317531 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -62,7 +62,7 @@ This initializer takes the algorithmic parameters of SLSQP and stores them for l -`SlsqpOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -125,7 +125,7 @@ The result of the multi start algorithm applied to the problem. -`SlsqpOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.md index b4da60e7fe8..f494851b386 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.md index e35345c4ba8..3818968c838 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -47,7 +47,7 @@ To chose the type of slack variables. There are 3 options for mode. -`InequalityToEquality.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a problem with inequality constraints into one with only equality constraints. @@ -73,7 +73,7 @@ The converted problem, that contain only equality constraints. -`InequalityToEquality.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a result of a converted problem into that of the original problem. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.md index e4a3c3ccc94..6c224c3b544 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -41,7 +41,7 @@ Annealers. arxiv.org:1706.01945. -`IntegerToBinary.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert an integer problem into a new problem with binary variables. @@ -65,7 +65,7 @@ The converted problem, that contains no integer variables. -`IntegerToBinary.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert back the converted problem (binary variables) to the original (integer variables). diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.md index b71a8baad93..202c4ef38d3 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -26,7 +26,7 @@ Convert a problem with only equality constraints to unconstrained with penalty t -`LinearEqualityToPenalty.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with equality constraints into an unconstrained problem. @@ -50,7 +50,7 @@ The converted problem, that is an unconstrained problem. -`LinearEqualityToPenalty.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert the result of the converted problem back to that of the original problem diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.md index 7eda37a7c99..f2077921bc9 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for converters of quadratic programs in Qiskit’s optimizatio -`abstract QuadraticProgramConverter.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Convert a QuadraticProgram into another form and keep the information required to interpret the result. @@ -34,7 +34,7 @@ Convert a QuadraticProgram into another form and keep the information required t -`abstract QuadraticProgramConverter.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Interpret a result into another form using the information of conversion diff --git a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.md index 630ff285c33..d602667802d 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -37,7 +37,7 @@ Convert a given optimization problem to a new problem that is a QUBO. -`QuadraticProgramToQubo.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a problem with linear equality constraints into new one with a QUBO form. @@ -61,7 +61,7 @@ The problem converted in QUBO format. -`static QuadraticProgramToQubo.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`static QuadraticProgramToQubo.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -83,7 +83,7 @@ A message describing the incompatibility. -`QuadraticProgramToQubo.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a result of a converted problem into that of the original problem. @@ -103,7 +103,7 @@ The result of the original problem. -`QuadraticProgramToQubo.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.md index 6aaa1e61bcd..f07e10ec8f4 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ Initializes the constraint. -`abstract Constraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`abstract Constraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Evaluate left-hand-side of constraint for given values of variables. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.md index b1fa58edc45..8b2d46fded4 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -30,7 +30,7 @@ Representation of a linear constraint. -`LinearConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.md index c4afeea8ae0..e778ec5c833 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The linear expression can be defined via an array, a list, a sparse matrix, or a -`LinearExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the linear expression for given variables. @@ -51,7 +51,7 @@ The value of the linear expression given the variable values. -`LinearExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the gradient of the linear expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient of the linear expression given the variable values. -`LinearExpression.to_array()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_array()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as array. @@ -87,7 +87,7 @@ An array with the coefficients corresponding to the linear expression. -`LinearExpression.to_dict(use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_dict(use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as dictionary, either using variable names or indices as keys. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.md index 880f9867257..1424ae8c13a 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -33,7 +33,7 @@ Constructs a quadratic constraint, consisting of a linear and a quadratic term. -`QuadraticConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.md index 9ec54d30e0e..4b406447014 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The quadratic expression can be defined via an array, a list, a sparse matrix, o -`QuadraticExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the quadratic expression for given variables: x \* Q \* x. @@ -51,7 +51,7 @@ The value of the quadratic expression given the variable values. -`QuadraticExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the gradient of the quadratic expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient quadratic expression given the variable values. -`QuadraticExpression.to_array(symmetric=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_array(symmetric=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as array. @@ -91,7 +91,7 @@ An array with the coefficients corresponding to the quadratic expression. -`QuadraticExpression.to_dict(symmetric=False, use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_dict(symmetric=False, use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as dictionary, either using tuples of variable names or indices as keys. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.md index d572d67bf56..f566abbc987 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -32,7 +32,7 @@ Constructs a quadratic objective function. -`QuadraticObjective.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the quadratic objective for given variable values. @@ -52,7 +52,7 @@ The value of the quadratic objective given the variable values. -`QuadraticObjective.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the gradient of the quadratic objective for given variable values. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.md index 331b06a13ea..58a09ecaa2f 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.md index f819786e881..6a652de761a 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.md index 224ffcab330..dd93ab6a778 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -38,7 +38,7 @@ The variables is exposed by the top-level QuadraticProgram class in QuadraticPro -`Variable.as_tuple()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable.as_tuple()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Returns a tuple corresponding to this variable. diff --git a/docs/api/qiskit/0.31/qiskit.providers.Backend.md b/docs/api/qiskit/0.31/qiskit.providers.Backend.md index 8f8b2617abf..5d43bc5af2e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.31/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.md index 624c3efa4ac..37527a2e10f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.31/qiskit.providers.BackendV1.md index 7982b298902..c1d3b6527a0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.31/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.md index de4e1e24d13..c2724f27642 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.31/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.31/qiskit.providers.BaseJob.md index 84da9924fa4..b915fd12e9f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.md index 5a3be2cefee..2823a2f7486 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.31/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.31/qiskit.providers.Job.md b/docs/api/qiskit/0.31/qiskit.providers.Job.md index 63659a6fffd..f3bbce8abc6 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.31/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobError.md b/docs/api/qiskit/0.31/qiskit.providers.JobError.md index c451db25471..34cdf601cd6 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.31/qiskit.providers.JobStatus.md index 5b2f11fd019..c234d5ec2ff 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.31/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.md index 5cd9186bd93..e190fbd84cd 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.31/qiskit.providers.JobV1.md b/docs/api/qiskit/0.31/qiskit.providers.JobV1.md index 8a10a273119..9e8e5d7ee99 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.31/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.31/qiskit.providers.Options.md b/docs/api/qiskit/0.31/qiskit.providers.Options.md index ac32ae67834..006e6291d63 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.31/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Bases: `types.SimpleNamespace` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.31/qiskit.providers.Provider.md b/docs/api/qiskit/0.31/qiskit.providers.Provider.md index 968e515262f..bfcea8694aa 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.31/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.md index 2b87bbfd5ec..2e5188b77e3 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.md index ed7ccfe563b..5e7acf5c172 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.md index e73f1efd60e..edbb37c6d86 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.md index 26bfd13c4cc..199c977d93a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.md index 45c4620db2a..b95040a3336 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -160,7 +160,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -168,7 +168,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -184,7 +184,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -218,7 +218,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -226,7 +226,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -314,7 +314,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.md index 35c5903ba27..0f6694ec091 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -147,7 +147,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -205,7 +205,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -231,7 +231,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.md index 9bccd150d8c..46d4271a9e9 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -139,7 +139,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -147,7 +147,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -163,7 +163,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -197,7 +197,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -301,7 +301,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.md index e0deb4d929b..216939d1cb4 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -73,7 +73,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -81,7 +81,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -227,7 +227,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.md index fe9fd1e7e12..e2defd25c5a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.md index bd09b928a2b..14911530532 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -107,7 +107,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -115,7 +115,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 79b02f0dd1c..28a05cec894 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 1677292f0f7..5c29d00998b 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 47dcb71f194..92bbd042bff 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.md index b91c0717c6f..cbb222737f5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.md index b82a02aae95..2f3b7dd1c3c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.md index 769df845673..3fa77df13d8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.md index 354de533212..2643ef10f37 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.md index 2f084af6024..14674abb5db 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.md index e20f410d2b8..254595e1e9a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.md index ff1c118b222..306a5e8b853 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.md index e7d38aafa3d..ebe8a598f45 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 30a2d26ecec..ead7a8ab0a8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.md index db64cb57ee9..f4df6a88c6a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.md index 18382603f71..8d742cc756e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.md index 22b425d8341..79cbc45cc27 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.md index 9c77eba94d7..24af3581d0e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.md index b8b38a17639..79aea308a9e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.md index 0d4023041c8..e4394dd1499 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.md index e759602c281..0eeb3724bde 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.md index 0d8ad8e8c82..497ab39b422 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.md index 020d0728ea7..ac08ffe9fc5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.md index 1e490ce4ef7..12a0944942d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.md index 2ba6b03db6e..8c51f05fc21 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.md index b0582a7713b..66007879890 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.md index 79d105c1369..f6d60e6d579 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.md index 22e1e4de639..8ec98e46380 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.md index 35c61148419..cefa258d9de 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes.md index d0fd751daa9..f6f88f92a8a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes_squared.md index c8e82191ee3..9e69b08814e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_density_matrix.md index c292865e173..b7fe6d72ad4 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value.md index afb0aa6b5cd..b5d6c393030 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value_variance.md index cad935698d1..540f5a6fa5c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_matrix_product_state.md index ad9329fb5b6..042515e636f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities.md index 98709e41a00..c74bc7fb192 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities_dict.md index 232f5123a85..1d2c6e7628c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_stabilizer.md index caa96c0dad7..c9bae83161e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_state.md index 5b43901211e..38b617016f0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector.md index 910688c4069..25ff84a6e48 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector_dict.md index 3e042263bd0..af529254e93 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_unitary.md index 3900cf9ef44..d223f5969b0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_density_matrix.md index 62f93bfba5c..04a01d89e8d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_matrix_product_state.md index 07cb9ac48f9..0fe380ec195 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_stabilizer.md index 47ce108bc7f..ca1043a2443 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_statevector.md index caf2c8ae80d..97f9f6e64c8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_superop.md index a71d2be2b79..2de685817f9 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_unitary.md index 318fc9eccab..e6946858c46 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.md index b7e7e1dd885..591edcd2526 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.md index be262c84116..ff22ab5d765 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel other \* self. @@ -85,7 +85,7 @@ The composition error channel. -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -93,7 +93,7 @@ Make a copy of current QuantumError. -`QuantumError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel self \* other. @@ -118,7 +118,7 @@ The composition error channel. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -143,7 +143,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -167,7 +167,7 @@ the tensor product error channel other ⊗ self. -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if current error object is an identity @@ -175,7 +175,7 @@ Return True if current error object is an identity -`QuantumError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the compose of a error channel with itself n times. @@ -199,7 +199,7 @@ the n-times composition error channel. -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -207,7 +207,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -215,7 +215,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -239,7 +239,7 @@ the tensor product error channel self ⊗ other. -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -247,7 +247,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -255,7 +255,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.md index b2ceb8ec9cd..98829a8f1d2 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -81,7 +81,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -89,7 +89,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -114,7 +114,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -138,7 +138,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -146,7 +146,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -170,7 +170,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -178,7 +178,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -186,7 +186,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -210,7 +210,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -218,7 +218,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.amplitude_damping_error.md index 8e9e6295d9e..dd2ff84f6d0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.coherent_unitary_error.md index 75525914a49..84e4b8ec014 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.depolarizing_error.md index 85a1d7c9498..68d139e8b8c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ee7da332025..25ae7882329 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index f364dd25f2d..3b481f5b563 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_error_values.md index 3ae2a2ff174..d0943efa790 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_length_values.md index 1b13b72489b..892fe67f613 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_param_values.md index 918d4b8a054..93fb9036ea3 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.readout_error_values.md index e59808902fb..0fadf024f1e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index 0bacf85f54f..4785b2029bb 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.kraus_error.md index 44ca93fb5ca..90bd27c8bba 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.mixed_unitary_error.md index 3d5c9582a90..111474c892d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.pauli_error.md index 6d368a98133..ccfd737e3c1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index 1e5fd78c8b6..a2f2c78e418 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_damping_error.md index ef2fd39829e..4b71083d507 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.reset_error.md index a254e39f831..63de275e22f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.thermal_relaxation_error.md index 677c791119f..36c3b22a0d8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.md index f80a4e6e134..65f4da8ad16 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.duffing_system_model.md index 24d251b1714..d6036ef8fd1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.md index a79f3f36e95..4e5fc535530 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Transforms one quantum channel to another based on a specified criteria. -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_noise_model.md index 6ac6827b3e9..1ca9fe60950 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_quantum_error.md index cd5acf0deb7..ca9a30e2885 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.insert_noise.md index c9c0300ea59..c29fc6f23ab 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.remap_noise_model.md index 64a6012ca37..8bbffc11ecc 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.31/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.md index 1a9600d9787..274cabb8be7 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.md index 6b901b10024..a1a30ea5642 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.md index dbdc2b1476c..32a5b314e49 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.md index 933a7deb632..2c5d6fe17c3 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.md index dc2fded523b..698c76540f4 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.md index a75d9051fba..14c43d97a79 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.31/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.md index ae611ba7bc5..d8795489f49 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.md index 6edc044a178..1f44f15eae4 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index 9a6e9bfeff6..9992c122970 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index e7e4445260f..29c92c3d809 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 92dc058f6c6..363e8b8bca0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 39d8483248f..98c6cb82e5f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.md index f7f5127f13b..60a8c15f8d1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index ca6a404824c..650b3a728df 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.md index 911100e49b7..f00aabfa163 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -475,7 +475,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.md index a5677ddfd06..e7c091811f0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index c7f6d2ded1e..6c927de251e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.md index 55eed7fa0b1..2cfbba56aaf 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.md index 74ebe3de46d..00cd977f682 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -159,7 +159,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -175,7 +175,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.md index fbd6f44c97b..e7f7d6aab79 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.md index 7a1cdfc4925..bc42cc39e01 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.md index ecc2d3c0dcf..13d3d0da51b 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.md index be7a23f2cd6..0893a1700e9 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.md index 9f405819654..f8251fab897 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.md index d2b349e48fa..61aa5fd0ea7 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.md index 3a09a497f22..3b7c06a0473 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 197799e4182..ddb618237eb 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index f6763823139..b3fdba0d239 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.md index 7a9f7671477..c4978cff3af 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index a25b449b87a..62751e38c25 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index e58cc2adf78..b541a8ba4dd 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.md index d3a2424cc66..f318c44577a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 5afc77dbdca..626ce154c64 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.md index 870b1a9df0b..baa43986497 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.md index 00dc4d172d0..33db869f0cc 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.md index 5e87038328d..a590981a221 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.md index 14ed06896c7..01a01b294ab 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 8743d45e97f..fb06eadde8c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 8003b8870bd..1fdcd94a1ab 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 446fbac4070..b9b97cae176 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.md index 767bcacc566..b15a547fe14 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.job_monitor.md index f8a2f3ac4e3..77514eac98a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.least_busy.md index ec930498db0..e437728f756 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.md index 719ed0b631a..c0715f7c216 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 1a505029f14..8df85fad4b1 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index bc81e1225df..a94dd9b750c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index c575055afdb..431cd724e2e 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index cf60a7ea2a3..f5e86f2d5d6 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index db73ab9de15..323371831fb 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 479e27dd35b..42ccd496ad5 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.md index 5d919ff930d..f4c01f52510 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.md index eae2035397e..cdfa1b2387f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.md index 72b39daa9bf..1ee85904e2a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.md index 864eb24973d..e2a149c1589 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` @@ -49,7 +49,7 @@ BaseRandomService constructor. -`CQCExtractor.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Retrieve a previously submitted job. @@ -69,7 +69,7 @@ A `CQCExtractorJob` instance. -`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Process input data synchronously. @@ -95,7 +95,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the first extractor asynchronously. @@ -122,7 +122,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the second extractor asynchronously. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.md index 5aaa51f8248..ab4e6775727 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ CQCExtractorJob constructor. -`CQCExtractorJob.block_until_ready(timeout=None, wait=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.block_until_ready(timeout=None, wait=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Wait for the job to finish and return the result. @@ -70,7 +70,7 @@ Extractor output. -`CQCExtractorJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Query the server for the latest job status. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.md index a90485183ac..42d4282682b 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ IBMQRandomService constructor. -`IBMQRandomService.get_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.get_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return the random number service with the given name. @@ -60,7 +60,7 @@ Service with the given name. -`IBMQRandomService.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return all random number services available to this account. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index e6fa5753626..2a2fad70625 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -162,7 +162,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -180,7 +180,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -196,7 +196,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -224,7 +224,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -246,7 +246,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -285,7 +285,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -307,7 +307,7 @@ Sets a program’s visibility. -`IBMRuntimeService.upload_program(data, metadata=None, name=None, is_public=False, max_execution_time=None, description=None, version=None, backend_requirements=None, parameters=None, return_values=None, interim_results=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None, name=None, is_public=False, max_execution_time=None, description=None, version=None, backend_requirements=None, parameters=None, return_values=None, interim_results=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.md index a34e4bbcc5c..0477e4e5c20 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(params)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(params)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.md index 3f65280ccc5..13b67ebc735 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.md index 8bfb2089af5..f024d338783 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index 7f0c8dc5f67..193acf075bf 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index 96340bbbbca..0e7fef8681d 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.md index faeba40b139..90ea334e9e6 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.md index a7c072c1a6e..45c2751d81f 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, version='0', backend_requirements=None, creation_date='', is_public=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -75,7 +75,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.md index be6bd44fedf..711a8b85cfa 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.seconds_to_duration.md index 1b081327685..74e03f4d45a 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.to_python_identifier.md index 1f14be1db4f..f756ffd7141 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.update_qobj_config.md index 1ec3e71acb2..e0c46e7e153 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.utc_to_local.md index 8bb5e0ed081..7fe6c8bfef8 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.validate_job_tags.md index 8b55d5775ae..91c67963c15 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.31/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.17/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.md index 1194041a160..a98f84d7d25 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.md index 95a5a196fdd..23cc125a1dc 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Create a new Gate object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.md index 2a77cb0018c..c8310dbaea0 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.Command.md b/docs/api/qiskit/0.31/qiskit.providers.models.Command.md index d59f62fa357..0064c29ba84 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.md index f2567400f56..84751abd71c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.md index fec2e864f50..00e71ba5b63 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.md index 6c8cbdaf67b..2b7d9d81202 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.md index 5b451249c5b..3d849f6b642 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.md index 03a572c07fa..dc79f529a51 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.md index c5e76ea2756..8a7866e606c 100644 --- a/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.31/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.31/qiskit.pulse.Acquire.md index e81c9ad04e6..ddbc145a70a 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.md index c0c426ea242..29f34ba6a0f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Call.md b/docs/api/qiskit/0.31/qiskit.pulse.Call.md index 7799d85e74d..5984caf0764 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Constant.md b/docs/api/qiskit/0.31/qiskit.pulse.Constant.md index 4d938607047..02184ee1aa7 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.md index b4dba6f160f..2b778a25c38 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Delay.md b/docs/api/qiskit/0.31/qiskit.pulse.Delay.md index 5b1c53a52df..a14b028f5ee 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Drag.md b/docs/api/qiskit/0.31/qiskit.pulse.Drag.md index 43b41cc3adb..c88bb9a600e 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.md index e76436c993a..195322c688f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.md index e702d836cdd..41a84546aec 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.md index 7f8a3a3f7fd..f3631d07c9b 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.31/qiskit.pulse.Instruction.md index ed76521b1e2..f15a0f63b7c 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.md index 1151ecd4dfb..ffd9fd4586f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -170,7 +170,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -192,7 +192,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -216,7 +216,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.md index 37f7f62aa03..01fcf813f1a 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.md index 9ac277595cf..63bf5b6d97b 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Play.md b/docs/api/qiskit/0.31/qiskit.pulse.Play.md index da5ab8a6b88..74c3dc0b374 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.31/qiskit.pulse.PulseError.md index 4a3cdeb7c7e..2bcf25644bf 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.md index 09a49766530..42277f2ac23 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.31/qiskit.pulse.Schedule.md index 26facb29dff..bdfb1e94a0f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -239,7 +239,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -264,7 +264,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -287,7 +287,7 @@ If no arguments are provided, `self` is returned. -`Schedule.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Deprecated. @@ -299,7 +299,7 @@ Deprecated. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -321,7 +321,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -346,7 +346,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -365,7 +365,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -377,7 +377,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -438,7 +438,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.md index 6be4597cd35..4ea0dfc1225 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -126,7 +126,7 @@ Return the time of the end of the last instruction over the supplied channels. -`ScheduleBlock.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -142,7 +142,7 @@ Return the time of the start of the first instruction over the supplied channels -`ScheduleBlock.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -232,7 +232,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -265,7 +265,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -296,7 +296,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -318,7 +318,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -343,7 +343,7 @@ New block object with name and metadata. -`ScheduleBlock.insert(start_time, block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.insert(start_time, block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. @@ -366,7 +366,7 @@ This method will be removed. Temporarily added for backward compatibility. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -378,7 +378,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -390,7 +390,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -412,7 +412,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.shift(time, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.shift(time, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.md index 70e4017f765..bdcaecf284d 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.md index 62054c398c0..31416321d95 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.md index ccb0461c3b8..e2b5095ff9f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.md index b212bcf03ae..4303c5627fa 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.md index 0b35a9e071b..2978a2245eb 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.31/qiskit.pulse.Waveform.md index 64ae0355b64..4f36364a78e 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire.md index 7fb6b0c1c63..958170cf301 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire_channel.md index 98b8ed75896..484673363ea 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.active_backend.md index 29546869ebf..ca6fd922e1f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 4e74842ec4f..16cbc35b5f1 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.active_transpiler_settings.md index f3a15baa159..32640b97eb2 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_equispaced.md index 3ae23147338..123d850d213 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_func.md index 54ab38e6d1e..164b0c2a99b 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_left.md index cbbb71aac73..fd6505616a3 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_right.md index 572951819b6..fb6aa7e45cd 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_sequential.md index 0b1585565a3..8b9a24f84a2 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.barrier.md index 339e1e01b0a..31e64cd6d59 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.build.md index 6e9fef84af6..027f1148f27 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.call.md index d69592c6a61..582dcc9cd79 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.circuit_scheduler_settings.md index 657d3302d88..a65c3624e7e 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.control_channels.md index 762939f242c..160ab43c52c 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.cx.md index 7e02b9e1bb7..95a269bec64 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.delay.md index 4f71e962d27..55ee9d104ff 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.delay_qubits.md index b0f847d24e3..70add771a15 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.drive_channel.md index ff0cf2a08e9..82422de0315 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.frequency_offset.md index e1a747dba9a..f62b75817fd 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.inline.md index 5f57428166d..5b9fedec7e9 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.measure.md index cc5ba4115b9..3b9a30910cc 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_all.md index 51e42b44561..8c11a4ce0f4 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_channel.md index 81f11f99879..b8b3e622524 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.num_qubits.md index 676d2ed6d40..701276b045b 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.pad.md index 43e967fc609..90f31cddfdd 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.phase_offset.md index 62ba68346f5..2498e5ac893 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.play.md index 18c6de4b90e..a7900788790 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.qubit_channels.md index e486dbe087d..efe1fe37156 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.samples_to_seconds.md index b6d7fcda54f..dd76abd524f 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.seconds_to_samples.md index d93f52c4470..79d53f9ed18 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.set_frequency.md index d85f6e4ca0e..5808cfa6cc8 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.set_phase.md index b41660ee5ad..07b01f8d5e1 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_frequency.md index 2544b9eb704..9d4a11f08d6 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_phase.md index 94e436785ef..2451e512b45 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.snapshot.md index e983009dc0b..5a5c3597646 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.transpiler_settings.md index f5fbba68e32..d55a51109be 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.u1.md index 9941efd5892..0372cd49e83 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.u2.md index 593b6b26057..1106180b726 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.u3.md index ec7e467dae9..a78e299a90d 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.31/qiskit.pulse.builder.x.md index 0a4e7cc7f76..db5b0046e3d 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.md index b4d3e2cd393..fd9686e9043 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.md index 81e6a62715f..44f6c9375c0 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.md index b454559b818..2cf252fac58 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.md index 2669c0e7e33..a0d16875406 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.md index 867a3a2f0f2..df5d8545751 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.md index 145fda8c30a..a9528d66c33 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.md index 9cb4acecad2..1ebcfb1a11c 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.md index 23fc954ed82..207efa106f7 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.md index da52194db0e..48495887d05 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.md index 6a8c84c04ea..413eaa320e4 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.md index b6a1742d533..847bbb1d5b7 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.md index 0f819369aff..d54ee604c97 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.md index 8a9a5b4afca..0a37c624210 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.md index 0b10fefe392..806fe3393d7 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.md index 73fb571e07c..3c3f56c74b7 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.31/qiskit.pulse.transforms.add_implicit_acquires.md index 4a6619928c2..0980cb98d6b 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.31/qiskit.pulse.transforms.align_measures.md index 912fbe3c1d7..e455aa7afbd 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.31/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.31/qiskit.pulse.transforms.pad.md index 4fde0d29b1f..708fb7dea2c 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.md index 568692c6cec..cd7cbe99aa4 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.31/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.31/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.31/qiskit.qasm.Qasm.md index 5811942acdb..e252baff09b 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.31/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.31/qiskit.qasm.QasmError.md index 0953fcef5e4..baf3c16ec44 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.31/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.md index 8577ea17145..d6604047c6b 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.31/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.md index 4bb241a51f1..996e8f90c48 100644 --- a/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.31/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.md index dc6807f4f47..cb9c76c431b 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.md index 250da02a36c..e539df275f8 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.md index f32e162938b..61bd5da66dc 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.md index 23de14f2b58..13310686dd6 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.md index 946eb56277f..6108c37bf58 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.md index a102b65db76..26905407c4f 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.md index 09e4e8cf6b6..02a106e69be 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.md index 93e83cf8204..792aafbd46a 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.md index 229e0c25a80..0efb9250ec6 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.md index 68efc15b60a..8f1af92cd29 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.md index 1ac3a0d1412..8a9ab6d04c8 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.md index 169ff7f0edd..2f540e16e76 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.md index 2a8827e0025..b652e1c615b 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.31/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.31/qiskit.qobj.Qobj.md index 48fab3cc3e7..d5931646cfe 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.md index dfdb814e30a..4356b458ef9 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.md index 0683e853895..ce821f49651 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.md index 8d2804fa7cf..113a5434563 100644 --- a/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.31/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.md index ebff470a33f..dd0721a2889 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.md index ccf832fe311..4b2db827eaa 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.md index 7ec4ff27c21..53f3ad6cff6 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.md index e69135ac64a..c054c07c1fa 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.md index 45eb39aec8e..60a67bb15d1 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.md index a59d2279a15..bab4107eda2 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.md index d746922fe44..be43b8e566a 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.md index 174a69f047a..fd55e4f045a 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -207,7 +207,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -223,7 +223,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -273,7 +273,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -291,7 +291,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -317,7 +317,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -325,7 +325,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -333,7 +333,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.md index d14a8785d50..9b762b76754 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.md index b8d396e287b..056331534c7 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -344,7 +344,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -366,7 +366,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -401,7 +401,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -426,7 +426,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -460,7 +460,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -468,7 +468,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -500,7 +500,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -546,7 +546,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -595,7 +595,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -611,7 +611,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -636,7 +636,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -662,7 +662,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -670,7 +670,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -690,7 +690,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -710,7 +710,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -728,7 +728,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -736,7 +736,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -763,7 +763,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.md index 31f640a8eac..3c427fb83cf 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -372,7 +372,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -396,7 +396,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -426,7 +426,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -454,7 +454,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -462,7 +462,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -480,7 +480,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -560,7 +560,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -623,7 +623,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -647,7 +647,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -676,7 +676,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -706,7 +706,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -714,7 +714,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.md index c315c51d743..0d55e873ae3 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.md index ebd5cb973c2..4a188ed873b 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.md index 4580365d9cc..aea5d2c2f59 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.md index b72250d6dc1..e475b2c7eac 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -39,7 +39,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -47,7 +47,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -79,7 +79,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -138,7 +138,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list \[(pauli\_str, coeffs)] @@ -146,7 +146,7 @@ Construct from a list \[(pauli\_str, coeffs)] -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -182,7 +182,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -203,7 +203,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -221,7 +221,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -301,7 +301,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliTable by combining duplicates and removing zeros. @@ -322,7 +322,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -348,7 +348,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -370,7 +370,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -390,7 +390,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -398,7 +398,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.md index 845a37a909b..f4afb057545 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of an operator. @@ -154,7 +154,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -162,7 +162,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -186,7 +186,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -209,7 +209,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -234,7 +234,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -254,7 +254,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -305,7 +305,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -340,7 +340,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -364,7 +364,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -372,7 +372,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.md index c27a8047184..b73e22e607e 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.md index d41ce984ff1..a4222278812 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -103,7 +103,7 @@ Return a visualization of the Statevector. -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -129,7 +129,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -154,7 +154,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -178,7 +178,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -199,7 +199,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -225,7 +225,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -253,7 +253,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -286,7 +286,7 @@ The N-qubit basis state density matrix. -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -318,7 +318,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -416,7 +416,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -424,7 +424,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -448,7 +448,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -528,7 +528,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -552,7 +552,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -623,7 +623,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -631,7 +631,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.md index 6b75108f76f..65db3087e12 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.md index c3a7de9df50..2f806ef834b 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 033460fc1ea..8011ed5e7e9 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.31/qiskit.quantum_info.average_gate_fidelity.md index 7fb9a34233e..1b5652e7c30 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.31/qiskit.quantum_info.concurrence.md index c78b08178f3..687f9ae3338 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.31/qiskit.quantum_info.decompose_clifford.md index 6ca92850231..7d7e125d7df 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.31/qiskit.quantum_info.diamond_norm.md index 86f41fd7f25..a21fca61eb8 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.31/qiskit.quantum_info.entanglement_of_formation.md index ba0a5cf5d39..474efe05fef 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.31/qiskit.quantum_info.entropy.md index 972b7960c19..75988e6cee9 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.31/qiskit.quantum_info.gate_error.md index 2e21141eb7e..d0cc1eb2da5 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_distance.md index adfb9615a12..1efd2679b14 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_fidelity.md index 9b429348da9..ffe425b1e86 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.31/qiskit.quantum_info.mutual_information.md index e4a660de27e..255470a0614 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.31/qiskit.quantum_info.partial_trace.md index fcab650edfc..c35c456a54e 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_basis.md index 1013541d50e..67e47327c8d 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_group.md index 4e5d94cc6fe..f7f574ad41f 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.31/qiskit.quantum_info.process_fidelity.md index 54dc69af792..0fe2d78fe1c 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.31/qiskit.quantum_info.purity.md index 2508d906b61..dfe63a28948 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_clifford.md index e397857937f..ebc9b143eca 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_cnotdihedral.md index 78482875122..7bf929ca519 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_density_matrix.md index 712a7a1eb2c..53f6e8e95a0 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_hermitian.md index 7822a9824b8..3a7c0fe6d7a 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli.md index bd5ff2607f8..1a1172b860f 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli_table.md index 137ca4d950e..6eafed31d9d 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_quantum_channel.md index 22449571abe..c74cf52ae83 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_stabilizer_table.md index 7b50b105331..3e9133f893d 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_statevector.md index ffd24a93345..c11755caa79 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.31/qiskit.quantum_info.random_unitary.md index fbfab7f787f..8ebc0cd56d2 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.31/qiskit.quantum_info.shannon_entropy.md index 3cffae817a1..d1f3ed5ceb7 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.31/qiskit.quantum_info.state_fidelity.md index a17bb1a7eeb..219305ec9d7 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.31/qiskit.result.Counts.md b/docs/api/qiskit/0.31/qiskit.result.Counts.md index 3e0c1b28c27..b0836bc1dac 100644 --- a/docs/api/qiskit/0.31/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.31/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return the most frequent count diff --git a/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.md index 652a93c0df8..badfda93833 100644 --- a/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.md index a3df439e777..2a008309699 100644 --- a/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.31/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -121,7 +121,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.31/qiskit.result.Result.md b/docs/api/qiskit/0.31/qiskit.result.Result.md index 1d5d04a9af8..dfea27ddcd8 100644 --- a/docs/api/qiskit/0.31/qiskit.result.Result.md +++ b/docs/api/qiskit/0.31/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.31/qiskit.result.ResultError.md b/docs/api/qiskit/0.31/qiskit.result.ResultError.md index 9636b827e5e..651b0b3a115 100644 --- a/docs/api/qiskit/0.31/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.31/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.31/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.31/qiskit.result.marginal_counts.md index 984ec18e675..4fbf937bd99 100644 --- a/docs/api/qiskit/0.31/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.31/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.md index d95b631d265..e3691a3a0d8 100644 --- a/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.31/qiskit.tools.backend_monitor.md index 900dae82e23..8917e8199fd 100644 --- a/docs/api/qiskit/0.31/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.31/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.31/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.31/qiskit.tools.backend_overview.md index 957fb280a60..f988ef320c1 100644 --- a/docs/api/qiskit/0.31/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.31/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.31/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.31/qiskit.tools.job_monitor.md index 3d16ebac30c..92e57bda169 100644 --- a/docs/api/qiskit/0.31/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.31/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.31/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.31/qiskit.tools.parallel_map.md index 07db725f8f3..f232ba2823a 100644 --- a/docs/api/qiskit/0.31/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.31/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.md index 5567193156c..9509698d52a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.md index 2ce2dfac706..8f25b090032 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -80,7 +80,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -102,7 +102,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -110,7 +110,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return qubits connected on a grid of num\_rows x num\_columns. @@ -118,7 +118,7 @@ Return qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -126,7 +126,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -134,7 +134,7 @@ Return a fully connected coupling map on n qubits. -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -150,7 +150,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -160,7 +160,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -168,7 +168,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -176,7 +176,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -186,7 +186,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -210,7 +210,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -235,7 +235,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -243,7 +243,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.md index 2911a55d282..a470e79302b 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.md index b19b52b8d4b..00e28c66d3c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.md index c66a5aa118b..ab556eb695e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.md index f535bb13e7b..92846548d61 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name and the qubits. @@ -74,7 +74,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -90,7 +90,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.31/qiskit.transpiler.Layout.md index fd318dce9c7..5779fc5efcd 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.md index d60d3062ea4..cb1d29a7a49 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.md index 7a34b30ea18..873ce1041ac 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.md index 940178feedb..de3f9b579ed 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.md index 58f37fcce1f..0be91a42cf2 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.md index 6187572348c..96db165c737 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.md index 04921d4f0c9..f58225cdf00 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.md index 5834bbcf5ba..5593d2d9b55 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.md index bf869cf5632..3583d27a24b 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.md index fdea1c26f1a..6f3047aa15a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.md index 8dbbf1adade..c2205e3f5d4 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.md index 3148d827221..9806713ab21 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -72,7 +72,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 868cc99c318..43482e25d9e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.md index 90564fc4170..dfa0268fc81 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.md index 6d963211a62..86445d2fde4 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.md index 80c02cf7d65..e8f366aba3a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.md index 6f04b9e6248..845de2e0172 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.md index b525f3316e5..fea10b8596e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.md index c71de599680..b02406f2a5c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.md index 6a17860c54c..c3429160e40 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.md index 810eaa83cc7..3f997e25f37 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.md index 032e151ddc1..4613199f5dd 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.md index 744736cbc13..62187c78316 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.md index a72caa5131d..46a35082205 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.md index 51bec98a443..c16e9ab7a7b 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.md index 02a07d088d0..2debc209680 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.md index 4f9431bb37b..1353af5be91 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index b32c79c6cc3..a34f76b8aea 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.md index 997db28662b..f755a0f2838 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.md index 4ecd9af788b..b1631964fc6 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.md index 4821800c0d5..025e85f28f4 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.md index 718d92615bc..a7b067d0923 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.md index 9c0c24fee12..062c118d97e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.md index 43a1685a29b..69159174390 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.md index 72a4c9337b5..43705a6217c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.md index 58f845efea2..991d31b3594 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.md index 75443220b25..695c133ed97 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.md index bd591642853..a68660bd460 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -52,7 +52,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.md index 526e67b3172..2de48decfaf 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.md index 3b941efdc17..8f08841bdd8 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.md index c5ef7c51fe2..290a38a2ea6 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 18b39f6de80..79baa69b039 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.md index bfb88eaa73f..a0e9be18885 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.md index a43c925315a..4c3e10a227e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 9f025335f64..deb8bd3bc0e 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 247952bd2a6..f4185c64073 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` @@ -32,7 +32,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -63,7 +63,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -109,7 +109,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.supported(node_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index d1e35d9d7f8..0dbf71a687f 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.md index e80b597cd86..761812a77ff 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index ea691cfcdcc..ebb876ce4cf 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.md index bd287fcc787..cd167884a17 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.md index d92c6ed6a1a..1a34098a35f 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.md index 43a1246b882..4ea822d5049 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.md index 24b02cd5d37..1ec7028a48f 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.md index 310f7e38d21..07d7ccb91d0 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.md index 088beac9622..46e6c9c2f34 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.md index e3518c917f1..07a891b44c3 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.md index e9a9ae62a6e..6653a09acf6 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.md index 44a16cd9703..131fb3ef24a 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.md index c6dc911389c..963a68b4426 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.md index b72a56d66a9..d4ea3debc8f 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.md index d55722e6613..1c3cf957287 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 691671212e0..7dd2a3d0438 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.md index c02d018eb79..86621524a00 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.md index a5078bb49fa..e33af21c9ea 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.md index f7e21cd7667..e5e1dddb35c 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index ce49450400a..e56210238e8 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 893991f1e1e..5fa14dacdf7 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 2a48a316b60..ad034c98bdb 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 67a6d205867..241fe8b08a2 100644 --- a/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.31/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.md index 328d57f775f..b36be637246 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.31/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -65,7 +65,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -85,7 +85,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -116,7 +116,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -136,7 +136,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -148,7 +148,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -156,7 +156,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :param circuits: circuits to transpile :type circuits: Union\[‘QuantumCircuit’, List\[‘QuantumCircuit’]] diff --git a/docs/api/qiskit/0.31/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.31/qiskit.utils.apply_prefix.md index 2017d1c6643..a28b67fdb37 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.31/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.31/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.31/qiskit.utils.deprecate_arguments.md index 8282d5f19c9..a828755849a 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.31/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.31/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.31/qiskit.utils.deprecate_function.md index 2b87a5fcc00..4f63f06df1f 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.31/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.31/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.31/qiskit.utils.get_entangler_map.md index 6cf74ea4af2..236fae021fb 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.31/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.31/qiskit.utils.has_aer.md b/docs/api/qiskit/0.31/qiskit.utils.has_aer.md index 189bf9bfc23..102a23afe92 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.31/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.31/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.31/qiskit.utils.has_ibmq.md index 60361543541..be11ff87ff7 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.31/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.31/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.31/qiskit.utils.is_main_process.md index fa2d188fc3a..0ea19e37f4f 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.31/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.31/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.31/qiskit.utils.local_hardware_info.md index 830ffd2cddc..3844e400dc4 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.31/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.31/qiskit.utils.name_args.md b/docs/api/qiskit/0.31/qiskit.utils.name_args.md index eaa2979d4a7..1b871d1ee39 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.31/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.31/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.31/qiskit.utils.summarize_circuits.md index a0271e0a592..80bf315381d 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.31/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.31/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.31/qiskit.utils.validate_entangler_map.md index 2b216c7bc49..88c3e19f384 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.31/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.md index c6da2a2e904..5bfb9a42a70 100644 --- a/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.31/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.31/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.31/qiskit.validation.jsonschema.validate_json_against_schema.md index 2a574f25167..0b6d588facc 100644 --- a/docs/api/qiskit/0.31/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.31/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.md index 019d0e86d97..cbd4a33b528 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.31/qiskit.visualization.array_to_latex.md index 6be62f03dfb..6168a0bbc64 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.31/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.31/qiskit.visualization.circuit_drawer.md index 1d91a2d70e7..164489581c5 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.31/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.31/qiskit.visualization.dag_drawer.md index 489eea8e42b..2f1d8c1fe25 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.31/qiskit.visualization.pass_manager_drawer.md index df1f70d2634..06fff318385 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_multivector.md index 5ac89138126..2d6c0243a3d 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_vector.md index a0ee6dde213..deb76f4b42a 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_circuit_layout.md index ca0d0366a4e..e609f228e4f 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_error_map.md index 5c0b59cbe2e..55d45774eed 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_gate_map.md index 4f173902406..3abefa7a5d3 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_histogram.md index c18c0f95a32..4fbc33e59f1 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_city.md index c26436804e8..8ab028e343b 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_hinton.md index b398dcd6d43..d20de5803fe 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_paulivec.md index 2314877db04..7027c284f54 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_qsphere.md index 6ece0a2ad00..8117cdf58ed 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.md index e2d818293eb..8c96b29e9d7 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.md index 53ecd61a0b0..deb943eb89c 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.md index 808cab2e4eb..463ec5974fd 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.draw.md index d573405bfbd..4659f13d034 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.md index ebc50613fb6..e29877e00b4 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.31/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.31/qiskit.visualization.timeline.draw.md index 958bb4a8703..0c6c2ed1ff5 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.31/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.31/qiskit.visualization.visualize_transition.md index f799d8cd91f..bdd0cdda636 100644 --- a/docs/api/qiskit/0.31/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.31/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 992a3faed58106f1b2f1b73a04fb7984ce28b396 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:33:58 +0100 Subject: [PATCH 13/41] Regenerate qiskit 0.32.1 --- docs/api/qiskit/0.32/execute.md | 2 +- docs/api/qiskit/0.32/logging.md | 2 +- .../0.32/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.32/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.32/qiskit.algorithms.Grover.md | 8 +- .../0.32/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.32/qiskit.algorithms.HHL.md | 6 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- .../0.32/qiskit.algorithms.LinearSolver.md | 4 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.algorithms.NumPyLinearSolver.md | 4 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.32/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.32/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.32/qiskit.algorithms.Shor.md | 8 +- .../0.32/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.32/qiskit.algorithms.VQE.md | 20 +- .../0.32/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.32/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.32/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.32/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.32/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.32/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 6 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.32/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.32/qiskit.algorithms.optimizers.SPSA.md | 10 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- .../0.32/qiskit.algorithms.optimizers.TNC.md | 2 +- docs/api/qiskit/0.32/qiskit.aqua.AquaError.md | 2 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 2 +- .../0.32/qiskit.aqua.QuantumInstance.md | 16 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 6 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 4 +- ...ua.algorithms.AmplitudeEstimationResult.md | 4 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 4 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 4 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 2 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 4 +- .../qiskit/0.32/qiskit.aqua.algorithms.EOH.md | 4 +- .../qiskit.aqua.algorithms.Eigensolver.md | 6 +- ...iskit.aqua.algorithms.EigensolverResult.md | 4 +- .../0.32/qiskit.aqua.algorithms.Grover.md | 10 +- .../qiskit.aqua.algorithms.GroverResult.md | 4 +- .../qiskit/0.32/qiskit.aqua.algorithms.HHL.md | 10 +- .../0.32/qiskit.aqua.algorithms.HHLResult.md | 4 +- .../0.32/qiskit.aqua.algorithms.IQPE.md | 6 +- ...algorithms.IterativeAmplitudeEstimation.md | 4 +- ...thms.IterativeAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.LinearsolverResult.md | 4 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 6 +- ...imumLikelihoodAmplitudeEstimationResult.md | 4 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 6 +- ...qua.algorithms.MinimumEigensolverResult.md | 4 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 2 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 4 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.32/qiskit.aqua.algorithms.QAOA.md | 2 +- .../0.32/qiskit.aqua.algorithms.QGAN.md | 10 +- .../qiskit/0.32/qiskit.aqua.algorithms.QPE.md | 6 +- .../0.32/qiskit.aqua.algorithms.QSVM.md | 24 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 6 +- .../0.32/qiskit.aqua.algorithms.Shor.md | 6 +- .../0.32/qiskit.aqua.algorithms.Simon.md | 4 +- .../0.32/qiskit.aqua.algorithms.SklearnSVM.md | 12 +- .../qiskit/0.32/qiskit.aqua.algorithms.VQC.md | 24 +- .../qiskit/0.32/qiskit.aqua.algorithms.VQE.md | 18 +- .../qiskit/0.32/qiskit.aqua.circuits.CNF.md | 4 +- .../qiskit/0.32/qiskit.aqua.circuits.DNF.md | 4 +- .../qiskit/0.32/qiskit.aqua.circuits.ESOP.md | 4 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 4 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 4 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 10 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 10 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 8 +- ...aqua.components.feature_maps.FeatureMap.md | 8 +- ...omponents.feature_maps.RawFeatureVector.md | 4 +- ...t.aqua.components.initial_states.Custom.md | 4 +- ....components.initial_states.InitialState.md | 4 +- ....components.initial_states.VarFormBased.md | 4 +- ...kit.aqua.components.initial_states.Zero.md | 4 +- ...mponents.multiclass_extensions.AllPairs.md | 8 +- ...lticlass_extensions.ErrorCorrectingCode.md | 8 +- ...lticlass_extensions.MulticlassExtension.md | 10 +- ...ts.multiclass_extensions.OneAgainstRest.md | 8 +- ...s.neural_networks.DiscriminativeNetwork.md | 12 +- ...nents.neural_networks.GenerativeNetwork.md | 12 +- ...ents.neural_networks.NumPyDiscriminator.md | 14 +- ...ts.neural_networks.PyTorchDiscriminator.md | 16 +- ...onents.neural_networks.QuantumGenerator.md | 14 +- .../qiskit.aqua.components.optimizers.ADAM.md | 12 +- .../qiskit.aqua.components.optimizers.AQGD.md | 6 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 6 +- .../qiskit.aqua.components.optimizers.CG.md | 6 +- ...iskit.aqua.components.optimizers.COBYLA.md | 6 +- .../qiskit.aqua.components.optimizers.CRS.md | 4 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 4 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 4 +- .../qiskit.aqua.components.optimizers.ESCH.md | 4 +- .../qiskit.aqua.components.optimizers.GSLS.md | 14 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 6 +- ...qiskit.aqua.components.optimizers.ISRES.md | 4 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 6 +- ....aqua.components.optimizers.NELDER_MEAD.md | 6 +- .../qiskit.aqua.components.optimizers.NFT.md | 6 +- ...it.aqua.components.optimizers.Optimizer.md | 16 +- ...onents.optimizers.OptimizerSupportLevel.md | 2 +- ...iskit.aqua.components.optimizers.POWELL.md | 6 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 6 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 6 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 6 +- .../qiskit.aqua.components.optimizers.SPSA.md | 6 +- .../qiskit.aqua.components.optimizers.TNC.md | 6 +- ....components.oracles.CustomCircuitOracle.md | 4 +- ...ponents.oracles.LogicalExpressionOracle.md | 6 +- .../qiskit.aqua.components.oracles.Oracle.md | 4 +- ...qua.components.oracles.TruthTableOracle.md | 6 +- ...qua.components.reciprocals.LongDivision.md | 6 +- ...a.components.reciprocals.LookupRotation.md | 6 +- ....aqua.components.reciprocals.Reciprocal.md | 6 +- ...ncertainty_models.BernoulliDistribution.md | 2 +- ...ls.GaussianConditionalIndependenceModel.md | 4 +- ...ncertainty_models.LogNormalDistribution.md | 2 +- ...rtainty_models.MultivariateDistribution.md | 6 +- ...odels.MultivariateLogNormalDistribution.md | 2 +- ...y_models.MultivariateNormalDistribution.md | 2 +- ..._models.MultivariateUniformDistribution.md | 4 +- ...els.MultivariateVariationalDistribution.md | 6 +- ...s.uncertainty_models.NormalDistribution.md | 2 +- ...nts.uncertainty_models.UncertaintyModel.md | 4 +- ....uncertainty_models.UniformDistribution.md | 8 +- ...certainty_models.UnivariateDistribution.md | 6 +- ...odels.UnivariateVariationalDistribution.md | 6 +- ...ncertainty_problems.MultivariateProblem.md | 8 +- ...uncertainty_problems.UncertaintyProblem.md | 4 +- ...lems.UnivariatePiecewiseLinearObjective.md | 8 +- ....uncertainty_problems.UnivariateProblem.md | 8 +- ...nents.variational_forms.VariationalForm.md | 8 +- .../qiskit.aqua.operators.OperatorBase.md | 36 +-- ...qua.operators.converters.AbelianGrouper.md | 6 +- ...qua.operators.converters.CircuitSampler.md | 8 +- ...aqua.operators.converters.ConverterBase.md | 4 +- ...a.operators.converters.DictToCircuitSum.md | 4 +- ...a.operators.converters.PauliBasisChange.md | 22 +- ...aqua.operators.evolutions.EvolutionBase.md | 4 +- ...a.operators.evolutions.EvolutionFactory.md | 4 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 30 +-- ...ua.operators.evolutions.MatrixEvolution.md | 4 +- ...rators.evolutions.PauliTrotterEvolution.md | 8 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 4 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 4 +- ...iskit.aqua.operators.evolutions.Trotter.md | 2 +- ...operators.evolutions.TrotterizationBase.md | 4 +- ...rators.evolutions.TrotterizationFactory.md | 4 +- ...rators.expectations.AerPauliExpectation.md | 6 +- ....operators.expectations.CVaRExpectation.md | 6 +- ....operators.expectations.ExpectationBase.md | 6 +- ...erators.expectations.ExpectationFactory.md | 4 +- ...perators.expectations.MatrixExpectation.md | 6 +- ...operators.expectations.PauliExpectation.md | 6 +- ...qua.operators.gradients.CircuitGradient.md | 4 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 4 +- ...aqua.operators.gradients.DerivativeBase.md | 8 +- ...iskit.aqua.operators.gradients.Gradient.md | 6 +- ...t.aqua.operators.gradients.GradientBase.md | 2 +- ...qiskit.aqua.operators.gradients.Hessian.md | 6 +- ...it.aqua.operators.gradients.HessianBase.md | 2 +- ...qua.operators.gradients.NaturalGradient.md | 4 +- .../qiskit.aqua.operators.gradients.QFI.md | 4 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 2 +- ...qua.operators.legacy.LegacyBaseOperator.md | 16 +- ...it.aqua.operators.legacy.MatrixOperator.md | 24 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 2 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 10 +- ....operators.legacy.WeightedPauliOperator.md | 50 ++--- ...skit.aqua.operators.legacy.Z2Symmetries.md | 14 +- ...ua.operators.legacy.check_commutativity.md | 2 +- ...qiskit.aqua.operators.legacy.commutator.md | 2 +- ...qiskit.aqua.operators.legacy.covariance.md | 2 +- ....operators.legacy.evolution_instruction.md | 2 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 2 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 2 +- ...aqua.operators.legacy.pauli_measurement.md | 2 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 2 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 2 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 14 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 46 ++-- ...qiskit.aqua.operators.list_ops.SummedOp.md | 18 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 10 +- ....aqua.operators.primitive_ops.CircuitOp.md | 30 +-- ...t.aqua.operators.primitive_ops.MatrixOp.md | 28 +-- ...it.aqua.operators.primitive_ops.PauliOp.md | 34 +-- ...qua.operators.primitive_ops.PrimitiveOp.md | 46 ++-- ...qua.operators.state_fns.CVaRMeasurement.md | 30 +-- ...aqua.operators.state_fns.CircuitStateFn.md | 36 +-- ...it.aqua.operators.state_fns.DictStateFn.md | 24 +- ...qua.operators.state_fns.OperatorStateFn.md | 24 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 40 ++-- ....aqua.operators.state_fns.VectorStateFn.md | 26 +-- .../0.32/qiskit.aqua.utils.CircuitFactory.md | 26 +-- .../qiskit.aqua.utils.decimal_to_binary.md | 2 +- .../qiskit.aqua.utils.get_entangler_map.md | 2 +- ...qiskit.aqua.utils.get_feature_dimension.md | 2 +- .../0.32/qiskit.aqua.utils.get_num_classes.md | 2 +- ...aqua.utils.get_subsystem_density_matrix.md | 2 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 2 +- .../qiskit/0.32/qiskit.aqua.utils.has_aer.md | 2 +- .../qiskit/0.32/qiskit.aqua.utils.has_ibmq.md | 2 +- ...skit.aqua.utils.map_label_to_class_name.md | 2 +- .../0.32/qiskit.aqua.utils.name_args.md | 2 +- .../0.32/qiskit.aqua.utils.optimize_svm.md | 2 +- .../0.32/qiskit.aqua.utils.random_h1_body.md | 2 +- .../0.32/qiskit.aqua.utils.random_h2_body.md | 2 +- .../qiskit.aqua.utils.random_hermitian.md | 2 +- .../qiskit.aqua.utils.random_non_hermitian.md | 2 +- .../0.32/qiskit.aqua.utils.random_unitary.md | 2 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 2 +- ....utils.split_dataset_to_data_and_labels.md | 2 +- .../qiskit.aqua.utils.summarize_circuits.md | 2 +- .../0.32/qiskit.aqua.utils.tensorproduct.md | 2 +- ...iskit.aqua.utils.validate_entangler_map.md | 2 +- .../qiskit/0.32/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.32/qiskit.assembler.disassemble.md | 2 +- .../0.32/qiskit.chemistry.BosonicOperator.md | 8 +- .../qiskit.chemistry.FermionicOperator.md | 18 +- .../qiskit/0.32/qiskit.chemistry.MP2Info.md | 6 +- .../qiskit/0.32/qiskit.chemistry.QMolecule.md | 24 +- .../qiskit.chemistry.QiskitChemistryError.md | 2 +- .../qiskit.chemistry.WatsonHamiltonian.md | 2 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 6 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 4 +- ...chemistry.algorithms.EigensolverFactory.md | 4 +- ...try.algorithms.ExcitedStatesEigensolver.md | 4 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 4 +- ...istry.algorithms.GroundStateEigensolver.md | 8 +- ....chemistry.algorithms.GroundStateSolver.md | 8 +- ...ry.algorithms.MinimumEigensolverFactory.md | 6 +- ...stry.algorithms.NumPyEigensolverFactory.md | 4 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 6 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 6 +- .../0.32/qiskit.chemistry.algorithms.QEOM.md | 4 +- .../qiskit.chemistry.algorithms.QEomEE.md | 2 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 2 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 8 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 6 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 6 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 4 +- ...s.pes_samplers.DifferentialExtrapolator.md | 4 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 12 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 12 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 6 +- ...gorithms.pes_samplers.HarmonicPotential.md | 24 +- ....algorithms.pes_samplers.MorsePotential.md | 24 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 4 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 4 +- ...y.algorithms.pes_samplers.PotentialBase.md | 8 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 4 +- ...thms.pes_samplers.VibronicStructureBase.md | 10 +- ...orithms.pes_samplers.WindowExtrapolator.md | 4 +- ...applications.MolecularGroundStateEnergy.md | 6 +- ...y.components.bosonic_bases.BosonicBasis.md | 4 +- ....components.bosonic_bases.HarmonicBasis.md | 4 +- ...y.components.initial_states.HartreeFock.md | 4 +- ...hemistry.components.initial_states.VSCF.md | 4 +- ...mistry.components.variational_forms.CHC.md | 4 +- ...stry.components.variational_forms.UCCSD.md | 22 +- ...istry.components.variational_forms.UVCC.md | 8 +- ...qiskit.chemistry.core.ChemistryOperator.md | 6 +- .../0.32/qiskit.chemistry.core.Hamiltonian.md | 4 +- ...chemistry.core.MolecularChemistryResult.md | 2 +- ...istry.core.MolecularExcitedStatesResult.md | 2 +- ...emistry.core.MolecularGroundStateResult.md | 6 +- .../qiskit.chemistry.core.QubitMappingType.md | 2 +- ...iskit.chemistry.core.TransformationType.md | 2 +- .../qiskit.chemistry.drivers.BaseDriver.md | 2 +- .../qiskit.chemistry.drivers.BasisType.md | 2 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 4 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 6 +- ...iskit.chemistry.drivers.FermionicDriver.md | 4 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 4 +- ....chemistry.drivers.GaussianForcesDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 4 +- ...kit.chemistry.drivers.GaussianLogResult.md | 4 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 4 +- .../qiskit.chemistry.drivers.HFMethodType.md | 2 +- .../qiskit.chemistry.drivers.InitialGuess.md | 2 +- .../0.32/qiskit.chemistry.drivers.Molecule.md | 14 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 4 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 4 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 4 +- .../qiskit.chemistry.drivers.UnitsType.md | 2 +- ...it.chemistry.results.BOPESSamplerResult.md | 4 +- ...skit.chemistry.results.EigenstateResult.md | 2 +- ...istry.results.ElectronicStructureResult.md | 6 +- ...emistry.results.VibronicStructureResult.md | 2 +- ...transformations.BosonicQubitMappingType.md | 2 +- ...y.transformations.BosonicTransformation.md | 10 +- ...ansformations.BosonicTransformationType.md | 2 +- ...ansformations.FermionicQubitMappingType.md | 2 +- ...transformations.FermionicTransformation.md | 10 +- ...sformations.FermionicTransformationType.md | 2 +- ...hemistry.transformations.Transformation.md | 10 +- .../0.32/qiskit.circuit.AncillaQubit.md | 2 +- .../0.32/qiskit.circuit.AncillaRegister.md | 2 +- .../0.32/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.32/qiskit.circuit.Clbit.md | 2 +- .../0.32/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.32/qiskit.circuit.Delay.md | 12 +- .../0.32/qiskit.circuit.EquivalenceLibrary.md | 12 +- docs/api/qiskit/0.32/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.32/qiskit.circuit.Instruction.md | 28 +-- .../0.32/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.32/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.32/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 30 +-- .../0.32/qiskit.circuit.ParameterVector.md | 6 +- .../0.32/qiskit.circuit.QuantumCircuit.md | 206 +++++++++--------- .../0.32/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.32/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.32/qiskit.circuit.Reset.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.AND.md | 2 +- .../0.32/qiskit.circuit.library.Barrier.md | 8 +- .../0.32/qiskit.circuit.library.C3SXGate.md | 4 +- .../0.32/qiskit.circuit.library.C3XGate.md | 6 +- .../0.32/qiskit.circuit.library.C4XGate.md | 6 +- .../0.32/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.32/qiskit.circuit.library.CHGate.md | 4 +- .../0.32/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.32/qiskit.circuit.library.CRXGate.md | 4 +- .../0.32/qiskit.circuit.library.CRYGate.md | 4 +- .../0.32/qiskit.circuit.library.CRZGate.md | 4 +- .../0.32/qiskit.circuit.library.CSXGate.md | 2 +- .../0.32/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.32/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.32/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.32/qiskit.circuit.library.CUGate.md | 4 +- .../0.32/qiskit.circuit.library.CXGate.md | 6 +- .../0.32/qiskit.circuit.library.CYGate.md | 4 +- .../0.32/qiskit.circuit.library.CZGate.md | 4 +- .../0.32/qiskit.circuit.library.DCXGate.md | 2 +- .../0.32/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.32/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.GRZ.md | 2 +- .../0.32/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.32/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.32/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.32/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.32/qiskit.circuit.library.MCMT.md | 6 +- .../0.32/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.32/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.32/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.32/qiskit.circuit.library.MSGate.md | 2 +- .../0.32/qiskit.circuit.library.Measure.md | 4 +- .../0.32/qiskit.circuit.library.NLocal.md | 12 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.OR.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.32/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.32/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.32/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.32/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.32/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.32/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.32/qiskit.circuit.library.RGate.md | 4 +- .../0.32/qiskit.circuit.library.RVGate.md | 6 +- .../0.32/qiskit.circuit.library.RXGate.md | 6 +- .../0.32/qiskit.circuit.library.RXXGate.md | 4 +- .../0.32/qiskit.circuit.library.RYGate.md | 6 +- .../0.32/qiskit.circuit.library.RYYGate.md | 4 +- .../0.32/qiskit.circuit.library.RZGate.md | 6 +- .../0.32/qiskit.circuit.library.RZXGate.md | 4 +- .../0.32/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.32/qiskit.circuit.library.Reset.md | 4 +- .../0.32/qiskit.circuit.library.SGate.md | 4 +- .../0.32/qiskit.circuit.library.SXGate.md | 6 +- .../0.32/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.32/qiskit.circuit.library.SdgGate.md | 4 +- .../0.32/qiskit.circuit.library.SwapGate.md | 6 +- .../0.32/qiskit.circuit.library.TGate.md | 4 +- .../0.32/qiskit.circuit.library.TdgGate.md | 4 +- .../0.32/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.32/qiskit.circuit.library.U1Gate.md | 6 +- .../0.32/qiskit.circuit.library.U2Gate.md | 4 +- .../0.32/qiskit.circuit.library.U3Gate.md | 6 +- .../0.32/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.UniformDistribution.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.32/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.32/qiskit.circuit.library.XOR.md | 2 +- .../0.32/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.32/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.32/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.32/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.32/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.32/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.32/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.32/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.32/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.qpy_serialization.dump.md | 2 +- .../qiskit.circuit.qpy_serialization.load.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.32/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.32/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.32/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.32/qiskit.compiler.transpile.md | 2 +- .../0.32/qiskit.converters.ast_to_dag.md | 2 +- .../0.32/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.32/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.32/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.32/qiskit.dagcircuit.DAGCircuit.md | 126 +++++------ .../0.32/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.32/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.32/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../qiskit/0.32/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.32/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.32/qiskit.extensions.Initialize.md | 8 +- .../qiskit/0.32/qiskit.extensions.Snapshot.md | 8 +- .../0.32/qiskit.extensions.UnitaryGate.md | 16 +- .../0.32/qiskit.finance.QiskitFinanceError.md | 2 +- ....uncertainty_problems.EuropeanCallDelta.md | 8 +- ...inty_problems.EuropeanCallExpectedValue.md | 8 +- ...ainty_problems.FixedIncomeExpectedValue.md | 10 +- ...finance.data_providers.BaseDataProvider.md | 16 +- ...nce.data_providers.DataOnDemandProvider.md | 4 +- ...nce.data_providers.ExchangeDataProvider.md | 4 +- ...nance.data_providers.RandomDataProvider.md | 4 +- ...skit.finance.data_providers.StockMarket.md | 2 +- ...ce.data_providers.WikipediaDataProvider.md | 4 +- ...inance.data_providers.YahooDataProvider.md | 4 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.32/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.32/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 6 +- .../0.32/qiskit.ignis.verification.BConfig.md | 18 +- .../qiskit.ignis.verification.CNOTDihedral.md | 34 +-- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.32/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.32/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- ...kit.ml.circuit.library.RawFeatureVector.md | 6 +- .../0.32/qiskit.ml.datasets.ad_hoc_data.md | 2 +- .../0.32/qiskit.ml.datasets.breast_cancer.md | 2 +- .../qiskit/0.32/qiskit.ml.datasets.digits.md | 2 +- .../0.32/qiskit.ml.datasets.gaussian.md | 2 +- .../qiskit/0.32/qiskit.ml.datasets.iris.md | 2 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 2 +- .../qiskit/0.32/qiskit.ml.datasets.wine.md | 2 +- .../qiskit/0.32/qiskit.opflow.OperatorBase.md | 40 ++-- .../qiskit/0.32/qiskit.opflow.OpflowError.md | 2 +- .../0.32/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.32/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.32/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.32/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.32/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.32/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.32/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.32/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 4 +- .../0.32/qiskit.opflow.gradients.QFI.md | 4 +- .../0.32/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.32/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.32/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.32/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.32/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +-- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 38 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +-- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.32/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +-- ...it.optimization.QiskitOptimizationError.md | 2 +- .../qiskit.optimization.QuadraticProgram.md | 76 +++---- ...ation.algorithms.ADMMOptimizationResult.md | 2 +- ...t.optimization.algorithms.ADMMOptimizer.md | 6 +- ....optimization.algorithms.ADMMParameters.md | 2 +- ...iskit.optimization.algorithms.ADMMState.md | 2 +- ...optimization.algorithms.CobylaOptimizer.md | 6 +- ....optimization.algorithms.CplexOptimizer.md | 8 +- ...ion.algorithms.GroverOptimizationResult.md | 2 +- ...optimization.algorithms.GroverOptimizer.md | 6 +- ...imization.algorithms.IntermediateResult.md | 2 +- ...gorithms.MinimumEigenOptimizationResult.md | 4 +- ...zation.algorithms.MinimumEigenOptimizer.md | 6 +- ...mization.algorithms.MultiStartOptimizer.md | 4 +- ...zation.algorithms.OptimizationAlgorithm.md | 8 +- ...imization.algorithms.OptimizationResult.md | 2 +- ...ion.algorithms.OptimizationResultStatus.md | 2 +- ...RecursiveMinimumEigenOptimizationResult.md | 2 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 6 +- ...tion.algorithms.SlsqpOptimizationResult.md | 2 +- ....optimization.algorithms.SlsqpOptimizer.md | 6 +- ....optimization.algorithms.SolutionSample.md | 2 +- ...ization.converters.InequalityToEquality.md | 6 +- ...optimization.converters.IntegerToBinary.md | 6 +- ...tion.converters.LinearEqualityToPenalty.md | 6 +- ...on.converters.QuadraticProgramConverter.md | 6 +- ...ation.converters.QuadraticProgramToQubo.md | 10 +- ...qiskit.optimization.problems.Constraint.md | 4 +- ....optimization.problems.LinearConstraint.md | 4 +- ....optimization.problems.LinearExpression.md | 10 +- ...timization.problems.QuadraticConstraint.md | 4 +- ...timization.problems.QuadraticExpression.md | 10 +- ...ptimization.problems.QuadraticObjective.md | 6 +- ....optimization.problems.QuadraticProgram.md | 76 +++---- ...zation.problems.QuadraticProgramElement.md | 2 +- .../qiskit.optimization.problems.Variable.md | 4 +- .../qiskit/0.32/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.32/qiskit.providers.BackendV1.md | 16 +- .../0.32/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.32/qiskit.providers.BaseJob.md | 24 +- .../0.32/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.32/qiskit.providers.Job.md | 2 +- .../qiskit/0.32/qiskit.providers.JobError.md | 2 +- .../qiskit/0.32/qiskit.providers.JobStatus.md | 2 +- .../0.32/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.32/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.32/qiskit.providers.Options.md | 6 +- .../qiskit/0.32/qiskit.providers.Provider.md | 2 +- .../0.32/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.32/qiskit.providers.aer.AerError.md | 2 +- .../0.32/qiskit.providers.aer.AerProvider.md | 6 +- .../0.32/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.32/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 28 +-- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.32/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 10 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.32/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.32/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.32/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.32/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...skit.providers.ibmq.random.CQCExtractor.md | 10 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 6 +- ...providers.ibmq.random.IBMQRandomService.md | 6 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +-- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.32/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.32/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- docs/api/qiskit/0.32/qiskit.pulse.Acquire.md | 4 +- .../0.32/qiskit.pulse.AcquireChannel.md | 2 +- docs/api/qiskit/0.32/qiskit.pulse.Call.md | 8 +- docs/api/qiskit/0.32/qiskit.pulse.Constant.md | 6 +- .../0.32/qiskit.pulse.ControlChannel.md | 2 +- docs/api/qiskit/0.32/qiskit.pulse.Delay.md | 4 +- docs/api/qiskit/0.32/qiskit.pulse.Drag.md | 6 +- .../qiskit/0.32/qiskit.pulse.DriveChannel.md | 2 +- docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md | 6 +- .../0.32/qiskit.pulse.GaussianSquare.md | 6 +- .../qiskit/0.32/qiskit.pulse.Instruction.md | 22 +- .../qiskit.pulse.InstructionScheduleMap.md | 20 +- .../0.32/qiskit.pulse.MeasureChannel.md | 2 +- .../qiskit/0.32/qiskit.pulse.MemorySlot.md | 2 +- docs/api/qiskit/0.32/qiskit.pulse.Play.md | 6 +- .../qiskit/0.32/qiskit.pulse.PulseError.md | 2 +- .../qiskit/0.32/qiskit.pulse.RegisterSlot.md | 2 +- docs/api/qiskit/0.32/qiskit.pulse.Schedule.md | 30 +-- .../qiskit/0.32/qiskit.pulse.ScheduleBlock.md | 30 +-- .../qiskit/0.32/qiskit.pulse.SetFrequency.md | 4 +- docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md | 4 +- .../0.32/qiskit.pulse.ShiftFrequency.md | 4 +- .../qiskit/0.32/qiskit.pulse.ShiftPhase.md | 4 +- docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md | 4 +- docs/api/qiskit/0.32/qiskit.pulse.Waveform.md | 6 +- .../0.32/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.32/qiskit.pulse.builder.align_func.md | 2 +- .../0.32/qiskit.pulse.builder.align_left.md | 2 +- .../0.32/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.32/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.delay.md | 2 +- .../0.32/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.32/qiskit.pulse.builder.inline.md | 2 +- .../0.32/qiskit.pulse.builder.measure.md | 2 +- .../0.32/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.32/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.pad.md | 2 +- .../0.32/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.32/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.32/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.32/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.32/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.32/qiskit.pulse.builder.x.md | 2 +- .../0.32/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.32/qiskit.pulse.instructions.Call.md | 8 +- .../0.32/qiskit.pulse.instructions.Delay.md | 4 +- .../qiskit.pulse.instructions.Instruction.md | 22 +- .../0.32/qiskit.pulse.instructions.Play.md | 6 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.32/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.32/qiskit.pulse.library.Drag.md | 6 +- .../0.32/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.32/qiskit.pulse.library.Waveform.md | 6 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../0.32/qiskit.pulse.transforms.pad.md | 2 +- .../qiskit/0.32/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.32/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.32/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.32/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.32/qiskit.qobj.GateCalibration.md | 6 +- .../0.32/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md | 6 +- .../0.32/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.32/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.32/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.32/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.32/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.32/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.32/qiskit.qobj.Qobj.md | 2 +- .../0.32/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.32/qiskit.qobj.QobjHeader.md | 2 +- .../0.32/qiskit.qobj.QobjMeasurementOption.md | 6 +- .../0.32/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.32/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.32/qiskit.quantum_info.Choi.md | 12 +- .../0.32/qiskit.quantum_info.Clifford.md | 32 +-- .../0.32/qiskit.quantum_info.DensityMatrix.md | 38 ++-- .../qiskit/0.32/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.32/qiskit.quantum_info.Operator.md | 26 +-- .../qiskit/0.32/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.32/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.32/qiskit.quantum_info.PauliList.md | 50 ++--- .../0.32/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.32/qiskit.quantum_info.Quaternion.md | 14 +- .../0.32/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.32/qiskit.quantum_info.SparsePauliOp.md | 32 +-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.32/qiskit.quantum_info.Statevector.md | 38 ++-- .../0.32/qiskit.quantum_info.Stinespring.md | 14 +- .../0.32/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.32/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.32/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.32/qiskit.quantum_info.entropy.md | 2 +- .../0.32/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.32/qiskit.quantum_info.partial_trace.md | 2 +- .../0.32/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.32/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.32/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.32/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- docs/api/qiskit/0.32/qiskit.result.Counts.md | 8 +- .../0.32/qiskit.result.ProbDistribution.md | 6 +- .../0.32/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.32/qiskit.result.Result.md | 16 +- .../qiskit/0.32/qiskit.result.ResultError.md | 2 +- .../0.32/qiskit.result.marginal_counts.md | 2 +- .../0.32/qiskit.scheduler.ScheduleConfig.md | 2 +- .../0.32/qiskit.tools.backend_monitor.md | 2 +- .../0.32/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.32/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.32/qiskit.tools.parallel_map.md | 2 +- .../0.32/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.32/qiskit.transpiler.CouplingMap.md | 36 +-- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.32/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- .../qiskit/0.32/qiskit.transpiler.Layout.md | 30 +-- .../0.32/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.32/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.32/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.32/qiskit.transpiler.passes.CheckMap.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- .../0.32/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.32/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.32/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.32/qiskit.transpiler.passes.Unroller.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.32/qiskit.transpiler.passes.Width.md | 4 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../0.32/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.32/qiskit.utils.apply_prefix.md | 2 +- .../0.32/qiskit.utils.deprecate_arguments.md | 2 +- .../0.32/qiskit.utils.deprecate_function.md | 2 +- .../0.32/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.32/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md | 2 +- .../0.32/qiskit.utils.is_main_process.md | 2 +- .../0.32/qiskit.utils.local_hardware_info.md | 2 +- .../api/qiskit/0.32/qiskit.utils.name_args.md | 2 +- .../0.32/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...dation.jsonschema.SchemaValidationError.md | 2 +- ...jsonschema.validate_json_against_schema.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.32/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- 1218 files changed, 3891 insertions(+), 3891 deletions(-) diff --git a/docs/api/qiskit/0.32/execute.md b/docs/api/qiskit/0.32/execute.md index 8755b9240c2..3b45799405a 100644 --- a/docs/api/qiskit/0.32/execute.md +++ b/docs/api/qiskit/0.32/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.32/logging.md b/docs/api/qiskit/0.32/logging.md index c89832290dc..5370233ee59 100644 --- a/docs/api/qiskit/0.32/logging.md +++ b/docs/api/qiskit/0.32/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md index 8ca3e9ac38e..70247e04092 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md index eda68be3b99..05f5a8abf08 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md index 8b58f5f16f7..a35b05d675b 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md index 0ea6cb88896..6a34c5b5e0d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md index bd82b5983d1..c3d0fd6bca9 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md index d9fbb41272f..850ab74790c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md index a7d3692f34c..d543bb3f8af 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md index 9e8af705568..54f056bb323 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md index 0fa85780d22..e4c1693fee6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md index 64a52fe413b..b43b87c52ae 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7e80483cdc3..13261c39680 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md index 09619cab3ad..66afc42fcbf 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -109,7 +109,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -135,7 +135,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md index 0d3262e9fe5..546a9de563a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md index 7b070d712b6..a58db83d55d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -88,7 +88,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4d3d66e1511..ff05137ad29 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index ffd8680ce2a..dac975d8447 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md index 4e0525435b7..c1a5caaf0a8 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 786a28ca73f..cc26a05cb50 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md index 734f5435191..9a5338b4e40 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md index b467025bb12..95cc165d6df 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md index e94e8c97d93..6bdc92cbd2d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 672d1632cf8..9b52579c968 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index a4549d470bf..07d3d3a29bb 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md index 1fa59d6cbab..6efe690ec1c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md index 434d8f1b250..f461d953178 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md index 9bbfcc4d1e1..53d3a4858fc 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md index 40aedeb0213..94ac1589c69 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md index a468cd4132d..6ac7e2745a0 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md index 5646cc39b02..828dc7a48c8 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md index 9b7c64c8742..8264f0cdd4d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md index 6b02367ef38..0607e4db3f0 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md index 3b6a7acc155..d4d3337a5a8 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md index 943abc13d66..d02bc90d794 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md index 301ee26f92b..aadac8890b7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md index 85c5f13cd0b..ae0803868a7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None, sort_parameters_by_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -51,7 +51,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -93,7 +93,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -148,7 +148,7 @@ dict -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -175,7 +175,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -187,7 +187,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -199,7 +199,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -227,7 +227,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -243,7 +243,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.md index 91320d37127..67bde1016da 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -121,7 +121,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -159,7 +159,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.md index 9eb6256f9ba..72f65b1b1c7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.md index 6db1b85881e..36824db4a70 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.md index e4899ab96e1..fd95ce853d8 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.md index 85f09e4e59c..55db3a940b3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.md index f52e1dd72f6..7fee2cbbfb1 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.md index dccc95dd453..8f7466e1deb 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5a424cb5965..5ef96d11579 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.md index d6e70b8e91a..e3a883d3222 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.md index 8f47f9e5d2c..f1bae1797c3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -172,7 +172,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -196,7 +196,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.md index 3932cff062c..a6b80c6390f 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.md index 499edc4598c..0b65a1220ed 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.md index c3a40820c6b..d9140d08e01 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.md index 7da978ade93..3a2c93d82f2 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.md index f24e582865f..89b376cb8a7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.md index cce399c08cb..8613db5a039 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.md index f3e2efd0371..8aa53bca58d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 948f5158c5f..980594e2fe5 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.md index 2e38bcf0b6a..2107f37d0c3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.md index 98dd1037f06..4837f9b9422 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.md index 01e413fbba3..4d0e65b0ebf 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -123,7 +123,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.md index a630c804619..30a2c283d1d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.md index 3f7ed381506..86c66895db7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.md index a5555c44b15..30993b5e0fa 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -101,7 +101,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -136,7 +136,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -148,7 +148,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -179,7 +179,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.md index 72a75110049..6de668be969 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.md index 1f76b2e70b7..559898217d7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md index c2c87a14da5..b4579f16ed6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.AquaError -`AquaError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") +`AquaError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/aqua_error.py "view source code") Base class for errors raised by Aqua. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md index a6654a15886..ae091b23fe5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.MissingOptionalLibraryError -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") +`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/missing_optional_library_error.py "view source code") Raised when an optional library is missing. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md index 4b2f505ac55..604dfb78a3a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.QuantumInstance -`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=1024, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") assemble circuits @@ -64,7 +64,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -84,7 +84,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -109,7 +109,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -129,7 +129,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Reset execution results @@ -141,7 +141,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -149,7 +149,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :type circuits: `Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]] :param circuits: circuits to transpile diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.md index b10e0ebc8ca..ccb94b46591 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, phase_estimation_circuit=None, iqft=None, quantum_instance=None, a_factory=None, q_factory=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -56,7 +56,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.confidence_interval(alpha, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -82,7 +82,7 @@ The (1 - alpha) confidence interval of the specified kind. -`AmplitudeEstimation.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md index 2a74e74f268..0111c5beb77 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult -`AmplitudeEstimationAlgorithmResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`AmplitudeEstimationAlgorithmResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") +`static AmplitudeEstimationAlgorithmResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae_algorithm.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.md index 214b669ba8c..9c38c01fbd8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static AmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/ae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.md index bdf6a6a2030..1f8bd38fd94 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani -`BernsteinVazirani(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -29,7 +29,7 @@ The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jo -`BernsteinVazirani.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") +`BernsteinVazirani.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/bernstein_vazirani.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.md index 3a85fe02cfa..d471a48f4d1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm -`ClassicalAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for Classical Algorithms. -`ClassicalAlgorithm.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") +`ClassicalAlgorithm.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classical_algorithm.py "view source code") Execute the classical algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.md index f5ad0c57f4e..b2d1ddbef94 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") +`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/cplex/classical_cplex.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.md index 40b26aa0800..8a4fe2dbd30 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa -`DeutschJozsa(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`DeutschJozsa.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") +`DeutschJozsa.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/deutsch_jozsa.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.md index 6005a5c125b..ac96edbb4e6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EOH -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -35,7 +35,7 @@ EOH provides the lower-level building blocks for simulating universal quantum sy -`EOH.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") +`EOH.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/eoh.py "view source code") Construct the circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.md index 36a981429d0..c135dc4ece6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.md index 03e2bee0c4e..5fd16785333 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.EigensolverResult -`EigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static EigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") +`static EigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.md index 05f0ff863d5..206dce3fd08 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Grover -`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(oracle, good_state=None, state_preparation=None, iterations=1, sample_from_iterations=False, post_processing=None, grover_operator=None, quantum_instance=None, init_state=None, incremental=False, num_iterations=None, lam=None, rotation_counts=None, mct_mode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -100,7 +100,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.construct_circuit(power=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(power=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -121,7 +121,7 @@ the QuantumCircuit object for the constructed circuit -`Grover.is_good_state(bitstr)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.is_good_state(bitstr)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Check whether a provided bitstring is a good state or not. @@ -141,7 +141,7 @@ True if the measurement is a good state, False otherwise. -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. @@ -162,7 +162,7 @@ The optimal number of iterations for Grover’s algorithm to succeed. -`Grover.post_processing(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.post_processing(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Do the post-processing to the measurement result diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.md index 27e2ed48c8b..0621bf4ee5e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.GroverResult -`GroverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static GroverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") +`static GroverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_amplifiers/grover.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.md index 104509eb4dc..3d4e71cd17c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHL -`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL(matrix, vector, truncate_powerdim=False, truncate_hermitian=False, eigs=None, init_state=None, reciprocal=None, num_q=0, num_a=0, orig_size=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -61,7 +61,7 @@ See also [https://arxiv.org/abs/0811.3171](https://arxiv.org/abs/0811.3171) -`HHL.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -81,7 +81,7 @@ the QuantumCircuit object for the constructed circuit -`static HHL.expand_to_hermitian(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_hermitian(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. @@ -102,7 +102,7 @@ the expanded matrix, the expanded vector -`static HHL.expand_to_powerdim(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.expand_to_powerdim(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. @@ -123,7 +123,7 @@ the expanded matrix, the expanded vector -`static HHL.matrix_resize(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHL.matrix_resize(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Resizes matrix if necessary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.md index bacb695ea73..14d8c1fa1a3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.HHLResult -`HHLResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`HHLResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static HHLResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") +`static HHLResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/hhl.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.md index 2acf9246296..3ec9bf228b6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE -`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE(operator=None, state_in=None, num_time_slices=1, num_iterations=1, expansion_mode='suzuki', expansion_order=2, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -41,7 +41,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -62,7 +62,7 @@ MinimumEigensolverResult -`IQPE.construct_circuit(k=None, omega=0, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") +`IQPE.construct_circuit(k=None, omega=0, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/iqpe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md index f55ec87a6b6..b41888a8ef7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation(epsilon, alpha, confint_method='beta', min_ratio=2, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, initial_state=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -58,7 +58,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(k, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Construct the circuit Q^k A |0>. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md index 46017326c36..ece986b79ca 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`IterativeAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static IterativeAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") +`static IterativeAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.md index f9932eafc75..579de6c101c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.LinearsolverResult -`LinearsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`LinearsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static LinearsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") +`static LinearsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/linear_solver_result.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md index d2fa6b6ec8f..bfe70b347c7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(num_oracle_circuits, state_preparation=None, grover_operator=None, objective_qubits=None, post_processing=None, a_factory=None, q_factory=None, i_objective=None, likelihood_evals=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithm` @@ -47,7 +47,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.confidence_interval(alpha, kind='fisher')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -75,7 +75,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 834bf66fa9f..98c4ae01b1b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResu -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimationResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/mlae.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.md index 113932d3d9f..0e6660fc029 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.md index e69567d581a..a0a2e3e8146 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static MinimumEigensolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`static MinimumEigensolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.md index abaf7014801..14fb63b3ae9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -72,7 +72,7 @@ dict -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.md index 869a22babd1..e82deb99e27 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolver -`NumPyLSsolver(matrix, vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolver(matrix, vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.md index 48320e33e2d..325dc0c2e7b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult -`NumPyLSsolverResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`NumPyLSsolverResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") Bases: `qiskit.aqua.algorithms.linear_solvers.linear_solver_result.LinearsolverResult` @@ -54,7 +54,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`static NumPyLSsolverResult.from_dict(a_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") +`static NumPyLSsolverResult.from_dict(a_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/linear_solvers/numpy_ls_solver.py "view source code") create new object from a dictionary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md index 7e31abd12a8..e9e0330c118 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -28,7 +28,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -65,7 +65,7 @@ dict -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.md index c76832ae833..567c8be2c20 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA -`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") +`QAOA(operator=None, optimizer=None, p=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qaoa/qaoa.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.md index cba3dfb07e5..9cdb44a756c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN -`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN(data, bounds=None, num_qubits=None, batch_size=500, num_epochs=3000, seed=7, discriminator=None, generator=None, tol_rel_ent=None, snapshot_dir=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -52,7 +52,7 @@ These networks are trained in alternating optimization steps, where the discrimi -`QGAN.get_rel_entr()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.get_rel_entr()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Get relative entropy between target and trained distribution @@ -101,7 +101,7 @@ Sets backend with configuration. -`QGAN.set_discriminator(discriminator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_discriminator(discriminator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize discriminator. @@ -113,7 +113,7 @@ Initialize discriminator. -`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.set_generator(generator_circuit=None, generator_init_params=None, generator_optimizer=None, generator_gradient=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Initialize generator. @@ -132,7 +132,7 @@ Initialize generator. -`QGAN.train()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") +`QGAN.train()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/distribution_learners/qgan.py "view source code") Train the qGAN diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.md index 7cd80d2324f..b59e0f51ace 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QPE -`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, shallow_circuit_concat=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -36,7 +36,7 @@ QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two -`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -57,7 +57,7 @@ MinimumEigensolverResult -`QPE.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") +`QPE.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/qpe.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.md index ecf1e8d533a..3dd3054fa81 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/1804.11326](https://arxiv.org/abs/1804.11326) -`QSVM.construct_circuit(x1, x2, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_circuit(x1, x2, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Generate inner product of x1 and x2 with the given feature map. @@ -68,7 +68,7 @@ constructed circuit -`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.construct_kernel_matrix(x1_vec, x2_vec=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -98,7 +98,7 @@ numpy.ndarray -`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`static QSVM.get_kernel_matrix(quantum_instance, feature_map, x1_vec, x2_vec=None, enforce_psd=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. @@ -126,7 +126,7 @@ numpy.ndarray -`QSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Load a model from a file path. @@ -138,7 +138,7 @@ Load a model from a file path. -`QSVM.predict(data, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.predict(data, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Predict using the svm. @@ -188,7 +188,7 @@ dict -`QSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Save the model to a file path. @@ -212,7 +212,7 @@ Sets backend with configuration. -`QSVM.setup_datapoint(datapoints)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_datapoint(datapoints)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup data points, if the data were there, they would be overwritten. @@ -224,7 +224,7 @@ Setup data points, if the data were there, they would be overwritten. -`QSVM.setup_test_data(test_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_test_data(test_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup test data, if the data were there, they would be overwritten. @@ -236,7 +236,7 @@ Setup test data, if the data were there, they would be overwritten. -`QSVM.setup_training_data(training_dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.setup_training_data(training_dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Setup training data, if the data were there, they would be overwritten. @@ -248,7 +248,7 @@ Setup training data, if the data were there, they would be overwritten. -`QSVM.test(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.test(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Test the svm. @@ -274,7 +274,7 @@ float -`QSVM.train(data, labels, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") +`QSVM.train(data, labels, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/qsvm/qsvm.py "view source code") Train the svm. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.md index 6469b629d9f..1b4df2b01a5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm -`QuantumAlgorithm(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`QuantumAlgorithm.run(quantum_instance=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.run(quantum_instance=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Execute the algorithm with selected backend. @@ -49,7 +49,7 @@ dict -`QuantumAlgorithm.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") +`QuantumAlgorithm.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/quantum_algorithm.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.md index 906bf8324e1..c70d9dd55e0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Shor -`Shor(N=15, a=2, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor(N=15, a=2, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -44,7 +44,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Construct circuit. @@ -64,7 +64,7 @@ Quantum circuit. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.md index 468f6eedbaf..a664949467d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.Simon -`Simon(oracle, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon(oracle, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Bases: `qiskit.aqua.algorithms.quantum_algorithm.QuantumAlgorithm` @@ -31,7 +31,7 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle " -`Simon.construct_circuit(measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") +`Simon.construct_circuit(measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/education/simon.py "view source code") Construct the quantum circuit diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.md index 114b49cd1b4..ea286eea4e7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.SklearnSVM -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Bases: `qiskit.aqua.algorithms.classical_algorithm.ClassicalAlgorithm` @@ -38,7 +38,7 @@ Internally, this algorithm will run the binary classification or multiclass clas -`SklearnSVM.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Load a model from a file path. @@ -50,7 +50,7 @@ Load a model from a file path. -`SklearnSVM.predict(data)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.predict(data)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Predict using the SVM @@ -86,7 +86,7 @@ dict -`SklearnSVM.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Save the model to a file path. @@ -98,7 +98,7 @@ Save the model to a file path. -`SklearnSVM.test(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.test(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Test the SVM @@ -119,7 +119,7 @@ float -`SklearnSVM.train(data, labels)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") +`SklearnSVM.train(data, labels)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/sklearn_svm/sklearn_svm.py "view source code") Train the SVM diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.md index 17badab47c3..5b669ef12f5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQC -`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC(optimizer, feature_map, var_form, training_dataset, test_dataset=None, datapoints=None, max_evals_grouped=1, minibatch_size=- 1, callback=None, use_sigmoid_cross_entropy=False, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -50,7 +50,7 @@ Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), -`VQC.batch_data(data, labels=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.batch_data(data, labels=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") batch data @@ -66,7 +66,7 @@ set parameterized circuits to None -`VQC.construct_circuit(x, theta, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.construct_circuit(x, theta, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Construct circuit based on data and parameters in variational form. @@ -120,7 +120,7 @@ dict -`VQC.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal circuit @@ -128,7 +128,7 @@ get optimal circuit -`VQC.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal cost @@ -136,7 +136,7 @@ get optimal cost -`VQC.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") get optimal vector @@ -160,7 +160,7 @@ get probabilities for counts -`VQC.is_gradient_really_supported()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.is_gradient_really_supported()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") returns is gradient really supported @@ -168,7 +168,7 @@ returns is gradient really supported -`VQC.load_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.load_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") load model @@ -176,7 +176,7 @@ load model -`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.predict(data, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data. @@ -224,7 +224,7 @@ dict -`VQC.save_model(file_path)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.save_model(file_path)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") save model @@ -244,7 +244,7 @@ Sets backend with configuration. -`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.test(data, labels, quantum_instance=None, minibatch_size=- 1, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Predict the labels for the data, and test against with ground truth labels. @@ -268,7 +268,7 @@ float -`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") +`VQC.train(data, labels, quantum_instance=None, minibatch_size=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/classifiers/vqc.py "view source code") Train the models, and save results. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.md index 177f46fdf74..ec982849070 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.algorithms.VQE -`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(operator=None, var_form=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, aux_operators=None, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm`, `qiskit.aqua.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -56,7 +56,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -77,7 +77,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -97,7 +97,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -149,7 +149,7 @@ dict -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -161,7 +161,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -173,7 +173,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -201,7 +201,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -254,7 +254,7 @@ Sets backend with configuration. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.md index 48fc6aa2731..f96e6e94ef1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.CNF -`CNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`CNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md index f45e1493fbd..55ada47cc05 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.DNF -`DNF(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`DNF.construct_circuit(circuit=None, variable_register=None, clause_register=None, output_register=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md index cf2e01fee26..10d86130fc8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.ESOP -`ESOP(ast, num_vars=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP(ast, num_vars=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Bases: `qiskit.aqua.circuits.boolean_logical_circuits.BooleanLogicNormalForm` @@ -41,7 +41,7 @@ returns the number of ancillary qubits needed -`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") +`ESOP.construct_circuit(circuit=None, variable_register=None, output_register=None, output_idx=None, ancillary_register=None, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/boolean_logical_circuits.py "view source code") Construct circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 9b19c13d7f0..988178c03dc 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit -`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit(operator=None, state_in=None, iqft=None, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=6.283185307179586, state_in_circuit_factory=None, unitary_circuit_factory=None, shallow_circuit_concat=False, pauli_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Quantum Phase Estimation Circuit. -`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") +`PhaseEstimationCircuit.construct_circuit(state_register=None, ancillary_register=None, auxiliary_register=None, measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/phase_estimation_circuit.py "view source code") Construct the Phase Estimation circuit diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.md index b93db01a246..51752d3e454 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.StateVectorCircuit -`StateVectorCircuit(state_vector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit(state_vector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Constructor. -`StateVectorCircuit.construct_circuit(circuit=None, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") +`StateVectorCircuit.construct_circuit(circuit=None, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py "view source code") Construct the circuit representing the desired state vector. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.md index f03b31602d8..53f485efc6f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.circuits.WeightedSumOperator -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -35,7 +35,7 @@ Computes the weighted sum controlled by state qubits -`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`static WeightedSumOperator.get_required_sum_qubits(weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`static WeightedSumOperator.get_required_sum_qubits(weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") get required sum qubits @@ -152,7 +152,7 @@ get required sum qubits -`WeightedSumOperator.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") required ancillas @@ -160,7 +160,7 @@ required ancillas -`WeightedSumOperator.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") +`WeightedSumOperator.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/weighted_sum_operator.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.md b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.md index a33e8c8187a..e0c4d55bcfe 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.Eigenvalues -`Eigenvalues`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Eigenvalues.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the eigenvalue estimation quantum circuit. @@ -49,7 +49,7 @@ object for the eigenvalue estimation circuit. -`Eigenvalues.construct_inverse(mode, circuit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`Eigenvalues.construct_inverse(mode, circuit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") Construct the inverse eigenvalue estimation quantum circuit. @@ -77,7 +77,7 @@ circuit. -`abstract Eigenvalues.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get register sizes @@ -85,7 +85,7 @@ get register sizes -`abstract Eigenvalues.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") +`abstract Eigenvalues.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py "view source code") get scaling diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.md b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.md index 2e3a140aed7..c5b9e1d0c41 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.eigs.EigsQPE -`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE(operator, iqft, num_time_slices=1, num_ancillae=1, expansion_mode='trotter', expansion_order=1, evo_time=None, negative_evals=False, ne_qfts=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Bases: `qiskit.aqua.components.eigs.eigs.Eigenvalues` @@ -36,7 +36,7 @@ Specifically, this class is based on PhaseEstimationCircuit with no measurements -`EigsQPE.construct_circuit(mode, register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.construct_circuit(mode, register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") Construct the eigenvalues estimation using the PhaseEstimationCircuit @@ -89,7 +89,7 @@ circuit. -`EigsQPE.get_register_sizes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_register_sizes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get register sizes @@ -97,7 +97,7 @@ get register sizes -`EigsQPE.get_scaling()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") +`EigsQPE.get_scaling()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs_qpe.py "view source code") get scaling diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.md b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.md index 0cbf5d6c13b..9319bd9c2eb 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.FeatureMap -`FeatureMap`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`FeatureMap` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`abstract FeatureMap.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") Construct the variational form, given its parameters. @@ -46,7 +46,7 @@ a quantum circuit. -`static FeatureMap.get_entangler_map(map_type, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.get_entangler_map(map_type, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") get entangle map @@ -54,7 +54,7 @@ get entangle map -`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") +`static FeatureMap.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.md b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.md index 409c3da2478..bb3b603b8a6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector -`RawFeatureVector(feature_dimension=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Bases: `qiskit.aqua.components.feature_maps.feature_map.FeatureMap` @@ -28,7 +28,7 @@ The Raw Feature Vector can be directly used as a feature map, where the raw feat -`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") +`RawFeatureVector.construct_circuit(x, qr=None, inverse=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/raw_feature_vector.py "view source code") Construct the second order expansion based on given data. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.md b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.md index 4517c472243..57ae062836a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Custom -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -43,7 +43,7 @@ The custom initial state will be set from the *circuit*, the *state\_vector*, or -`Custom.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") +`Custom.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/custom.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.md b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.md index c73507555a2..8cd086c95d1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.InitialState -`InitialState`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`InitialState` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract InitialState.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") +`abstract InitialState.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/initial_state.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.md b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.md index e35c15f2541..04386860f9f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.VarFormBased -`VarFormBased(var_form, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased(var_form, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutoria -`VarFormBased.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") +`VarFormBased.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/var_form_based.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.md b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.md index 2e66ab01606..b37e7959a31 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.initial_states.Zero -`Zero(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ This is suitable for those situations in which the all-zeros state is the desire -`Zero.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") +`Zero.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/initial_states/zero.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.md b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.md index 4e56d2102d5..9cbddbab79c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs -`AllPairs`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a -`AllPairs.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`AllPairs.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`AllPairs.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") +`AllPairs.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/all_pairs.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md index 603a21c221f..92f4f3b54bb 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCod -`ErrorCorrectingCode(code_size=4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode(code_size=4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -38,7 +38,7 @@ The table above shows a 6-bit ECC for a 3-class problem. Each class is assigned -`ErrorCorrectingCode.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Applying multiple estimators for prediction. @@ -70,7 +70,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`ErrorCorrectingCode.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -91,7 +91,7 @@ float -`ErrorCorrectingCode.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") +`ErrorCorrectingCode.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/error_correcting_code.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md index 4e5bfee3b20..c58a47d8259 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtensio -`MulticlassExtension`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract MulticlassExtension.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Applying multiple estimators for prediction. @@ -36,7 +36,7 @@ Applying multiple estimators for prediction. -`MulticlassExtension.set_estimator(estimator_cls, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`MulticlassExtension.set_estimator(estimator_cls, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Called internally to set `Estimator` and parameters :type estimator\_cls: `Callable`\[\[`List`], `Estimator`] :param estimator\_cls: An `Estimator` class :type params: `Optional`\[`List`] :param params: Parameters for the estimator @@ -48,7 +48,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`abstract MulticlassExtension.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -61,7 +61,7 @@ Testing multiple estimators each for distinguishing a pair of classes. -`abstract MulticlassExtension.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") +`abstract MulticlassExtension.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/multiclass_extension.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md index 99912cbdeaa..5746e6c21ed 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest -`OneAgainstRest`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -24,7 +24,7 @@ For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM cla -`OneAgainstRest.predict(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.predict(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Applying multiple estimators for prediction. @@ -56,7 +56,7 @@ Called internally to set `Estimator` and parameters :type estimator\_cls: `Calla -`OneAgainstRest.test(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.test(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Testing multiple estimators each for distinguishing a pair of classes. @@ -77,7 +77,7 @@ float -`OneAgainstRest.train(x, y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") +`OneAgainstRest.train(x, y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/multiclass_extensions/one_against_rest.py "view source code") Training multiple estimators each for distinguishing a pair of classes. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md index 8598a8a962c..27dff35e801 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork -`DiscriminativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`DiscriminativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module but raise an exception if a required co -`abstract DiscriminativeNetwork.get_label(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.get_label(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Apply quantum/classical neural network to the given input sample and compute the respective data label @@ -40,7 +40,7 @@ Apply quantum/classical neural network to the given input sample and compute the -`abstract DiscriminativeNetwork.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Loss function used for optimization @@ -62,7 +62,7 @@ Loss w\.r.t to the generated data points. -`abstract DiscriminativeNetwork.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Save discriminator model @@ -78,7 +78,7 @@ Save discriminator model -`abstract DiscriminativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Set seed. @@ -94,7 +94,7 @@ Set seed. -`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") +`abstract DiscriminativeNetwork.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/discriminative_network.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.md b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.md index 87525ae962a..5cafb9ee98b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork -`GenerativeNetwork`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`GenerativeNetwork` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module, but raise an exception if a required c -`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.get_output(quantum_instance, params, shots)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Apply quantum/classical neural network to given input and get the respective output @@ -46,7 +46,7 @@ Neural network output -`abstract GenerativeNetwork.loss()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.loss()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Loss function used for optimization @@ -54,7 +54,7 @@ Loss function used for optimization -`abstract GenerativeNetwork.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set discriminator network. @@ -70,7 +70,7 @@ Set discriminator network. -`abstract GenerativeNetwork.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Set seed. @@ -86,7 +86,7 @@ Set seed. -`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") +`abstract GenerativeNetwork.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md index 508e3037633..51189161446 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator -`NumPyDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -27,7 +27,7 @@ Discriminator based on NumPy -`NumPyDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -48,7 +48,7 @@ numpy.ndarray -`NumPyDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Load discriminator model @@ -60,7 +60,7 @@ Load discriminator model -`NumPyDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Loss function :param x: sample label (equivalent to discriminator output) :type x: numpy.ndarray :param y: target label :type y: numpy.ndarray :param weights: customized scaling for each sample (optional) :type weights: numpy.ndarray @@ -76,7 +76,7 @@ float -`NumPyDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Save discriminator model @@ -88,7 +88,7 @@ Save discriminator model -`NumPyDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Set seed. :param seed: seed :type seed: int @@ -96,7 +96,7 @@ Set seed. :param seed: seed :type seed: int -`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") +`NumPyDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/numpy_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md index 914d5fad9e0..09ec0d6fa91 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator -`PyTorchDiscriminator(n_features=1, n_out=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator(n_features=1, n_out=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.discriminative_network.DiscriminativeNetwork` @@ -31,7 +31,7 @@ Discriminator based on PyTorch -`PyTorchDiscriminator.get_label(x, detach=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.get_label(x, detach=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Get data sample labels, i.e. true or fake. @@ -52,7 +52,7 @@ torch.Tensor -`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.gradient_penalty(x, lambda_=5.0, k=0.01, c=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Compute gradient penalty for discriminator optimization @@ -75,7 +75,7 @@ torch.Tensor -`PyTorchDiscriminator.load_model(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.load_model(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Load discriminator model @@ -87,7 +87,7 @@ Load discriminator model -`PyTorchDiscriminator.loss(x, y, weights=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.loss(x, y, weights=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Loss function @@ -109,7 +109,7 @@ torch.Tensor -`PyTorchDiscriminator.save_model(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.save_model(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Save discriminator model @@ -121,7 +121,7 @@ Save discriminator model -`PyTorchDiscriminator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") +`PyTorchDiscriminator.train(data, weights, penalty=False, quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/pytorch_discriminator.py "view source code") Perform one training step w\.r.t to the discriminator’s parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.md b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.md index 11da90e6808..5b063c0b256 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Bases: `qiskit.aqua.components.neural_networks.generative_network.GenerativeNetwork` @@ -38,7 +38,7 @@ The quantum generator is a parametrized quantum circuit which can be trained wit -`QuantumGenerator.construct_circuit(params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.construct_circuit(params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Construct generator circuit. @@ -58,7 +58,7 @@ construct the quantum circuit and return as gate -`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.get_output(quantum_instance, params=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Get classical data samples from the generator. Running the quantum generator circuit results in a quantum state. To train this generator with a classical discriminator, we need to sample classical outputs by measuring the quantum state and mapping them to feature space defined by the training data. @@ -80,7 +80,7 @@ list -`QuantumGenerator.loss(x, weights)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.loss(x, weights)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Loss function for training the generator’s parameters. @@ -101,7 +101,7 @@ float -`QuantumGenerator.set_discriminator(discriminator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_discriminator(discriminator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set discriminator network. @@ -117,7 +117,7 @@ Set discriminator network. -`QuantumGenerator.set_seed(seed)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.set_seed(seed)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Set seed. @@ -133,7 +133,7 @@ Set seed. -`QuantumGenerator.train(quantum_instance=None, shots=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") +`QuantumGenerator.train(quantum_instance=None, shots=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/quantum_generator.py "view source code") Perform one training step w\.r.t to the generator’s parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.md index 1642282382a..c1aa6dbfde6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -48,7 +48,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -79,7 +79,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -95,7 +95,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(objective_function, initial_point, gradient_function)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(objective_function, initial_point, gradient_function)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Run the minimization. @@ -117,7 +117,7 @@ A tuple of (optimal parameters, optimal value, number of iterations). -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -155,7 +155,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.md index 82687ee457d..cb07e980296 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -45,7 +45,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Support level dictionary @@ -86,7 +86,7 @@ grad -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.md index 8a986e3c761..17ffb681269 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.md index 588d71e1e95..8389e09586c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize CG. For further detail, please refer to [https://do -`CG.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") +`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cg.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.md index 16da45b4d73..a0337c770a4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.minimize COBYLA. For further detail, please refer to [https: -`COBYLA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Return support level dictionary @@ -64,7 +64,7 @@ grad -`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") +`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/cobyla.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.md index 771ae3eec74..c18de079b05 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.md index 3e2c4524bea..8128d75bb13 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md index ae5dfe2e7b4..9cf5fd1788b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.md index f72728b4531..e18b87cecd3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.md index 40b08824745..e45cf06aa95 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -39,7 +39,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Return support level dictionary. @@ -55,7 +55,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -103,7 +103,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Run the line search optimization. @@ -131,7 +131,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Perform optimization. @@ -169,7 +169,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -193,7 +193,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.md index 503b45666d6..f96aa6e9508 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.md index 2307be651a4..dd96bbeb6a3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.aqua.components.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.md index 47d39c3177a..225aa2a83a7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -38,7 +38,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`L_BFGS_B.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Return support level dictionary @@ -69,7 +69,7 @@ grad -`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/l_bfgs_b.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.md index b0a6d556988..951d36f56bd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize Nelder-Mead. For further detail, please refer to Se -`NELDER_MEAD.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Return support level dictionary @@ -68,7 +68,7 @@ grad -`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nelder_mead.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.md index 8d818bbdf2f..e541f8173b4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -43,7 +43,7 @@ K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization fo -`NFT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") return support level dictionary @@ -74,7 +74,7 @@ grad -`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") +`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/nft.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.md index 80e98a1d35c..c6705741607 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`abstract Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Perform optimization. @@ -81,7 +81,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -89,7 +89,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Set max evals grouped @@ -97,7 +97,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -111,7 +111,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md index 63d60f8c139..8c787fe12f7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.md index 74d8f777c17..bc33b3646a3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses scipy.optimize.minimize Powell. For further detail, please refer to See [ht -`POWELL.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Return support level dictionary @@ -65,7 +65,7 @@ grad -`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") +`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/powell.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.md index 9f7e665caea..fa6cfb71f22 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.P_BFGS -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -33,7 +33,7 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https -`P_BFGS.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") return support level dictionary @@ -64,7 +64,7 @@ grad -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.md index d4cf3418d3a..271594803ec 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -36,7 +36,7 @@ Uses scipy.optimize.minimize SLSQP. For further detail, please refer to See [htt -`SLSQP.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Return support level dictionary @@ -67,7 +67,7 @@ grad -`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") +`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/slsqp.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.md index c12fdcc6f6e..ba81d9e236b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.md index 9ea7dcf9cbe..57b9cda4881 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.SPSA -`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA(maxiter=1000, save_steps=1, last_avg=1, c0=0.6283185307179586, c1=0.1, c2=0.602, c3=0.101, c4=0, skip_calibration=False, max_trials=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -51,7 +51,7 @@ For further details, please refer to [https://arxiv.org/pdf/1704.05018v2.pdf#sec -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") return support level dictionary @@ -82,7 +82,7 @@ grad -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.md index 86a951cf3ff..5ce0ad96d08 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses scipy.optimize.minimize TNC For further detail, please refer to See [https: -`TNC.get_support_level()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.get_support_level()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") return support level dictionary @@ -68,7 +68,7 @@ grad -`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") +`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/tnc.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.md b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.md index 95a27575e64..71443988da0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ This class is provided for easy creation of oracles using custom circuits. It is -`CustomCircuitOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") +`CustomCircuitOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/custom_circuit_oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.md b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.md index af31497f164..a17dc76baa0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -58,7 +58,7 @@ By default, the Logical Expression oracle will not try to apply any optimization -`LogicalExpressionOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") construct circuit @@ -66,7 +66,7 @@ construct circuit -`LogicalExpressionOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") +`LogicalExpressionOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/logical_expression_oracle.py "view source code") evaluate classically diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.md b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.md index bc8909a4dd2..6f3f2f313a4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle -`Oracle(*args, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`Oracle(*args, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ This method should initialize the module and use an exception if a component of -`abstract Oracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") +`abstract Oracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py "view source code") Construct the oracle circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.md b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.md index 83f64fb7476..d75f233bad4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.oracles.TruthTableOracle -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") Bases: `qiskit.aqua.components.oracles.oracle.Oracle` @@ -46,7 +46,7 @@ Regarding circuit optimization and mct usages, the truth table oracle is similar -`TruthTableOracle.construct_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.construct_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") construct circuit @@ -54,7 +54,7 @@ construct circuit -`TruthTableOracle.evaluate_classically(measurement)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") +`TruthTableOracle.evaluate_classically(measurement)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/truth_table_oracle.py "view source code") evaluate classical diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.md b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.md index ba457478c4f..5a4caa52a33 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LongDivision -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -36,7 +36,7 @@ It finds the reciprocal with long division method and rotates the ancillary qubi -`LongDivision.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Construct the Long Division Rotation circuit. @@ -62,7 +62,7 @@ containing the Long Division Rotation circuit. -`LongDivision.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") +`LongDivision.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/long_division.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.md b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.md index d8db023f7f4..21c0acbde68 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.LookupRotation -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Bases: `qiskit.aqua.components.reciprocals.reciprocal.Reciprocal` @@ -35,7 +35,7 @@ A calculation of reciprocals of eigenvalues is performed and controlled rotation -`LookupRotation.construct_circuit(mode, inreg)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.construct_circuit(mode, inreg)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Construct the Lookup Rotation circuit. @@ -60,7 +60,7 @@ NotImplementedError: mode not supported -`LookupRotation.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") +`LookupRotation.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/lookup_rotation.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.md b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.md index fe08d1e0579..8c0ba818e7d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.reciprocals.Reciprocal -`Reciprocal`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`Reciprocal` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.construct_circuit(mode, register=None, circuit=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Construct the initial state circuit. @@ -42,7 +42,7 @@ The reciprocal circuit. -`abstract Reciprocal.sv_to_resvec(statevector, num_q)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") +`abstract Reciprocal.sv_to_resvec(statevector, num_q)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py "view source code") Convert statevector to result vector. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md index 545dc579533..a761e167b55 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution -`BernoulliDistribution(p, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") +`BernoulliDistribution(p, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md index 91cc535509c..748f3c73eab 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIn -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -35,7 +35,7 @@ Dependency between individual risk variables and latent variable is approximated -`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") +`GaussianConditionalIndependenceModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/gaussian_conditional_independence_model.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md index c8f212d4df1..4355ff2fc65 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") +`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md index 6b9bc9c32d7..dda3b6f9e05 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribut -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -29,7 +29,7 @@ This module contains the definition of a base class for multivariate distributio -`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`MultivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") ### build\_controlled @@ -129,7 +129,7 @@ returns number of qubits controlled -`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") +`static MultivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_distribution.py "view source code") pdf to probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md index b0da929a0d1..0c92d70e77c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormal -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") +`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_log_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md index 56b5c191c73..9b1ad691dd2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDis -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") +`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md index e9517faa06b..0c07823fa19 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDi -`MultivariateUniformDistribution(num_qubits, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution(num_qubits, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ Although this just results in a Hadamard gate on all involved qubits, the lower -`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") +`MultivariateUniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py "view source code") ### build\_controlled diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md index 82225843582..8b611c1f0c4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariation -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.multivariate_distribution.MultivariateDistribution` @@ -30,7 +30,7 @@ The Multivariate Variational Distribution. -`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") ### build\_controlled @@ -154,7 +154,7 @@ returns required ancillas controlled -`MultivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") +`MultivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.md index 574d76b9062..816a8c3ebc0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") +`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/normal_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md index 3d78ef0f430..0efcb0c9223 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel -`UncertaintyModel(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`UncertaintyModel(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -22,7 +22,7 @@ The abstract Uncertainty Model -`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") +`abstract UncertaintyModel.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uncertainty_model.py "view source code") Adds corresponding sub-circuit to given circuit diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.md index 7cca0f927c4..db8ec72852d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution -`UniformDistribution(num_target_qubits, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution(num_target_qubits, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ Uniform distribution is defined by the number of qubits that should be used to r -`UniformDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") ### build\_controlled @@ -153,7 +153,7 @@ list -`UniformDistribution.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas @@ -161,7 +161,7 @@ returns required ancillas -`UniformDistribution.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") +`UniformDistribution.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md index a7f59c743ae..098a1402e22 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistributio -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.uncertainty_model.UncertaintyModel`, `abc.ABC` @@ -33,7 +33,7 @@ This module contains the definition of a base class for univariate distributions -`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`UnivariateDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") ### build\_controlled @@ -133,7 +133,7 @@ returns number of qubits controlled -`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") +`static UnivariateDistribution.pdf_to_probabilities(pdf, low, high, num_values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_distribution.py "view source code") Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md index 040089b5059..c5acc1805cb 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariational -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution` @@ -30,7 +30,7 @@ The Univariate Variational Distribution. -`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") ### build\_controlled @@ -169,7 +169,7 @@ returns required ancillas controlled -`UnivariateVariationalDistribution.set_probabilities(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") +`UnivariateVariationalDistribution.set_probabilities(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/univariate_variational_distribution.py "view source code") Set Probabilities diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md index 7601ab629f2..d7d33f0762c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`MultivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`MultivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") +`MultivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/multivariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md index 250bbe128ad..88b518dfb92 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem -`UncertaintyProblem(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory`, `abc.ABC` @@ -147,7 +147,7 @@ returns required ancillas controlled -`UncertaintyProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") +`UncertaintyProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/uncertainty_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md index 63199cf7444..0252c577e63 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewise -`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective(num_state_qubits, min_state_value, max_state_value, breakpoints, slopes, offsets, f_min, f_max, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") Bases: `qiskit.aqua.utils.circuit_factory.CircuitFactory` @@ -42,7 +42,7 @@ $$ -`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") ### build\_controlled @@ -142,7 +142,7 @@ returns number of qubits controlled -`UnivariatePiecewiseLinearObjective.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") requires ancillas @@ -158,7 +158,7 @@ returns required ancillas controlled -`UnivariatePiecewiseLinearObjective.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") +`UnivariatePiecewiseLinearObjective.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_piecewise_linear_objective.py "view source code") value to estimation diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md index 795745b2220..2cee7d25a27 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -31,7 +31,7 @@ Constructor. -`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") Adds corresponding sub-circuit to given circuit @@ -140,7 +140,7 @@ returns number of qubits controlled -`UnivariateProblem.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") returns required ancillas @@ -156,7 +156,7 @@ returns required ancillas controlled -`UnivariateProblem.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") +`UnivariateProblem.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_problems/univariate_problem.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.md b/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.md index 56c44d14c26..a6f628f93f6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.components.variational_forms.VariationalForm -`VariationalForm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`VariationalForm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This method should initialize the module and use an exception if a component of -`abstract VariationalForm.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`abstract VariationalForm.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") Construct the variational form, given its parameters. @@ -45,7 +45,7 @@ A quantum circuit. -`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") returns entangler map @@ -53,7 +53,7 @@ returns entangler map -`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") +`static VariationalForm.validate_entangler_map(entangler_map, num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/variational_forms/variational_form.py "view source code") validate entangler map diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.md index 78d926e0bb7..52f300b1ca7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -140,7 +140,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -162,7 +162,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -182,7 +182,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -198,7 +198,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Permutes the qubits of the operator. @@ -222,7 +222,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -242,7 +242,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -258,7 +258,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -270,7 +270,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -294,7 +294,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -314,7 +314,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -336,7 +336,7 @@ The `LegacyBaseOperator` representing this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.md index b6368fa370e..08c02698d7b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op, fast=None, use_nx=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.md index e9783f821f1..1d28761a3f7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -35,7 +35,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -60,7 +60,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. @@ -85,7 +85,7 @@ The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. -`CircuitSampler.set_backend(backend, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") +`CircuitSampler.set_backend(backend, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/circuit_sampler.py "view source code") Sets backend with configuration. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.md index 2107b6a1d2d..804264fbf74 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.md index 87540049609..dce2cbcb935 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.md index fbc3778b8d2..be149136d09 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TBP stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.md index 217601fddc1..f4b3fe51472 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") +`EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.md index 54f196a9083..efede772208 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.md index 9fb3de17e9c..1cffa046041 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -95,7 +95,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -123,7 +123,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -143,7 +143,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -177,7 +177,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to the negation of self. -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -269,7 +269,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -285,7 +285,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -301,7 +301,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -403,7 +403,7 @@ The `LegacyBaseOperator` representing this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -419,7 +419,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.md index 67bc05bd33f..3304c4c1bb2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md index 8e276a706ab..f176beedf72 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.md index a3c8f15543f..5ad24fd7bff 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.md index 2b2083745e9..1235021c257 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.md index 6ac9cd1ce64..3fb5b235bb3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.aqua.operators.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.md index aca978cce4a..1357669efc6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.aqua.operators.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.md index a211e007991..e557805d407 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.md index 4a47649405a..88d453f3f7d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.md index eb85fc18bfa..67f3bef26cd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.md index d4ebaffdd5d..ca8eaabee5c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.md index 899b706f36e..f145817d2da 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.md index 1ed2fe426da..6b0d349e38b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.md index 115a7fef8a6..baa3f571a7c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.md index a902b5ae962..3665bc06a86 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.md index 2c755ac3ec0..5409b312c4f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.md index b8978323d97..9a156503c79 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -74,7 +74,7 @@ callable(param\_values) -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.md index 9a3aef0c97e..64476eeaabf 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.md index 55ab93c2325..cd419722bd4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.md index 31aa592b695..2484984c874 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Bases: `qiskit.aqua.operators.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.md index b1f14fb3936..0ad4946a2d5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/hessian_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.md index 6d7b8d64b4a..3a552c00d70 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") Bases: `qiskit.aqua.operators.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.md index e11efc85ae5..96c2f27fc2f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") Bases: `qiskit.aqua.operators.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.md index 1231b401a6e..e82979d6745 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/qfi_base.py "view source code") Bases: `qiskit.aqua.operators.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.md index 0a325af00ff..e163e07a261 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Bases: `abc.ABC` @@ -24,13 +24,13 @@ Constructor. -`abstract LegacyBaseOperator.chop(threshold, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.chop(threshold, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") ### construct\_evaluation\_circuit -`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.construct_evaluation_circuit(wave_function, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Build circuits to compute the expectation w\.r.t the wavefunction. @@ -38,7 +38,7 @@ Build circuits to compute the expectation w\.r.t the wavefunction. -`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evaluate_with_result(result, statevector_mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. @@ -46,7 +46,7 @@ Consume the result from the quantum computer to build the expectation, will be o -`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.evolve(state_in, evo_time, num_time_slices, expansion_mode, expansion_order, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Time evolution, exp^(-jt H). @@ -54,7 +54,7 @@ Time evolution, exp^(-jt H). -`abstract LegacyBaseOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Check Operator is empty or not @@ -62,7 +62,7 @@ Check Operator is empty or not -`abstract LegacyBaseOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") print details @@ -70,7 +70,7 @@ print details -`abstract LegacyBaseOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") +`abstract LegacyBaseOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/base_operator.py "view source code") Convert to new Operator format. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.md index d24a16a9769..ae1ad60213e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.MatrixOperator -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -34,13 +34,13 @@ Operators relevant for quantum applications -`MatrixOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### chop -`MatrixOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Eliminate the real and imagine part of coeff in each pauli by threshold. If pauli’s coeff is less then threshold in both real and imagine parts, the pauli is removed. To align the internal representations, all available representations are chopped. The chopped result is stored back to original property. Note: if coeff is real-only, the imag part is skipped. @@ -61,7 +61,7 @@ self or copy -`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.construct_evaluation_circuit(wave_function, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Construct the circuits for evaluation. @@ -86,7 +86,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`MatrixOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Get a copy of self. @@ -94,7 +94,7 @@ Get a copy of self. -`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_result(result, statevector_mode=True, use_simulator_snapshot_mode=None, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Use the executed result with operator to get the evaluated value. @@ -121,7 +121,7 @@ float -`MatrixOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Parameters** @@ -143,7 +143,7 @@ float -`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.evolve(state_in, evo_time=0, num_time_slices=0, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -172,7 +172,7 @@ numpy.array -`MatrixOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") Check Operator is empty or not. @@ -188,7 +188,7 @@ bool -`MatrixOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") **Returns** @@ -202,13 +202,13 @@ str -`MatrixOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") ### to\_opflow -`MatrixOperator.to_opflow()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") +`MatrixOperator.to_opflow()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/matrix_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.md index 58edb0b9a98..43ff09e9970 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.PauliGraph -`PauliGraph(paulis, mode='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") +`PauliGraph(paulis, mode='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/pauli_graph.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md index 65630538d2f..bf4012a9ea0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.weighted_pauli_operator.WeightedPauliOperator` @@ -373,7 +373,7 @@ bool -`TPBGroupedWeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Perform self \* other. @@ -395,7 +395,7 @@ the multiplied operator -`TPBGroupedWeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`TPBGroupedWeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -472,7 +472,7 @@ the simplified operator -`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.sorted_grouping(weighted_pauli_operator, method='largest-degree')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Largest-Degree First Coloring for grouping paulis. @@ -550,7 +550,7 @@ to op flow -`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") +`classmethod TPBGroupedWeightedPauliOperator.unsorted_grouping(weighted_pauli_operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/tpb_grouped_weighted_pauli_operator.py "view source code") Greedy and unsorted grouping paulis. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.md index 4130ae96338..4d1f948fa31 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `qiskit.aqua.operators.legacy.base_operator.LegacyBaseOperator` @@ -30,7 +30,7 @@ Weighted Pauli Operator -`WeightedPauliOperator.add(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.add(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self + other. @@ -51,7 +51,7 @@ operator -`WeightedPauliOperator.anticommute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.anticommute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Anti commutes with @@ -59,7 +59,7 @@ Anti commutes with -`WeightedPauliOperator.chop(threshold=None, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.chop(threshold=None, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminate the real and imagine part of weight in each pauli by threshold. If pauli’s weight is less then threshold in both real and imaginary parts, the pauli is removed. @@ -86,7 +86,7 @@ the operator is mutated. -`WeightedPauliOperator.commute_with(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.commute_with(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Commutes with @@ -94,7 +94,7 @@ Commutes with -`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Construct the circuits for evaluation, which calculating the expectation \. @@ -129,7 +129,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`WeightedPauliOperator.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self @@ -137,7 +137,7 @@ Get a copy of self -`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.WeightedPauliOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. @@ -166,7 +166,7 @@ float -`WeightedPauliOperator.evaluate_with_statevector(quantum_state)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluate_with_statevector(quantum_state)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -188,7 +188,7 @@ float -`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") **Parameters** @@ -212,7 +212,7 @@ dict -`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -242,7 +242,7 @@ The constructed circuit. -`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Carry out the eoh evolution for the operator under supplied specifications. @@ -271,7 +271,7 @@ The constructed QuantumCircuit. -`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_dict(dictionary, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: @@ -308,7 +308,7 @@ the operator created from the input dictionary. -`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_file(file_name, before_04=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Load paulis in a file to construct an Operator. @@ -329,7 +329,7 @@ the loaded operator. -`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod WeightedPauliOperator.from_list(paulis, weights=None, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Create a WeightedPauliOperator via a pair of list. @@ -355,7 +355,7 @@ operator -`WeightedPauliOperator.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check Operator is empty or not. @@ -371,7 +371,7 @@ bool -`WeightedPauliOperator.multiply(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.multiply(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self \* other, and the phases are tracked. @@ -391,7 +391,7 @@ the multiplied operator -`WeightedPauliOperator.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Print out the operator in details. @@ -407,7 +407,7 @@ str -`WeightedPauliOperator.reorder_paulis()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.reorder_paulis()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Reorder the paulis based on the basis and return the reordered paulis. @@ -423,7 +423,7 @@ the ordered paulis based on the basis. -`WeightedPauliOperator.rounding(decimals, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.rounding(decimals, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Rounding the weight. @@ -444,7 +444,7 @@ operator -`WeightedPauliOperator.simplify(copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.simplify(copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. @@ -468,7 +468,7 @@ the simplified operator -`WeightedPauliOperator.sub(other, copy=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.sub(other, copy=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Perform self - other. @@ -489,7 +489,7 @@ operator -`WeightedPauliOperator.to_dict()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_dict()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a dict in pauli representation. @@ -505,7 +505,7 @@ dict -`WeightedPauliOperator.to_file(file_name)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_file(file_name)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Save operator to a file in pauli representation. @@ -517,7 +517,7 @@ Save operator to a file in pauli representation. -`WeightedPauliOperator.to_opflow(reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`WeightedPauliOperator.to_opflow(reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") to op flow diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.md index 07bd6621292..fad511f194a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ TaperedWeightedPauliOperator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Get a copy of self. @@ -73,7 +73,7 @@ copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -89,7 +89,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Check the z2\_symmetries is empty or not. @@ -105,7 +105,7 @@ bool -`Z2Symmetries.taper(operator, tapering_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`Z2Symmetries.taper(operator, tapering_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -132,7 +132,7 @@ list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator -`static Z2Symmetries.two_qubit_reduction(operator, num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") +`static Z2Symmetries.two_qubit_reduction(operator, num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/weighted_pauli_operator.py "view source code") Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.check_commutativity.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.check_commutativity.md index 54ed6048178..f044f1c4180 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.check_commutativity.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.check_commutativity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.check_commutativity -`check_commutativity(op_1, op_2, anti=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`check_commutativity(op_1, op_2, anti=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Check the (anti-)commutativity between two operators. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.commutator.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.commutator.md index 00bc003bb8b..2fb07b3ba8b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.commutator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.commutator -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.covariance.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.covariance.md index a48f905b210..38c084d4946 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.covariance.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.covariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.covariance -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the covariance matrix element between two Paulis, given the measurement outcome. Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.evolution_instruction.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.evolution_instruction.md index 595de8a5493..b5f440de191 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.evolution_instruction.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.evolution_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.evolution_instruction -`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`evolution_instruction(pauli_list, evo_time, num_time_slices, controlled=False, power=1, use_basis_gates=True, shallow_slicing=False, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Construct the evolution circuit according to the supplied specification. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.kernel_F2.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.kernel_F2.md index 322f1a31046..105cbed0f81 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.kernel_F2.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.kernel_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.kernel_F2 -`kernel_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`kernel_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the kernel of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.measure_pauli_z.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.measure_pauli_z.md index 7893e39abcf..984b2df43ce 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.measure_pauli_z.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.measure_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z -`measure_pauli_z(data, pauli)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`measure_pauli_z(data, pauli)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Appropriate post-rotations on the state are assumed. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.pauli_measurement.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.pauli_measurement.md index 8a362afd9e7..caaa2a61858 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.pauli_measurement.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.pauli_measurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.pauli_measurement -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Add the proper post-rotation gate on the circuit. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.row_echelon_F2.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.row_echelon_F2.md index 00fcd91dd4a..4f7f5e24ce0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.row_echelon_F2.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.row_echelon_F2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 -`row_echelon_F2(matrix_in)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`row_echelon_F2(matrix_in)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Computes the row Echelon form of a binary matrix on the binary finite field diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md index 3e3ccffc3b4..1a240e4a0b3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") +`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/legacy/common.py "view source code") Compute the list of pauli terms for a single slice of the suzuki expansion following the paper [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf). diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.md index 2a15f7437f5..400e3845c24 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -96,7 +96,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -232,7 +232,7 @@ An `OperatorBase` equivalent to the negation of self. -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -308,7 +308,7 @@ A set of strings describing the primitives contained within the Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -368,7 +368,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.md index 234d33c0976..a21d9e5c3c4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -105,7 +105,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -133,7 +133,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ListOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -241,7 +241,7 @@ An `OperatorBase` equivalent to the negation of self. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -265,7 +265,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -285,7 +285,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -301,7 +301,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -317,7 +317,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -341,7 +341,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -361,7 +361,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -373,7 +373,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -395,7 +395,7 @@ The `LegacyBaseOperator` representing this Operator. -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -411,7 +411,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -423,7 +423,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -435,7 +435,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -451,7 +451,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.md index 0d44bd127d9..41ccfd150e1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -146,7 +146,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -328,7 +328,7 @@ A set of strings describing the primitives contained within the Operator. -`SummedOp.print_details()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.print_details()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Print out the operator in details. :returns: a formatted string describes the operator. :rtype: str @@ -336,7 +336,7 @@ Print out the operator in details. :returns: a formatted string describes the op -`SummedOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -398,7 +398,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parametrized PrimitiveOps (in that case, AquaError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -431,7 +431,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`SummedOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -469,7 +469,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.md index 50a67ce9a69..ed9579963e6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Bases: `qiskit.aqua.operators.list_ops.list_op.ListOp` @@ -144,7 +144,7 @@ A bool equal to the equality of self and other. -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -292,7 +292,7 @@ A set of strings describing the primitives contained within the Operator. -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -308,7 +308,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -352,7 +352,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.md index 0845d8186f3..972105875c3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -270,7 +270,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -286,7 +286,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -302,7 +302,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -346,7 +346,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -358,7 +358,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -370,7 +370,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -404,7 +404,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.md index c06b5d15c6f..db393ba67f0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -128,7 +128,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -230,7 +230,7 @@ An `OperatorBase` equivalent to the negation of self. -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -274,7 +274,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -306,7 +306,7 @@ The reduced `OperatorBase`. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -374,7 +374,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -386,7 +386,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -408,7 +408,7 @@ The `LegacyBaseOperator` representing this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -424,7 +424,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.md index 0e779e37344..0a29af1539e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -99,7 +99,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PauliOp.commutes(other_op)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.commutes(other_op)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns whether self commutes with other\_op. @@ -119,7 +119,7 @@ A bool equaling whether self commutes with other\_op -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -147,7 +147,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -167,7 +167,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -189,7 +189,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -249,7 +249,7 @@ An `OperatorBase` equivalent to the negation of self. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -293,7 +293,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -325,7 +325,7 @@ The reduced `OperatorBase`. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -369,7 +369,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -393,7 +393,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -405,7 +405,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -427,7 +427,7 @@ The `LegacyBaseOperator` representing this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -455,7 +455,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -467,7 +467,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md index 06bb537c7b0..c29f249d801 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive=None, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive=None, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -97,7 +97,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -125,7 +125,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -145,7 +145,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -167,7 +167,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -179,7 +179,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -191,7 +191,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -227,7 +227,7 @@ An `OperatorBase` equivalent to the negation of self. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -251,7 +251,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -271,7 +271,7 @@ An `OperatorBase` equivalent to self composed with itself exponent times. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -287,7 +287,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -303,7 +303,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -327,7 +327,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -347,7 +347,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -359,7 +359,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -371,7 +371,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -383,7 +383,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -405,7 +405,7 @@ The `LegacyBaseOperator` representing this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -421,7 +421,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -433,7 +433,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.md index 8fb7e91a1a3..15616f8ab35 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.aqua.operators.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -136,7 +136,7 @@ An Operator equivalent to the function composition of self and other. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -185,7 +185,7 @@ A bool equal to the equality of self and other. -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -231,7 +231,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -257,7 +257,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -365,7 +365,7 @@ The reduced `OperatorBase`. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -387,7 +387,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -431,7 +431,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -443,7 +443,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -477,7 +477,7 @@ The `LegacyBaseOperator` representing this Operator. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -489,7 +489,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Not defined. @@ -501,7 +501,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.md index a6291c4b3ea..2acb13e731d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -168,7 +168,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -188,7 +188,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -244,7 +244,7 @@ An `OperatorBase` equivalent to the negation of self. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -284,7 +284,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -300,7 +300,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -316,7 +316,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -328,7 +328,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -372,7 +372,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -384,7 +384,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -396,7 +396,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -408,7 +408,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -438,7 +438,7 @@ The `LegacyBaseOperator` representing this Operator. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.md index c7f657ffc46..7753ab1914e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -32,7 +32,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -146,7 +146,7 @@ A bool equal to the equality of self and other. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -204,7 +204,7 @@ An `OperatorBase` equivalent to the negation of self. -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -244,7 +244,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -298,7 +298,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -342,7 +342,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -354,7 +354,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -400,7 +400,7 @@ The `LegacyBaseOperator` representing this Operator. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -436,7 +436,7 @@ A VectorStateFn equivalent to self. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.md index d00c5e512aa..1e96869be1f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -384,7 +384,7 @@ The `LegacyBaseOperator` representing this Operator. -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -410,7 +410,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.md index 511b06e8ac4..f200f3a35ce 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Bases: `qiskit.aqua.operators.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -102,7 +102,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -128,7 +128,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -148,7 +148,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -170,7 +170,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -206,7 +206,7 @@ An `OperatorBase` equivalent to the negation of self. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -226,7 +226,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -246,7 +246,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -262,7 +262,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -278,7 +278,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -300,7 +300,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -324,7 +324,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -344,7 +344,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -368,7 +368,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_legacy_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_legacy_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. @@ -390,7 +390,7 @@ The `LegacyBaseOperator` representing this Operator. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -406,7 +406,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -426,7 +426,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.md index 1557aa5d657..afab35e8a34 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.aqua.operators.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -142,7 +142,7 @@ A bool equal to the equality of self and other. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -200,7 +200,7 @@ An `OperatorBase` equivalent to the negation of self. -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -240,7 +240,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -272,7 +272,7 @@ The reduced `OperatorBase`. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -294,7 +294,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -338,7 +338,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -350,7 +350,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -374,7 +374,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -412,7 +412,7 @@ The `LegacyBaseOperator` representing this Operator. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -428,7 +428,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.md index 17e5fc4f133..34b0a0e40f6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.CircuitFactory -`CircuitFactory(num_target_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory(num_target_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for CircuitFactories -`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`abstract CircuitFactory.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding sub-circuit to given circuit @@ -37,7 +37,7 @@ Adds corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds corresponding controlled sub-circuit to given circuit @@ -53,7 +53,7 @@ Adds corresponding controlled sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled inverse of corresponding sub-circuit to given circuit @@ -69,7 +69,7 @@ Adds controlled inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -77,7 +77,7 @@ Adds controlled, inverse, power of corresponding circuit. May be overridden if a -`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -85,7 +85,7 @@ Adds controlled power of corresponding circuit. May be overridden if a more effi -`CircuitFactory.build_inverse(qc, q, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse(qc, q, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse of corresponding sub-circuit to given circuit @@ -99,7 +99,7 @@ Adds inverse of corresponding sub-circuit to given circuit -`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_inverse_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -107,7 +107,7 @@ Adds inverse power of corresponding circuit. May be overridden if a more efficie -`CircuitFactory.build_power(qc, q, power, q_ancillas=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.build_power(qc, q, power, q_ancillas=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible @@ -115,7 +115,7 @@ Adds power of corresponding circuit. May be overridden if a more efficient imple -`CircuitFactory.get_num_qubits()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits @@ -123,7 +123,7 @@ returns number of qubits -`CircuitFactory.get_num_qubits_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.get_num_qubits_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns number of qubits controlled @@ -131,7 +131,7 @@ returns number of qubits controlled -`CircuitFactory.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas @@ -139,7 +139,7 @@ returns required ancillas -`CircuitFactory.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") +`CircuitFactory.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_factory.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.decimal_to_binary.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.decimal_to_binary.md index 2153d532f1b..d81c7ab4196 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.decimal_to_binary.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.decimal_to_binary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.decimal_to_binary -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") +`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/decimal_to_binary.py "view source code") decimal to binary diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_entangler_map.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_entangler_map.md index 98dce40194a..6688c0d7fac 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_feature_dimension.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_feature_dimension.md index 1e3d8b3fd86..fc479f9ddcd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_feature_dimension.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_feature_dimension.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_feature_dimension -`get_feature_dimension(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_feature_dimension(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check feature dimension of a given dataset diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_num_classes.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_num_classes.md index 8a64ebf33d8..2c8dd6c9f78 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_num_classes.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_num_classes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_num_classes -`get_num_classes(dataset)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`get_num_classes(dataset)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Check number of classes in a given dataset diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystem_density_matrix.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystem_density_matrix.md index 1a2fcb6ba63..c02f2daa6a9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystem_density_matrix.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystem_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix -`get_subsystem_density_matrix(statevector, trace_systems)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystem_density_matrix(statevector, trace_systems)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Compute the reduced density matrix of a quantum subsystem. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystems_counts.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystems_counts.md index 9ed8f0a7209..a261b5ac5bf 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystems_counts.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.get_subsystems_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.get_subsystems_counts -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") +`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/subsystem.py "view source code") Extract all subsystems’ counts from the single complete system count dictionary. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.has_aer.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.has_aer.md index 12bd62f9b51..13287411f4c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.has_aer.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.has_ibmq.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.has_ibmq.md index 142d0c3a78d..74cb7dc4057 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.has_ibmq.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.map_label_to_class_name.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.map_label_to_class_name.md index 9fbb70342c8..6a137e6d8ef 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.map_label_to_class_name.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.map_label_to_class_name.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.map_label_to_class_name -`map_label_to_class_name(predicted_labels, label_to_class)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`map_label_to_class_name(predicted_labels, label_to_class)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Helper converts labels (numeric) to class name (string) diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.name_args.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.name_args.md index f026fafa149..483e05bb658 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.name_args.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.optimize_svm.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.optimize_svm.md index 6672791b2d2..4aab2172ab5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.optimize_svm.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.optimize_svm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.optimize_svm -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") +`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/qp_solver.py "view source code") Solving quadratic programming problem for SVM; thus, some constraints are fixed. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h1_body.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h1_body.md index 0f5da87a287..873ec6b236a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h1_body.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h1_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h1_body -`random_h1_body(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h1_body(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random one body integrals. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h2_body.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h2_body.md index dce1537f2c9..bcf0b87393f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h2_body.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_h2_body.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_h2_body -`random_h2_body(N, M)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_h2_body(N, M)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random two body integrals. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_hermitian.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_hermitian.md index fb1930ce65b..c32ff001ef3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_hermitian.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_hermitian -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random hermitian (sparse) matrix with given properties. Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the eigenvalues due to truncation. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_non_hermitian.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_non_hermitian.md index 36ac0dd21c4..fd38a9e0867 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_non_hermitian.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_non_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_non_hermitian -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate random (sparse) matrix with given properties (singular values). Sparsity is achieved by truncating Pauli matrices. Sparsity settings alternate the singular values due to truncation. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_unitary.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_unitary.md index 88c40f6fc97..1419a02067a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.random_unitary.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.random_unitary -`random_unitary(N)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") +`random_unitary(N)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/random_matrix_generator.py "view source code") Generate a random unitary matrix with size NxN. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.reduce_dim_to_via_pca.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.reduce_dim_to_via_pca.md index 7291b17bff7..0f92ce45779 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.reduce_dim_to_via_pca.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.reduce_dim_to_via_pca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca -`reduce_dim_to_via_pca(x, dim)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`reduce_dim_to_via_pca(x, dim)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Reduce the data dimension via pca diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.split_dataset_to_data_and_labels.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.split_dataset_to_data_and_labels.md index 8b82cf9d567..f417b0083f6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.split_dataset_to_data_and_labels.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.split_dataset_to_data_and_labels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels -`split_dataset_to_data_and_labels(dataset, class_names=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") +`split_dataset_to_data_and_labels(dataset, class_names=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/dataset_helper.py "view source code") Split dataset to data and labels numpy array diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.summarize_circuits.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.summarize_circuits.md index 9964a8c031c..28dfaed6e31 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct.md index 505368993db..d39103d7884 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.tensorproduct -`tensorproduct(*args)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") +`tensorproduct(*args)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/tensor_product.py "view source code") Calculate tensor product. diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.validate_entangler_map.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.validate_entangler_map.md index 1a43fd00aed..d828b8fbfd6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.aqua.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md index f08a8c2467f..db0fe7be543 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.32/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.32/qiskit.assembler.assemble_circuits.md index 0b7badfe8e7..91302eba922 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.32/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.32/qiskit.assembler.assemble_schedules.md index 174896e6b6b..25ff21249a3 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md index acbe0abbd5d..d27cfe3c9e2 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md index d2285896e8f..362e19bbb2c 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.BosonicOperator -`BosonicOperator(h, basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator(h, basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ The Bosonic operator in this class is written in the n-mode second quantization -`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.direct_mapping_filtering_criterion(state, value, aux_values=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Filters out the states of irrelevant symmetries @@ -57,7 +57,7 @@ True if the state is has one and only one modal occupied per mode meaning that t -`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.mapping(qubit_mapping='direct', threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") Maps a bosonic operator into a qubit operator. @@ -82,7 +82,7 @@ A qubit operator -`BosonicOperator.number_occupied_modals_per_mode(mode)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") +`BosonicOperator.number_occupied_modals_per_mode(mode)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/bosonic_operator.py "view source code") A bosonic operator which can be used to evaluate the number of occupied modals in a given mode diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md index 8852f24734c..88871eb1517 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.FermionicOperator -`FermionicOperator(h1, h2=None, ph_trans_shift=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator(h1, h2=None, ph_trans_shift=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ The [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") class -`FermionicOperator.fermion_mode_elimination(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_elimination(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Eliminate modes. @@ -72,7 +72,7 @@ Fermionic Hamiltonian -`FermionicOperator.fermion_mode_freezing(fermion_mode_array)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.fermion_mode_freezing(fermion_mode_array)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Freezing modes and extracting its energy. @@ -94,7 +94,7 @@ tuple([FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.F -`FermionicOperator.mapping(map_type, threshold=1e-08)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.mapping(map_type, threshold=1e-08)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Map fermionic operator to qubit operator. @@ -121,7 +121,7 @@ create an Operator object in Paulis form. -`FermionicOperator.particle_hole_transformation(num_particles)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.particle_hole_transformation(num_particles)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") The ‘standard’ second quantized Hamiltonian can be transformed in the particle-hole (p/h) picture, which makes the expansion of the trail wavefunction from the HF reference state more natural. In fact, for both trail wavefunctions implemented in q-lib (‘heuristic’ hardware efficient and UCCSD) the p/h Hamiltonian improves the speed of convergence of the VQE algorithm for the calculation of the electronic ground state properties. For more information on the p/h formalism see: P. Barkoutsos, arXiv:1805.04340([https://arxiv.org/abs/1805.04340](https://arxiv.org/abs/1805.04340)). @@ -141,7 +141,7 @@ tuple -`FermionicOperator.total_angular_momentum()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_angular_momentum()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Total angular momentum. @@ -159,7 +159,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_magnetization()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_magnetization()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the magnetization of the given eigenstate. @@ -175,7 +175,7 @@ Fermionic Hamiltonian -`FermionicOperator.total_particle_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.total_particle_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") A data\_preprocess\_helper fermionic operator which can be used to evaluate the number of particle of the given eigenstate. @@ -191,7 +191,7 @@ Fermionic Hamiltonian -`FermionicOperator.transform(unitary_matrix)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") +`FermionicOperator.transform(unitary_matrix)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/fermionic_operator.py "view source code") Transform the one and two body term based on unitary\_matrix. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md index 7767ac98360..a2386ddd296 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.MP2Info -`MP2Info(qmolecule, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info(qmolecule, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Bases: `object` @@ -41,7 +41,7 @@ A utility class for MP2 info -`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_get_term_info(excitation_list, freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") With a reduced active space the set of used excitations can be less than allowing all available excitations. Given a (sub)set of excitations in the space this will return a list of correlation coefficients and a list of correlation energies ordered as per the excitation list provided. @@ -67,7 +67,7 @@ Tuple(list, list) -`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") +`MP2Info.mp2_terms(freeze_core=False, orbital_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/mp2info.py "view source code") Gets the set of MP2 terms for the molecule taking into account index adjustments due to frozen core and/or other orbital reduction diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md index e979a66297d..a35cd660fc7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QMolecule -`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule(filename=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Bases: `object` @@ -28,13 +28,13 @@ This class provides methods to save it and load it again from an HDF5 file -`QMolecule.Z(natom)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.Z(natom)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ### has\_dipole\_integrals -`QMolecule.has_dipole_integrals()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.has_dipole_integrals()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Check if dipole integrals are present. @@ -42,7 +42,7 @@ Check if dipole integrals are present. -`QMolecule.load()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.load()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") loads info saved. @@ -50,7 +50,7 @@ loads info saved. -`QMolecule.log()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.log()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") log properties @@ -58,7 +58,7 @@ log properties -`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.onee_to_spin(mohij, mohij_b=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert one-body MO integrals to spin orbital basis @@ -82,7 +82,7 @@ numpy.ndarray -`static QMolecule.oneeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.oneeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts one-body integrals from AO to MO basis @@ -105,7 +105,7 @@ numpy.ndarray -`QMolecule.remove_file(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.remove_file(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") remove file @@ -113,7 +113,7 @@ remove file -`QMolecule.save(file_name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`QMolecule.save(file_name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Saves the info from the driver. @@ -121,7 +121,7 @@ Saves the info from the driver. -`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoe_to_spin(mohijkl, mohijkl_bb=None, mohijkl_ba=None, threshold=1e-12)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Convert two-body MO integrals to spin orbital basis @@ -146,7 +146,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo(ints, moc)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo(ints, moc)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Converts two-body integrals from AO to MO basis @@ -169,7 +169,7 @@ numpy.ndarray -`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") +`static QMolecule.twoeints2mo_general(ints, moc1, moc2, moc3, moc4)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md index 44ca4ce3362..1e48cd816ea 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.QiskitChemistryError -`QiskitChemistryError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") +`QiskitChemistryError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qiskit_chemistry_error.py "view source code") Class for errors returned by Qiskit’s Chemistry module. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md index acff494f47e..cc29e688ef5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.WatsonHamiltonian -`WatsonHamiltonian(data, num_modes)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") +`WatsonHamiltonian(data, num_modes)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/watson_hamiltonian.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.md index 4a12aea1ebf..2c9ac46295f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.AdaptVQE -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -51,7 +51,7 @@ The expectation value of the given operator(s). The return type will be identica -`AdaptVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -63,7 +63,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`AdaptVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") +`AdaptVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/adapt_vqe.py "view source code") Computes the ground state. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.md index 7f9d388d608..b20341d7dc0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.md index 254c2c52a7a..e9d6ee9646a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.EigensolverFactory -`EigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`EigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a eigensolver based on a qubit operator transformation. -`abstract EigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") +`abstract EigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/eigensolver_factory.py "view source code") Returns a eigensolver, based on the qubit operator transformation. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md index 7dad604602c..3ce3db48c4e 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver -`ExcitedStatesEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via an Eigensolver algorithm -`ExcitedStatesEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") +`ExcitedStatesEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_eigensolver.py "view source code") Compute Ground and Excited States properties. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.md index e91e7836bc5..663ed080638 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver -`ExcitedStatesSolver`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`ExcitedStatesSolver` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The excited states calculation interface -`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") +`abstract ExcitedStatesSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/excited_states_solver.py "view source code") Compute the excited states energies of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.md index 02f4dbe380a..18e83d40eed 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver -`GroundStateEigensolver(transformation, solver)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver(transformation, solver)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_solver.GroundStateSolver` @@ -27,7 +27,7 @@ Ground state computation using a minimum eigensolver. -`GroundStateEigensolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Evaluates additional operators at the given state. @@ -48,7 +48,7 @@ The expectation value of the given operator(s). The return type will be identica -`GroundStateEigensolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -60,7 +60,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`GroundStateEigensolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") +`GroundStateEigensolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_eigensolver.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.md index 101256b9a3a..45cab346ef3 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.GroundStateSolver -`GroundStateSolver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`GroundStateSolver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ The ground state calculation interface -`abstract GroundStateSolver.evaluate_operators(state, operators)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.evaluate_operators(state, operators)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Evaluates additional operators at the given state. @@ -47,7 +47,7 @@ The expectation value of the given operator(s). The return type will be identica -`abstract GroundStateSolver.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Whether this class returns only the ground state energy or also the ground state itself. @@ -63,7 +63,7 @@ True, if this class also returns the ground state in the results object. False o -`abstract GroundStateSolver.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") +`abstract GroundStateSolver.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/ground_state_solver.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md index db1be79349d..eb9e42dbd54 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory -`MinimumEigensolverFactory`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`MinimumEigensolverFactory` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A factory to construct a minimum eigensolver based on a qubit operator transform -`abstract MinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns a minimum eigensolver, based on the qubit operator transformation. @@ -42,7 +42,7 @@ A minimum eigensolver suitable to compute the ground state of the molecule trans -`abstract MinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") +`abstract MinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md index e915859b2a4..c5759900f38 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.eigensolver_factories.eigensolver_factory.EigensolverFactory` @@ -29,7 +29,7 @@ A factory to construct a NumPyEigensolver. -`NumPyEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") +`NumPyEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/eigensolver_factories/numpy_eigensolver_factory.py "view source code") Returns a NumPyEigensolver with the desired filter diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md index f9cc83c2cc8..0587bb64afa 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -27,7 +27,7 @@ A factory to construct a NumPyMinimumEigensolver. -`NumPyMinimumEigensolverFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the `transformation`. @@ -47,7 +47,7 @@ A NumPyMinimumEigensolver suitable to compute the ground state of the molecule t -`NumPyMinimumEigensolverFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") +`NumPyMinimumEigensolverFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/numpy_minimum_eigensolver_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md index 0a0362652d0..1507f8c4edd 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.ground_state_eigensolver.GroundStateEigensolver` @@ -57,7 +57,7 @@ The expectation value of the given operator(s). The return type will be identica -`OrbitalOptimizationVQE.returns_groundstate()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.returns_groundstate()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Whether the eigensolver returns the ground state or only ground state energy. @@ -69,7 +69,7 @@ Whether the eigensolver returns the ground state or only ground state energy. -`OrbitalOptimizationVQE.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") +`OrbitalOptimizationVQE.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/orbital_optimization_vqe.py "view source code") Compute Ground State properties. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.md index 73920f5628b..2647a4e4f81 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEOM -`QEOM(ground_state_solver, excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM(ground_state_solver, excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Bases: `qiskit.chemistry.algorithms.excited_states_solvers.excited_states_solver.ExcitedStatesSolver` @@ -27,7 +27,7 @@ The calculation of excited states via the qEOM algorithm -`QEOM.solve(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") +`QEOM.solve(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/excited_states_solvers/qeom.py "view source code") Run the excited-states calculation. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.md index a80b38b913e..6e661775e3d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE -`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") +`QEomEE(operator, num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, active_occupied=None, active_unoccupied=None, is_eom_matrix_symmetric=True, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_ee.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.md index 3bdfaeaae9a..caac0014a78 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE -`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") +`QEomVQE(operator, var_form, optimizer, num_orbitals, num_particles, initial_point=None, max_evals_grouped=1, callback=None, qubit_mapping='parity', two_qubit_reduction=True, is_eom_matrix_symmetric=True, active_occupied=None, active_unoccupied=None, se_list=None, de_list=None, z2_symmetries=None, untapered_op=None, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/eigen_solvers/q_eom_vqe.py "view source code") Bases: `qiskit.aqua.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.md index 25460147fc0..06e893291e1 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt -`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt(operator, var_form_base, optimizer, initial_point=None, excitation_pool=None, threshold=1e-05, delta=1, max_iterations=None, max_evals_grouped=1, aux_operators=None, quantum_instance=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") Bases: `qiskit.aqua.algorithms.vq_algorithm.VQAlgorithm` @@ -79,7 +79,7 @@ dict -`VQEAdapt.get_optimal_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal circuit @@ -87,7 +87,7 @@ get optimal circuit -`VQEAdapt.get_optimal_cost()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_cost()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal cost @@ -95,7 +95,7 @@ get optimal cost -`VQEAdapt.get_optimal_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") +`VQEAdapt.get_optimal_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/minimum_eigen_solvers/vqe_adapt.py "view source code") get optimal vector diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.md index 8d20352d9dc..134cd6fbcdd 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory -`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -35,7 +35,7 @@ A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. -`VQEUCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns a VQE with a UCCSD wavefunction ansatz, based on `transformation`. This works only with a `FermionicTransformation`. @@ -59,7 +59,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") +`VQEUCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md index db186bdd442..fe9d34414fd 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Bases: `qiskit.chemistry.algorithms.ground_state_solvers.minimum_eigensolver_factories.minimum_eigensolver_factory.MinimumEigensolverFactory` @@ -31,7 +31,7 @@ A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction -`VQEUVCCSDFactory.get_solver(transformation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.get_solver(transformation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns a VQE with a UVCCSD wavefunction ansatz, based on `transformation`. This works only with a `BosonicTransformation`. @@ -51,7 +51,7 @@ A VQE suitable to compute the ground state of the molecule transformed by `trans -`VQEUVCCSDFactory.supports_aux_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") +`VQEUVCCSDFactory.supports_aux_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/ground_state_solvers/minimum_eigensolver_factories/vqe_uvccsd_factory.py "view source code") Returns whether the eigensolver generated by this factory supports auxiliary operators. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md index 9c6a5773253..7fd983696f2 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). -`BOPESSampler.sample(driver, points)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") +`BOPESSampler.sample(driver, points)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py "view source code") Run the sampler at the given points, potentially with repetitions. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md index 6e977f009de..ebb790bcde3 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolat -`DifferentialExtrapolator(degree=1, model=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator(degree=1, model=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`DifferentialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`DifferentialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Each parameter list and list of numerical gradients is treated as a single point in vector space. The regression model tries to fit a Hamiltonian that describes the evolution from one parameter set (and its gradient features) at point r, to another parameter set at point, r + epsilon. The regression model is then used to predict the parameter set at the point of interest. Note that this extrapolation technique does not explicitly use the spacing of the points (step size) but rather infers it from the list of parameter values. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md index 8d04afed4fd..eda9274f2b4 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline -`EnergySurface1DSpline`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` @@ -26,7 +26,7 @@ This allows for fitting BOPES sampler results or potential energy surfaces. -`EnergySurface1DSpline.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -46,7 +46,7 @@ Value of surface fit in point x. -`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Fits surface to data. @@ -65,7 +65,7 @@ Fits surface to data. -`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. :type scaling: `float` :param scaling: scaling factor @@ -81,7 +81,7 @@ equilibrium geometry -`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. :type scaling: `float` :param scaling: scaling factor @@ -97,7 +97,7 @@ minimum energy -`EnergySurface1DSpline.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") +`EnergySurface1DSpline.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/energy_surface_spline.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md index 589d66f534e..ecb8e7b2446 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase -`EnergySurfaceBase`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`EnergySurfaceBase` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a potential energy surface -`abstract EnergySurfaceBase.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -42,7 +42,7 @@ value of surface in point x -`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Fits surface to data @@ -61,7 +61,7 @@ Fits surface to data -`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the equilibrium energy. @@ -83,7 +83,7 @@ equilibrium geometry -`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the minimal energy. @@ -105,7 +105,7 @@ minimum energy -`abstract EnergySurfaceBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract EnergySurfaceBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Get the trust region. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md index 12098ea57e2..79f3c17b80d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator -`Extrapolator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`Extrapolator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ There are two types of Extrapolators: external/wrapper and internal. The externa -`abstract Extrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`abstract Extrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Abstract method to extrapolate point(s) of interest. @@ -47,7 +47,7 @@ Dictionary of variational parameters for extrapolated point(s). -`static Extrapolator.factory(mode, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`static Extrapolator.factory(mode, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Factory method for constructing extrapolators. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md index 7916ddc3e05..5c81143c12a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential -`HarmonicPotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -32,7 +32,7 @@ Input units are Angstroms (distance between the two atoms), and output units are -`HarmonicPotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the estimated dissociation energy for the current fit. @@ -52,7 +52,7 @@ estimated dissociation energy -`HarmonicPotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -72,7 +72,7 @@ value of potential in point x -`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Fits a potential to computed molecular energies. @@ -91,7 +91,7 @@ Fits a potential to computed molecular energies. -`static HarmonicPotential.fit_function(x, k, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`static HarmonicPotential.fit_function(x, k, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Functional form of the potential. @@ -114,7 +114,7 @@ harmonic potential functional form -`HarmonicPotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -130,7 +130,7 @@ fundamental frequency for the current fit -`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -170,7 +170,7 @@ maximum\_trusted\_level setted -`HarmonicPotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -214,7 +214,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`classmethod HarmonicPotential.process_fit_data(xdata, ydata)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`classmethod HarmonicPotential.process_fit_data(xdata, ydata)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") #### Mostly for internal use. Preprocesses the data passed to fit\_to\_data() @@ -237,7 +237,7 @@ the processed data that fit better to a harmonic potential -`HarmonicPotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Updates the underlying molecule. @@ -257,7 +257,7 @@ Updates the underlying molecule. -`HarmonicPotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -277,7 +277,7 @@ vibrational energy level for the current fit -`HarmonicPotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") +`HarmonicPotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/harmonic_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md index 39f5a6ac5fd..f00c34443a6 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential -`MorsePotential(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.PotentialBase` @@ -34,7 +34,7 @@ Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algor -`MorsePotential.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the calculated dissociation energy for the current fit. @@ -54,7 +54,7 @@ calculated dissociation energy for the current fit -`MorsePotential.eval(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.eval(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") After fitting the data to the fit function, predict the energy at a point x. @@ -74,7 +74,7 @@ value of surface in point x -`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fit(xdata, ydata, initial_vals=None, bounds_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Fits a potential to computed molecular energies. @@ -93,7 +93,7 @@ Fits a potential to computed molecular energies. -`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`static MorsePotential.fit_function(x, d_e, alpha, r_0, m_shift)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Functional form of the potential. @@ -117,7 +117,7 @@ potential functional form -`MorsePotential.fundamental_frequency()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.fundamental_frequency()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the fundamental frequency for the current fit (in s^-1). @@ -133,7 +133,7 @@ fundamental frequency for the current fit -`MorsePotential.get_equilibrium_geometry(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_equilibrium_geometry(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the interatomic distance corresponding to minimal energy. @@ -153,7 +153,7 @@ interatomic distance corresponding to minimal energy -`MorsePotential.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. @@ -173,7 +173,7 @@ maximum\_trusted\_level estimated -`MorsePotential.get_minimal_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.get_minimal_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the smallest molecular energy for the current fit. @@ -217,7 +217,7 @@ The potential will usually be well-defined (even if not useful) for arbitrary x -`MorsePotential.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Updates the underlying molecule. @@ -237,7 +237,7 @@ Updates the underlying molecule. -`MorsePotential.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the n-th vibrational energy level for the current fit (in Hartrees). @@ -257,7 +257,7 @@ vibrational energy level for the current fit -`MorsePotential.wave_number()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") +`MorsePotential.wave_number()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/morse_potential.py "view source code") Returns the wave number for the current fit (in cm^-1). diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md index b9c05c60048..826a345addf 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -34,7 +34,7 @@ Constructor. -`PCAExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PCAExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. This method transforms the parameters in PCA space before performing the internal extrapolation. The parameters are transformed back to regular space after extrapolation. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md index 67bf8bd84fa..3e3cb04837b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator -`PolynomialExtrapolator(degree=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator(degree=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -30,7 +30,7 @@ Constructor. -`PolynomialExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`PolynomialExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Extrapolation is based on a polynomial function/spline fitting with a user-specified degree. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md index 27e02c06513..362ee9caa30 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase -`PotentialBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase`, `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.VibronicStructureBase` @@ -22,7 +22,7 @@ Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of fr -`abstract PotentialBase.dissociation_energy(scaling=1.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract PotentialBase.dissociation_energy(scaling=1.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the dissociation energy (scaled by ‘scaling’) @@ -137,7 +137,7 @@ minimum energy -`PotentialBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") This (1D) potential represents a single vibrational mode @@ -149,7 +149,7 @@ This (1D) potential represents a single vibrational mode -`PotentialBase.get_trust_region()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`PotentialBase.get_trust_region()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. Redefine in derived classes if needed. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md index 2f59b46bb2c..4e0858f71f4 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -31,7 +31,7 @@ Constructor. -`SieveExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`SieveExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method finds a cutoff distance based on the maximum average distance or ‘gap’ between the average values of the variational parameters. This cutoff distance is used as a criteria to divide the parameters into two clusters by setting all parameters that are below the cutoff distance to zero. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md index 6a795448f01..23343a3d42a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase -`VibronicStructureBase(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Class to hold a molecular vibronic structure providing access to vibrational mod -`VibronicStructureBase.get_maximum_trusted_level(n=0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.get_maximum_trusted_level(n=0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. Default value of 100. Redefined where needed (see e.g. Morse). @@ -42,7 +42,7 @@ maximum\_trusted\_level setted -`abstract VibronicStructureBase.get_num_modes()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.get_num_modes()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the number of vibrational modes for the molecule. @@ -58,7 +58,7 @@ the number of vibrational modes -`VibronicStructureBase.update_molecule(molecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`VibronicStructureBase.update_molecule(molecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Wipe state if molecule changes, and check validity of molecule for potential. @@ -78,7 +78,7 @@ molecule used -`abstract VibronicStructureBase.vibrational_energy_level(n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") +`abstract VibronicStructureBase.vibrational_energy_level(n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/potentials/potential_base.py "view source code") Returns the n-th vibrational energy level for a given mode. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md index 681fb8420fb..434ae7bed14 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator -`WindowExtrapolator(extrapolator=None, window=2)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator(extrapolator=None, window=2)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Bases: `qiskit.chemistry.algorithms.pes_samplers.extrapolator.Extrapolator` @@ -29,7 +29,7 @@ Constructor. -`WindowExtrapolator.extrapolate(points, param_dict)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") +`WindowExtrapolator.extrapolate(points, param_dict)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/extrapolator.py "view source code") Extrapolate at specified point of interest given a set of variational parameters. Based on the specified window, a subset of the data points will be used for extrapolation. A default window of 2 points is used, while a value of zero indicates that all previous points will be used for extrapolation. This method defines the data window before performing the internal extrapolation. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.md b/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.md index 3d7e0169b30..705c3b2b0c3 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Molecular ground state energy chemistry application -`MolecularGroundStateEnergy.compute_energy(callback=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`MolecularGroundStateEnergy.compute_energy(callback=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Compute the ground state energy of the molecule that was supplied via the driver @@ -57,7 +57,7 @@ A molecular ground state result -`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") +`static MolecularGroundStateEnergy.get_default_solver(quantum_instance)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/applications/molecular_ground_state_energy.py "view source code") Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") :type quantum\_instance: `Union`\[`QuantumInstance`, `Backend`, `BaseBackend`] :param quantum\_instance: A Backend/Quantum Instance for the solver to run on diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md index efe575f1e23..42af0c7e1c5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis -`BosonicBasis`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Basis to express a second quantization Bosonic Hamiltonian. -`BosonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") +`BosonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md index 36779a993cf..ef39732a053 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") Bases: `qiskit.chemistry.components.bosonic_bases.bosonic_basis.BosonicBasis` @@ -34,7 +34,7 @@ This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) -`HarmonicBasis.convert(threshold=1e-06)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") +`HarmonicBasis.convert(threshold=1e-06)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/harmonic_basis.py "view source code") This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.md index 2ffac17ec3c..d9d4dcec315 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.HartreeFock -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -35,7 +35,7 @@ A Hartree-Fock initial state. -`HartreeFock.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") +`HartreeFock.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/hartree_fock.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.md index 2e0c0af3104..522b7cc0aa5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.initial_states.VSCF -`VSCF(basis)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF(basis)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Bases: `qiskit.aqua.components.initial_states.initial_state.InitialState` @@ -28,7 +28,7 @@ Creates an occupation number vector as defined in Ollitrault Pauline J., Chemica -`VSCF.construct_circuit(mode='circuit', register=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") +`VSCF.construct_circuit(mode='circuit', register=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/initial_states/vscf.py "view source code") Construct the statevector of desired initial state. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.md index 357ad749e4b..d1ef9c870cd 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.CHC -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -37,7 +37,7 @@ The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science -`CHC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") +`CHC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/chc.py "view source code") Construct the variational form, given its parameters. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.md index e709b18e9e7..c6cb6f62aa5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UCCSD -`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD(num_orbitals, num_particles, reps=1, active_occupied=None, active_unoccupied=None, initial_state=None, qubit_mapping='parity', two_qubit_reduction=True, num_time_slices=1, shallow_circuit_concat=True, z2_symmetries=None, method_singles='both', method_doubles='ucc', excitation_type='sd', same_spin_doubles=True, skip_commute_test=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -66,7 +66,7 @@ Constructor. -`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists(num_particles, num_orbitals, active_occ_list=None, active_unocc_list=None, same_spin_doubles=True, method_singles='both', method_doubles='ucc', excitation_type='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Computes single and double excitation lists. @@ -98,7 +98,7 @@ list -`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.compute_excitation_lists_singlet(double_exc, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Outputs the list of lists of grouped excitation. A single list inside is controlled by the same parameter theta. @@ -119,7 +119,7 @@ list -`UCCSD.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Construct the variational form, given its parameters. @@ -152,7 +152,7 @@ returns entangler map -`static UCCSD.group_excitations(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. @@ -173,7 +173,7 @@ tuple -`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.group_excitations_if_same_ao(list_de, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. @@ -194,7 +194,7 @@ list -`UCCSD.manage_hopping_operators()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.manage_hopping_operators()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Triggers the adaptive behavior of this UCCSD instance. This function is used by the Adaptive VQE algorithm. It stores the full list of available hopping operators in a so called “excitation pool” and clears the previous list to be empty. Furthermore, the depth is asserted to be 1 which is required by the Adaptive VQE algorithm. @@ -202,7 +202,7 @@ Triggers the adaptive behavior of this UCCSD instance. This function is used by -`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.order_labels_for_hopping_ops(double_exc, gde)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. @@ -223,7 +223,7 @@ list -`UCCSD.pop_hopping_operator()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.pop_hopping_operator()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pops the hopping operator that was added last. @@ -231,7 +231,7 @@ Pops the hopping operator that was added last. -`UCCSD.push_hopping_operator(excitation)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`UCCSD.push_hopping_operator(excitation)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Pushes a new hopping operator. @@ -243,7 +243,7 @@ Pushes a new hopping operator. -`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") +`static UCCSD.same_ao_double_excitation_block_spin(de_1, de_2, num_orbitals)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uccsd.py "view source code") Regroups the excitations that involve same spatial orbitals for example, with labeling. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.md index bee952ab726..f5d200aca47 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.components.variational_forms.UVCC -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Bases: `qiskit.aqua.components.variational_forms.variational_form.VariationalForm` @@ -34,7 +34,7 @@ This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Doub -`static UVCC.compute_excitation_lists(basis, degrees)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`static UVCC.compute_excitation_lists(basis, degrees)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Compute the list with all possible excitation for given orders @@ -59,7 +59,7 @@ List of excitation indexes in terms of modes and modals -`UVCC.construct_circuit(parameters, q=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.construct_circuit(parameters, q=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") Construct the variational form, given its parameters. @@ -85,7 +85,7 @@ Quantum Circuit a quantum circuit with given parameters -`UVCC.excitations_in_qubit_format()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") +`UVCC.excitations_in_qubit_format()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/variational_forms/uvcc.py "view source code") #### Gives the list of excitation indexes in terms of qubit indexes rather diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.md index 878f1ea509f..4061b4093bb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator -`ChemistryOperator`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for ChemistryOperator. -`ChemistryOperator.process_algorithm_result(algo_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`ChemistryOperator.process_algorithm_result(algo_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Takes the algorithm result and processes it as required, e.g. by combination of any parts that were classically computed, for the final result. @@ -42,7 +42,7 @@ Final chemistry result computed from the algorithm result -`abstract ChemistryOperator.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`abstract ChemistryOperator.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.md index c03444567c8..eb31d2657af 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.Hamiltonian -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.ChemistryOperator` @@ -55,7 +55,7 @@ Final chemistry result computed from the algorithm result -`Hamiltonian.run(qmolecule)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`Hamiltonian.run(qmolecule)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") run method diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.md index 32e2f1c0875..a8f9f08f3e0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult -`MolecularChemistryResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularChemistryResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.md index fd533f4dcab..e6b07622e9b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult -`MolecularExcitedStatesResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularExcitedStatesResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.md index 1302c42392b..2c4cd73fc6b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult -`MolecularGroundStateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult` @@ -68,7 +68,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`MolecularGroundStateResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether dipole moment is present in result or not @@ -80,7 +80,7 @@ Returns whether dipole moment is present in result or not -`MolecularGroundStateResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") +`MolecularGroundStateResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.md index bfb15314061..6ac9c24805a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.QubitMappingType -`QubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`QubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.md index d5c63c9d4f0..228ffac5f39 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.core.TransformationType -`TransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") +`TransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/hamiltonian.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.md index 39426cd2514..47f776191ca 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BaseDriver -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") +`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/base_driver.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.md index b5df8909308..7f58d2463e8 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BasisType -`BasisType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`BasisType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.md index 4da4e20d1af..8ec3e686c63 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.BosonicDriver -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry bosonic drivers. -`abstract BosonicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") +`abstract BosonicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.md index d79f936dd16..23caf4fba8b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FCIDumpDriver -`FCIDumpDriver(fcidump_input, atoms=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver(fcidump_input, atoms=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -39,7 +39,7 @@ A determinant based full configuration interaction program, Computer Physics Com -`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`static FCIDumpDriver.dump(q_mol, outpath, orbsym=None, isym=1)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Convenience method to produce an FCIDump output file. @@ -58,7 +58,7 @@ Convenience method to produce an FCIDump output file. -`FCIDumpDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") +`FCIDumpDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fcidumpd/fcidumpdriver.py "view source code") Constructs a QMolecule instance out of a FCIDump file. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.md index 174374675eb..3a4d06230a7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.FermionicDriver -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -33,7 +33,7 @@ Base class for Qiskit’s chemistry fermionic drivers. -`abstract FermionicDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`abstract FermionicDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.md index fe1cff4b4bf..37f1b1a1b71 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianDriver -`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver(config='# rhf/sto-3g scf(conventional)\\n\\nh2 molecule\\n\\n0 1\\nH 0.0 0.0 0.0\\nH 0.0 0.0 0.735\\n\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -37,7 +37,7 @@ This driver uses the Gaussian open-source Gaussian 16 interfacing code in order -`GaussianDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") +`GaussianDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussiandriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.md index 5b04ce5ae68..0f66d0991e1 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver -`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver(jcf='\\n#p B3LYP/cc-pVTZ Freq=(Anharm) Int=Ultrafine SCF=VeryTight\\n\\nCO2 geometry optimization B3LYP/cc-pVTZ\\n\\n0 1\\nC -0.848629 2.067624 0.160992\\nO 0.098816 2.655801 -0.159738\\nO -1.796073 1.479446 0.481721\\n\\n', logfile=None, molecule=None, basis='sto-3g', normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Bases: `qiskit.chemistry.drivers.bosonic_driver.BosonicDriver` @@ -34,7 +34,7 @@ Gaussian™ 16 forces driver. -`GaussianForcesDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") +`GaussianForcesDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_forces_driver.py "view source code") Runs driver to produce a WatsonHamiltonian output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.md index 5fc824ad1b9..6b7177cfdb7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogDriver -`GaussianLogDriver(jcf)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver(jcf)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver` @@ -36,7 +36,7 @@ This driver does not use Gaussian 16 interfacing code, as certain data such as f -`GaussianLogDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") +`GaussianLogDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_driver.py "view source code") Runs the driver to produce a result given the supplied job control file. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.md index 40d7a5481cd..0e112c3acbd 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.GaussianLogResult -`GaussianLogResult(log)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult(log)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This result allows access to selected data from the log file that is not availab -`GaussianLogResult.get_watson_hamiltonian(normalize=True)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") +`GaussianLogResult.get_watson_hamiltonian(normalize=True)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/gaussiand/gaussian_log_result.py "view source code") Get the force constants as a WatsonHamiltonian diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.md index 9582539afdb..64e565da608 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HDF5Driver -`HDF5Driver(hdf5_input='molecule.hdf5')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver(hdf5_input='molecule.hdf5')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -28,7 +28,7 @@ The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiski -`HDF5Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") +`HDF5Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.md index 6289aa7eb45..928663b500f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.HFMethodType -`HFMethodType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") +`HFMethodType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/fermionic_driver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.md index 410096c76a9..3de633535df 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.InitialGuess -`InitialGuess(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`InitialGuess(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.md index ec18e83e10f..5796d2cf1bf 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.Molecule -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ This module implements an interface for a driver-independent, i.e. generic molec -`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_angle(angle, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -56,7 +56,7 @@ end geometry -`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -76,7 +76,7 @@ end geometry -`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_distance(distance, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -96,7 +96,7 @@ end geometry -`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.absolute_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -116,7 +116,7 @@ end geometry -`classmethod Molecule.relative_bending(bend, geometry, atom_trio)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_bending(bend, geometry, atom_trio)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** @@ -136,7 +136,7 @@ end geometry -`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") +`classmethod Molecule.relative_stretching(perturbation, geometry, atom_pair)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/molecule.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.md index d0a06fbbb14..ddb4af9d64d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PSI4Driver -`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver(config='molecule h2 {\\n 0 1\\n H 0.0 0.0 0.0\\n H 0.0 0.0 0.735\\n}\\n\\nset {\\n basis sto-3g\\n scf_type pk\\n reference rhf\\n', molecule=None, basis='sto-3g', hf_method=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -35,7 +35,7 @@ See [http://www.psicode.org/](http://www.psicode.org/) -`PSI4Driver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") +`PSI4Driver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/psi4d/psi4driver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.md index 16d9f65e178..caea9901606 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PyQuanteDriver -`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver(atoms='H 0.0 0.0 0.0; H 0.0 0.0 0.735', units=, charge=0, multiplicity=1, basis=, hf_method=, tol=1e-08, maxiters=100, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -40,7 +40,7 @@ See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante -`PyQuanteDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") +`PyQuanteDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyquanted/pyquantedriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.md index f4c64cdc041..55b44e98b06 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.PySCFDriver -`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver(atom='H 0.0 0.0 0.0; H 0.0 0.0 0.735', unit=, charge=0, spin=0, basis='sto3g', hf_method=, conv_tol=1e-09, max_cycle=50, init_guess=, max_memory=None, molecule=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Bases: `qiskit.chemistry.drivers.fermionic_driver.FermionicDriver` @@ -42,7 +42,7 @@ See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) -`PySCFDriver.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") +`PySCFDriver.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/pyscfd/pyscfdriver.py "view source code") Runs driver to produce a QMolecule output. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.md index 469b40c1e2a..6b4dc597ca3 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.drivers.UnitsType -`UnitsType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") +`UnitsType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/units_type.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.md index 67d1f416cb9..1fb4cf470c9 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.BOPESSamplerResult -`BOPESSamplerResult(points, energies, raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult(points, energies, raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Creates an new instance of the result. :type points: `List`\[`float`] :param poi -`BOPESSamplerResult.point_results(point)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") +`BOPESSamplerResult.point_results(point)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/bopes_sampler_result.py "view source code") returns all results for a specific point. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.md index 767ebecf173..7a864fe5ae2 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.EigenstateResult -`EigenstateResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") +`EigenstateResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py "view source code") Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.md index 71c4ad2f861..8a0b96613b1 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.ElectronicStructureResult -`ElectronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` @@ -66,7 +66,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`ElectronicStructureResult.has_dipole()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_dipole()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether dipole moment is present in result or not @@ -78,7 +78,7 @@ Returns whether dipole moment is present in result or not -`ElectronicStructureResult.has_observables()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") +`ElectronicStructureResult.has_observables()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/electronic_structure_result.py "view source code") Returns whether result has aux op observables such as spin, num particles diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.md b/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.md index cddb6391c36..cc2af141495 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.results.VibronicStructureResult -`VibronicStructureResult(a_dict=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") +`VibronicStructureResult(a_dict=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py "view source code") Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.md index ce3d3d3d772..38002efdb4d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType -`BosonicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.md index 3127a618daa..f908cca5d33 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformation -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -29,7 +29,7 @@ A vibronic Hamiltonian operator representing the energy of the nuclei in the mol -`BosonicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") **Parameters** @@ -47,7 +47,7 @@ Dict of hopping operators, dict of commutativity types and dict of excitation in -`BosonicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. In the fermionic case the default filter ensures that the number of particles is being preserved. @@ -59,7 +59,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`BosonicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -79,7 +79,7 @@ An vibronic structure result. -`BosonicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Transformation to qubit operator from the driver diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.md index bb6afdb8bce..58c401fa05c 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.BosonicTransformationType -`BosonicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") +`BosonicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/bosonic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.md index 3ef9d847003..7b4deefdc79 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType -`FermionicQubitMappingType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicQubitMappingType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.md index 10bb4baa0fe..600ab26cb11 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformation -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `qiskit.chemistry.transformations.transformation.Transformation` @@ -35,7 +35,7 @@ A transformation from a fermionic problem, represented by a driver, to a qubit o -`FermionicTransformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -55,7 +55,7 @@ A tuple containing the hopping operators, the types of commutativities and the e -`FermionicTransformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -69,7 +69,7 @@ In the fermionic case the default filter ensures that the number of particles is -`FermionicTransformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -89,7 +89,7 @@ An electronic structure result. -`FermionicTransformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.md index 2ae6f6416e7..fffc7533ce6 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.FermionicTransformationType -`FermionicTransformationType(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") +`FermionicTransformationType(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/fermionic_transformation.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.md index db32514f369..57e0ad41d45 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.chemistry.transformations.Transformation -`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for transformation to qubit operators for chemistry problems -`abstract Transformation.build_hopping_operators(excitations='sd')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.build_hopping_operators(excitations='sd')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Builds the product of raising and lowering operators (basic excitation operators) @@ -40,7 +40,7 @@ Returns: -`Transformation.get_default_filter_criterion()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`Transformation.get_default_filter_criterion()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. For more information see also aqua.algorithms.eigen\_solvers.NumPyEigensolver.filter\_criterion. @@ -52,7 +52,7 @@ Returns a default filter criterion method to filter the eigenvalues computed by -`abstract Transformation.interpret(raw_result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.interpret(raw_result)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Interprets an EigenstateResult in the context of this transformation. @@ -72,7 +72,7 @@ An “interpreted” eigenstate result. -`abstract Transformation.transform(driver, aux_operators=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") +`abstract Transformation.transform(driver, aux_operators=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Transformation from the `driver` to a qubit operator. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md index 8cd7b485d02..d3b4f754286 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md index 634b2bed559..e53e9a58a06 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md index bf25a7cff82..6bd13e1cfce 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md index cf55bda3d15..43a6f8a46bd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md index eb392cf3a31..092856d8c38 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -220,7 +220,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Delay.md b/docs/api/qiskit/0.32/qiskit.circuit.Delay.md index 4c0eed62094..ad694b6169a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Add classical condition on register or cbit classical and value val. @@ -91,7 +91,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -199,7 +199,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -215,7 +215,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md index e05c34fb48b..02ce8f97850 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.Gate.md index 59769962af3..2f5a5fba5e6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -110,7 +110,7 @@ Add classical condition on register or cbit classical and value val. -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -208,7 +208,7 @@ reversed. -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -306,7 +306,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -326,7 +326,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md index 56dcacff5ea..df48ee72209 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Add classical condition on register or cbit classical and value val. @@ -83,7 +83,7 @@ Add classical condition on register or cbit classical and value val. -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -105,7 +105,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -129,7 +129,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -137,7 +137,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") DEPRECATED: use instruction.reverse\_ops(). @@ -155,7 +155,7 @@ reversed. -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -165,7 +165,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -189,7 +189,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -209,7 +209,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -229,7 +229,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md index 26139092e55..99238e090d4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -34,7 +34,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Add condition on classical register to all instructions. @@ -42,7 +42,7 @@ Add condition on classical register to all instructions. -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Measure.md b/docs/api/qiskit/0.32/qiskit.circuit.Measure.md index 700d91f1abc..a57e26f4f61 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md index 999790ae31b..da59ceeb105 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -175,7 +175,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md index 1d8ee50f6ce..235fa17e288 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md index f927e45c737..7828c4cbc07 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md index b94079d0c8b..2c06e2228f6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla_0: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -135,7 +135,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -154,7 +154,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -162,7 +162,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -189,7 +189,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -287,7 +287,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is None, applies to all. @@ -295,7 +295,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`QuantumCircuit.bind_parameters(values, value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values, value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -323,7 +323,7 @@ copy of self with assignment substitution. -`static QuantumCircuit.cast(value, _type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, _type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -331,7 +331,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -351,7 +351,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -359,7 +359,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -367,7 +367,7 @@ Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -375,7 +375,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -383,7 +383,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -391,7 +391,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -419,7 +419,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -474,7 +474,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -500,7 +500,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -520,7 +520,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -536,7 +536,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -544,7 +544,7 @@ Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.C -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -552,7 +552,7 @@ Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -560,7 +560,7 @@ Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -568,7 +568,7 @@ Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -576,7 +576,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -584,7 +584,7 @@ Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -592,7 +592,7 @@ Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -600,7 +600,7 @@ Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -608,7 +608,7 @@ Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -616,7 +616,7 @@ Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -624,7 +624,7 @@ Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -632,7 +632,7 @@ Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -640,7 +640,7 @@ Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate -`QuantumCircuit.decompose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -656,7 +656,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -682,7 +682,7 @@ qiskit.Instruction -`QuantumCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’. @@ -729,7 +729,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -803,7 +803,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -811,7 +811,7 @@ Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -839,7 +839,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -847,7 +847,7 @@ Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSw -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -867,7 +867,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -887,7 +887,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -907,7 +907,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -923,7 +923,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -943,7 +943,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -951,7 +951,7 @@ Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1077,7 +1077,7 @@ circuit.draw() -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1183,7 +1183,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1191,7 +1191,7 @@ Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSw -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1261,7 +1261,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1269,7 +1269,7 @@ Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1277,7 +1277,7 @@ Apply `MCU1Gate`. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1312,7 +1312,7 @@ qiskit.Instruction -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -1334,7 +1334,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured. @@ -1356,7 +1356,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). @@ -1364,7 +1364,7 @@ Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -1384,7 +1384,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -1394,7 +1394,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1406,7 +1406,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -1414,7 +1414,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -1422,7 +1422,7 @@ Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.Pha -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -1430,7 +1430,7 @@ Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.Pau -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -1457,7 +1457,7 @@ A circuit implementing this circuit raised to the power of `power`. -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -1484,7 +1484,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -1504,7 +1504,7 @@ List(tuple) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1524,7 +1524,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1551,7 +1551,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -1578,7 +1578,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -1586,7 +1586,7 @@ Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -1594,7 +1594,7 @@ Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XG -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -1602,7 +1602,7 @@ Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXG -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurement on all qubits if they are present. Deletes the ClassicalRegister that was used to store the values from these measurements if it is idle. @@ -1624,7 +1624,7 @@ Returns circuit with measurements removed when inplace = False. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -1652,7 +1652,7 @@ Reset q. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -1698,7 +1698,7 @@ the circuit with reversed bit order. -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -1742,7 +1742,7 @@ the reversed circuit. -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -1750,7 +1750,7 @@ Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -1758,7 +1758,7 @@ Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -1766,7 +1766,7 @@ Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -1774,7 +1774,7 @@ Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -1782,7 +1782,7 @@ Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -1790,7 +1790,7 @@ Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -1798,7 +1798,7 @@ Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -1806,7 +1806,7 @@ Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -2179,7 +2179,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -2333,7 +2333,7 @@ with attached instruction. -`QuantumCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of gate operations in circuit. @@ -2554,7 +2554,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -2562,7 +2562,7 @@ Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapG -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -2570,7 +2570,7 @@ Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -2578,7 +2578,7 @@ Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgG -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -2586,7 +2586,7 @@ Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -2594,7 +2594,7 @@ Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -2647,7 +2647,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -2668,7 +2668,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -2689,7 +2689,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -2697,7 +2697,7 @@ Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -2705,7 +2705,7 @@ Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -2713,7 +2713,7 @@ Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -2721,7 +2721,7 @@ Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -2850,7 +2850,7 @@ Apply unitary gate to q. -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -2866,7 +2866,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -2874,7 +2874,7 @@ Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -2882,7 +2882,7 @@ Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md index 631b64d0b63..722180a95cc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -39,7 +39,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md index fd6ea387a2e..19f2145d2f9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Reset.md b/docs/api/qiskit/0.32/qiskit.circuit.Reset.md index db36821fa59..d5ad125a0fa 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.md index 5575c46c0c3..cdc8153858e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -154,7 +154,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -302,7 +302,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -344,7 +344,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.md index ae94f80d436..fc8063c3c3d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -114,7 +114,7 @@ Add classical condition on register or cbit classical and value val. -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -298,7 +298,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -320,7 +320,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -356,7 +356,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 85a2a4729a6..690b52b4c36 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index c691288c43f..b79995d471d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.32/qiskit.circuit.library.AND.md index 648a2389ca2..7f2677e8362 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.md index 4a06432d594..4ab5adee456 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new barrier instruction. -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -45,7 +45,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Add classical condition on register or cbit classical and value val. @@ -53,7 +53,7 @@ Add classical condition on register or cbit classical and value val. -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.md index 23c145e9e74..b81d851ee9e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -36,7 +36,7 @@ Create a new 3-qubit controlled sqrt-X gate. -`C3SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C3X is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.md index 4f5eb579f84..dab626ac268 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.md index 0038fd79bca..53b513d6f96 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.md index f9854e01b74..d753960e13f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.md index ea639de97f0..eeb3a99ef58 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.md index db9ad0a42b4..516204a66dd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -70,7 +70,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.md index 82f2112954e..d7d969d902e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.md index 0e942b081ea..d5ed8c39cb4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.md index 292afa15c6c..c381a22dfd4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.md index 56c6b377137..a847c538920 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.md index 98942079f30..5276c1ecf8d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.md index 1202f7eeba0..a21a2548b47 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.md index da4776b973c..7970d7e8a25 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.md index 17ef47f3306..a5743476752 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.md index 43b3ad8715d..906ec5cb3ce 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.md index 7b91c381efd..36131fed814 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.md index a378b4b80a7..c4b531b53e8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.md index 52efb1bfa37..24b88e1940c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.md index e7e2290cfc7..a9d87e54627 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.md index 2e490ea940e..69c00e1915b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.md index a953a4e9416..39b77eced97 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.md index 46381f1c63b..1840acc87f7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.md index 148ac42d178..d85c1f18dd6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.md index f7a3859659a..70d9c94e621 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.md index 4bcb1e1beac..1e1629743b4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.md index f4e892c337c..5ca272dd016 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.md index 4d2d9169916..2587327f214 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.md index 5a745088e3c..0efc064dc8a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GR.md index 7209ecc0e08..88471addd14 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.md index 71aa083afec..d71317a0cd6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.md index 6cc06a24d47..af1b23cd589 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.md index 8466600f053..d664f0e14c8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.md index 3a9588f99c8..2508e7ae1f6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.md index f7bf6ce118e..f4e6f51982c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.md index d24f0a4df5b..35169041b9c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.md index 500b209d60c..941dfdc7e08 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.md index 1f5fe56e5ea..9349598046e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.md index ab0a4176c1d..3f44eb54c23 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.md index d94325bb24e..4b0f8fdac2f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.md index 2c236db1c10..10d4c612562 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.md index 3d904625192..dafb19123ec 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.md index 9bc4122037a..17aae70d925 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.md index 74928b7d27a..42a3793e589 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.md index 3a1185f373c..a73e1a3c7ba 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.md index 426d49f6834..a1f966647ea 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.md index aeeda9cf0d0..cad9befc265 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.md index bc67b7ca908..09bff9dc82a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.md index 74b06fd9380..ed6c036caa1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -56,7 +56,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.md index 18d5c37cb29..7e4aa6039f7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.md index 8dcdd3807ad..a89c06d33c9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.md index 935f91d10df..22d510c1ec4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.md index 0f11bf418ed..dc14bf47721 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.md index 00c1ed0cbf3..78cd4e05a36 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new measurement instruction. -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.md index def9356edec..d732503ade4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False, param_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.md index 488a4caa893..6487b4a9504 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/normal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.32/qiskit.circuit.library.OR.md index f3ee7c97b11..aaf0af23333 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.md index 5c5e6f8db3b..f21509e9eb3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.md index 8a71080853b..e57682cb532 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.md index 7119daf7f7a..43289d23126 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.md index 23ec50e1d93..1d8f43d9c66 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.md index 9a8009546db..f5a7b24e9d6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.md index fd53a6d8cab..32f9efd9359 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.md index 58771a39d73..166d3fa0577 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.md index 37c02d2d2de..2055bca25e9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 94a1cfd492e..2ae019ee8ba 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 20b10508163..93cf5d80a58 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.md index 2ada624c39e..764103c3df9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.md index cafd21b595a..fa44d5455a8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.md index 932311cba70..ebad93bf9dc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.md index 4545b2500a6..eda2a66ffb5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.md index 772c0116d6b..6ff2795c678 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.md index 0e3f7bac634..b425c7d26d2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.md index 0db3218bc97..88734afdf67 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.md index eab5fe55fe1..9579e5419c2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.md index 6e023f33c0f..83948311cde 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.md index 128c18dcf46..bd51856b2e0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.md index 2b46955c44e..88fd78628f6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.md index ef77affdaac..987786012e5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.md index 2f2035eae69..1f6ba208e32 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.md index fa44339fb50..0c6126f7086 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.md index e8244085f6b..30d6950547c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.md index 4cfbee61b1f..4593c6a22a4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.md index d38c6c1667b..3e2bbbcb12d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.md index 989de416035..2d3490388db 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.md index c20563ec423..6dd72cc2346 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new reset instruction. -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.md index c6a7b1e06cd..eedca638845 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.md index c657f0ee852..536757393e2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.md index a829101a023..8518ed4751c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.md index d913f0e62cd..2d08b505e5b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.md index f11d7eb6216..cc6e058caa2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.md index b8035708015..db12e700fda 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.md index d03585524b0..f611ea7a707 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.md index e3dbaeb72dd..80e87fb56a1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.md index 4f10c56dc2b..a78f7f2c8e2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.md index a9e5a1e7145..3e8ada96707 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.md index d908894c93e..20690138ae9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.md index 09a37c12208..b5a4cf7ed64 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.md index 07bb23f2d15..0c4ca373ef7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/probability_distributions/uniform.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.md index 25157118440..d89c12cca70 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.md index 7d5b28937ca..dd6717b85a0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.md index f18f5ae21b2..d07a7109f78 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.md index 43e734f066e..c4211df1578 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.md index 21f9a64cd0c..a82778ecd28 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.md index c576b3ad645..f979263538b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.md index d1e1747e332..5d76044f233 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.md index df1ea433e53..2f1552e5317 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1.md index 42cf538c532..22bd668f91f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2.md index 5bf66e9f98c..f2c5dd8fc10 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3.md index 927f19fa200..94d8dfa34f4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4.md index 8b16e2825d6..b22af4fca25 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1.md index 2c09082d230..4fba3a33436 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1.md index 07b3612de9c..ecf6ae0b847 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2.md index 36856209e49..3c8360c05de 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3.md index d0f5a22555e..b383502f2b2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4.md index 57ae97f2a84..d05d911fcf2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1.md index 570f78364e6..a13af44ea44 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1.md index a9b3cb55224..ab33af8a64c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2.md index 0a9966bb05d..5300850cc44 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3.md index c979ff290d7..9d98315d660 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4.md index e48a68c9e45..b60dac07ece 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5.md index 69364d28f8d..04add82fbe3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1.md index 4e11397bbef..5023943cd35 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2.md index 0485bc05efe..ced38daade6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3.md index feaaa81f23c..caa0eaa3b81 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.md index 6b4367232a1..22826237cef 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_cy.md index bae210512c6..5cee06c07dd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_xz.md index 6111e4b6d65..41579dc8e27 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_yz.md index f5feb56c245..a09251daecb 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1.md index f8a2218bc4b..cae37878081 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2.md index d4d76d03eb4..4771308c6ef 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3.md index 9ab0e123a91..92dcb301fc6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index fccc60c5901..6901ced3335 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index bc9dfac625c..79f50d36359 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 9a0f1d6e2e0..8275bd14b9d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index a099d56f93c..6a139dddd79 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 199b0ba73fb..af90757559d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index d8f119d2cde..6a7e2cbba0e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 645f993d038..64eb9dbc638 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index b29f66cbbd3..7d5f16134f9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index cdfab95456d..28a9def5e19 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 42e44c71ccb..38eb6fe0f01 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index f2bf2fb8ffd..bfa2880e791 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f5857f8be6d..7bc7fb49e7f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 54d796c48ea..3c958322aef 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 497c7f651c8..d7857911c5c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 05dd1473bf2..500c3f9542b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index bf4346c45e9..506e1f4c1e5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 143ce700b60..575584da1f5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index bddea475821..c21c0e0b10b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 1d23abdcba1..dfdf7f93c5e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 5e04b1587b2..31a4609876c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 7f827c64901..ad51542d5c9 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 5fd5601a5c9..e8b1fd4612d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index c8b3b9b383b..d6a37940f1a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 5e36d6a1208..86f78e9c92a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 1340401a8c0..88220d5de36 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 7d6a80af75b..b0ac097f194 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 9d72c54ca1a..19994762b62 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index cfb20db8ead..4e172dfcd3c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8f053052c41..bf49584b47e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 0dbc8a78f8c..406a990948d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 767dfc0dc71..4af3a1e4799 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index fbf1fac3a16..cbb0b73f437 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index e00e9a09031..d026edef43f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 51fafdebc96..e2d6bdcc984 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 7c6acba7de7..9bd4b84a326 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 23417772375..736756f7008 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 1f41755ea0a..4bd9eac06cd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index f66ad8c3ec1..d55f4e85b13 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 42e65f18b74..7d348ef65a4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index dcdd118e19e..5c506c0d1a2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 2eae01bb124..10b935ea263 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 4038dc3d507..83a8fd11254 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 705eded25a9..d07c214552b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4c845969dab..68996fb600e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index d55538e6a62..80d5f36a9d0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 4865ff7af80..ca902b97814 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 03d25edc1ff..f2a903e2504 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.dump.md b/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.dump.md index 6e832dbf55e..b5c5db7be06 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.dump.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.dump -`dump(circuits, file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`dump(circuits, file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.load.md b/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.load.md index 5df021c72c7..f3b81e96362 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.load.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.qpy_serialization.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.load -`load(file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") +`load(file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.32/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.32/qiskit.circuit.random.random_circuit.md index a18ffe33b88..dc1d7f1112c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.32/qiskit.compiler.assemble.md b/docs/api/qiskit/0.32/qiskit.compiler.assemble.md index 5ca3ef24c10..4fe7956f99a 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.32/qiskit.compiler.schedule.md b/docs/api/qiskit/0.32/qiskit.compiler.schedule.md index 8e7a6cffa9f..6788dfb4f20 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.32/qiskit.compiler.sequence.md b/docs/api/qiskit/0.32/qiskit.compiler.sequence.md index 5bfaf303b8b..4fceaa00aab 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.32/qiskit.compiler.transpile.md b/docs/api/qiskit/0.32/qiskit.compiler.transpile.md index 3102cf09b2e..485f96f1b66 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.32/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.32/qiskit.converters.ast_to_dag.md index a5725690dea..84e0af53bc1 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.32/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dag.md index 2b6257c0761..6e4c7d4498b 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dagdependency.md index 15a315afab9..ea1f2e076ca 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_gate.md index 9ec3011bd18..4ec8eb91504 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_instruction.md index 31bbae987b3..365c3528bfd 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.32/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.32/qiskit.converters.dag_to_circuit.md index 9fd5e9df0d5..e87a0827eee 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.32/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.32/qiskit.converters.dag_to_dagdependency.md index 1659bc658dd..40903d9c45a 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.32/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_circuit.md index 8bc14e76d3b..a95b2c1d722 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_dag.md index 340e3d702ef..87bb9458172 100644 --- a/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.32/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md index 494a5dfc982..54c4c701d79 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -112,7 +112,7 @@ the current max node -`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs, condition=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -139,7 +139,7 @@ the current max node -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -147,7 +147,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -155,7 +155,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -167,7 +167,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, edge_map=None, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -200,7 +200,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.compose_back(input_circuit, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose_back(input_circuit, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: use DAGCircuit.compose() instead. @@ -208,7 +208,7 @@ DEPRECATED: use DAGCircuit.compose() instead. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -218,7 +218,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -228,7 +228,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -240,7 +240,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGNodes. @@ -248,7 +248,7 @@ Returns set of the descendants of a node as DAGNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -272,7 +272,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -294,7 +294,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.extend_back(dag, edge_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.extend_back(dag, edge_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") DEPRECATED: Add dag at the end of self, using edge\_map. @@ -302,7 +302,7 @@ DEPRECATED: Add dag at the end of self, using edge\_map. -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -329,7 +329,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -337,7 +337,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -353,7 +353,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -361,7 +361,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -377,7 +377,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -385,7 +385,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -393,7 +393,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -407,7 +407,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGNodes. @@ -415,7 +415,7 @@ Returns the longest path in the dag as a list of DAGNodes. -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -423,7 +423,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -431,7 +431,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -439,7 +439,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -459,7 +459,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -471,7 +471,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -492,7 +492,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -500,7 +500,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -508,7 +508,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -516,7 +516,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -537,7 +537,7 @@ list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGNodes. @@ -545,7 +545,7 @@ Returns iterator of the predecessors of a node as DAGNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -553,7 +553,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as DAGNodes. @@ -569,7 +569,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -577,7 +577,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -585,7 +585,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -593,7 +593,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -609,7 +609,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -619,7 +619,7 @@ Add edges from predecessors to successors. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -635,7 +635,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -645,7 +645,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -653,7 +653,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a DAGNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -680,7 +680,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -698,7 +698,7 @@ Replace one node with dag. -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGNodes. @@ -706,7 +706,7 @@ Returns iterator of the successors of a node as DAGNodes. -`DAGCircuit.threeQ_or_more_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.threeQ_or_more_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3-or-more-qubit gates: (id, data). @@ -714,7 +714,7 @@ Get list of 3-or-more-qubit gates: (id, data). -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -722,7 +722,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -738,7 +738,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.topological_op_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -754,7 +754,7 @@ generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) -`DAGCircuit.twoQ_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.twoQ_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. @@ -762,7 +762,7 @@ Get list of 2-qubit gates. Ignore snapshot, barriers, and the like. -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -770,7 +770,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md index bb21501298e..5a90ee6e808 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md index bcd32521e05..a1b007467cd 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md index fa2fb46df2b..3b7a6b442e9 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md index f1bc71320da..8347f948010 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md index 6e95a5df69a..12f758d29b9 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -121,7 +121,7 @@ Add classical condition on register or cbit classical and value val. -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -177,7 +177,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -327,7 +327,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -335,7 +335,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md index b853a50324b..90caafc8c78 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -60,7 +60,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -111,7 +111,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. @@ -251,7 +251,7 @@ bool -`Initialize.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/quantum_initializer/initializer.py "view source code") Initialize instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md index d83db85713b..cc5cd584b18 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Add classical condition on register or cbit classical and value val. @@ -103,7 +103,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md index b465d1acd69..a77284cbebb 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -120,7 +120,7 @@ Add classical condition on register or cbit classical and value val. -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -128,7 +128,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -177,7 +177,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -235,7 +235,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -327,7 +327,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -335,7 +335,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md index ab5c5a443aa..ed05ecd5593 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.QiskitFinanceError -`QiskitFinanceError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") +`QiskitFinanceError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/exceptions.py "view source code") Class for errors returned by Qiskit’s finance module. diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md index 05de4ab6cb8..19f5413aa81 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelt -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -33,7 +33,7 @@ Constructor. -`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") Adds corresponding sub-circuit to given circuit @@ -142,7 +142,7 @@ returns number of qubits controlled -`EuropeanCallDelta.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas @@ -150,7 +150,7 @@ returns required ancillas -`EuropeanCallDelta.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") +`EuropeanCallDelta.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_delta.py "view source code") returns required ancillas controlled diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md index 392aea5a2ca..9f5b6d2a1bb 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpe -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -35,7 +35,7 @@ Constructor. -`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -144,7 +144,7 @@ returns number of qubits controlled -`EuropeanCallExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") returns required ancillas @@ -160,7 +160,7 @@ returns required ancillas controlled -`EuropeanCallExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") +`EuropeanCallExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/european_call_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md index 316c8b5f2a0..e04857292ee 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpec -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem` @@ -36,7 +36,7 @@ Constructor. -`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") Adds corresponding sub-circuit to given circuit @@ -145,7 +145,7 @@ returns number of qubits controlled -`FixedIncomeExpectedValue.required_ancillas()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas @@ -153,7 +153,7 @@ returns required ancillas -`FixedIncomeExpectedValue.required_ancillas_controlled()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.required_ancillas_controlled()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") returns required ancillas controlled @@ -161,7 +161,7 @@ returns required ancillas controlled -`FixedIncomeExpectedValue.value_to_estimation(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") +`FixedIncomeExpectedValue.value_to_estimation(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py "view source code") value to estimate diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.md index fb1cdeb326d..5540c469166 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.BaseDataProvider -`BaseDataProvider`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ To use the subclasses, please see [https://github.com/Qiskit/qiskit-tutorials/bl -`BaseDataProvider.get_coordinates()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_coordinates()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns random coordinates for visualisation purposes. @@ -38,7 +38,7 @@ Returns random coordinates for visualisation purposes. -`BaseDataProvider.get_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns the covariance matrix. @@ -58,7 +58,7 @@ an asset-to-asset covariance matrix. -`BaseDataProvider.get_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -78,7 +78,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_covariance_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_covariance_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -98,7 +98,7 @@ a per-asset mean vector. -`BaseDataProvider.get_period_return_mean_vector()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_period_return_mean_vector()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns a vector containing the mean value of each asset. @@ -118,7 +118,7 @@ a per-asset mean vector. -`BaseDataProvider.get_similarity_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`BaseDataProvider.get_similarity_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Returns time-series similarity matrix computed using dynamic time warping. @@ -138,7 +138,7 @@ an asset-to-asset similarity matrix. -`abstract BaseDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`abstract BaseDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Loads data. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.md index 94753becaed..ad9fb1dd4b5 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.DataOnDemandProvider -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -144,7 +144,7 @@ an asset-to-asset similarity matrix. -`DataOnDemandProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") +`DataOnDemandProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/data_on_demand_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.md index e1cc0617a79..d67f4ff88e0 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.ExchangeDataProvider -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -143,7 +143,7 @@ an asset-to-asset similarity matrix. -`ExchangeDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") +`ExchangeDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/exchange_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.md index 1bcbc4c4948..4d6bbfd435a 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.RandomDataProvider -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -140,7 +140,7 @@ an asset-to-asset similarity matrix. -`RandomDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") +`RandomDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/random_data_provider.py "view source code") Generates data pseudo-randomly, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.md index 52aba5452c7..4828fddcb3f 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.StockMarket -`StockMarket(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") +`StockMarket(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/_base_data_provider.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.md index f19acad7323..54b205c6808 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.WikipediaDataProvider -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`WikipediaDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") +`WikipediaDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/wikipedia_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.md index 2ee584d5c10..f205961b05b 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.finance.data_providers.YahooDataProvider -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Bases: `qiskit.finance.data_providers._base_data_provider.BaseDataProvider` @@ -142,7 +142,7 @@ an asset-to-asset similarity matrix. -`YahooDataProvider.run()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") +`YahooDataProvider.run()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/data_providers/yahoo_data_provider.py "view source code") Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.md index dd9d483900a..35f05b36244 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.md index d0f88c08567..0d3fdafef06 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.md index 90e5c8b58f0..7aec65b5119 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.md index fd940e7ee8c..d5e4b734fc6 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.md index c71f6cc0b9a..8d56ebaf63c 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.md index 1cec73b08a3..419df9ac5b1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.md index 2242b5d8764..c057d7d091d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.md index d02ec6dd010..a155df678ed 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.md index c18ff34c92c..2ffb7fe61bb 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.md index 46efe0157ed..5a997c28987 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.md index b7627d45203..b011b738b4d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.md index 3a8aa5098ec..ae5f847fa56 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 8aee6e83ae9..c18616bb89b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_cx_circuits.md index 4314a0bf66b..dca2d2fc5d8 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_1Q_circuits.md index 96c0ac8dce4..a2a0d92a44b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_cx_circuits.md index fae2ef72cb7..247b20d2dc2 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.drag_schedules.md index 7a064bbe13f..90b4a0cb579 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.get_single_q_pulse.md index 0da9a5a79f9..66b7019cf05 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.rabi_schedules.md index 77a15744bbb..d189a2957db 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.t1_circuits.md index e7e4301ac50..0b8b5e93f76 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2_circuits.md index d1ff2dea23a..a44eb4e7dff 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2star_circuits.md index 8c6fec17c14..a8aac9916f4 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.update_u_gates.md index 29c1b537f61..edc7b426eab 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.32/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.characterization.zz_circuits.md index 1f4c9fbc60d..666ac4215e5 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.md index 3922362b0f9..b41fdc9b1dc 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.md index 033560eff61..56e9976dfe2 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.md index 54364b12efc..c695dc4b508 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.md index 8584a3a690f..49fe9e2c3c1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.md index 40d7957630a..4b6c2e26112 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.md index ba4bd514893..387f010961b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 3d6f722a7e0..452e3277c6d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.md index 93de99f8d05..eba4d8a9ad6 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 334088e40ef..d3bcce556c0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0ca0b7b67c0..b3cb9710f5c 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.md index 0f3bba86927..d072e158644 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index 57a69ef51fa..2f83a375cb5 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.md index 4bc47d26b5b..a69d4e77ba6 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 49e3ba02622..15cd48b959a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.md index 2b0a1ce3bd7..d4b3fe51512 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md index a4bb48a9b8e..ed39147d0d5 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.complete_meas_cal.md index 744a88e8a2b..1d4c9749bf3 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expectation_value.md index 5ba83e1a0c4..44a6349bfdf 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index 44c9f5a85e8..004c89c04e2 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.tensored_meas_cal.md index 3a447011701..1f9540672f9 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.md index 5dc44ca0492..2b8d0b699ec 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -55,7 +55,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.md index 4d41f6e5e23..0577877a3bf 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence @@ -36,7 +36,7 @@ This function computes the bound on variation distance based and the confidence -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single protocol run of accreditation protocol on simul backend diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.md index 01718a5447a..854522ad63e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.md index 7f5ca421e29..ccacdd777f0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedral -`CNOTDihedral(data, validate=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral(data, validate=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator` @@ -29,7 +29,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate transpose of the CNOTDihedral element @@ -37,7 +37,7 @@ Return the conjugate transpose of the CNOTDihedral element -`CNOTDihedral.cnot(i, j)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.cnot(i, j)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. @@ -45,7 +45,7 @@ Apply a CNOT gate to this element. Left multiply the element by CNOT\_\{i,j}. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the composed operator. @@ -76,7 +76,7 @@ Composition (`@`) is defined as left matrix multiplication for matrix operators. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the conjugate of the CNOTDihedral element. @@ -92,7 +92,7 @@ Make a deep copy of current operator. -`CNOTDihedral.dot(other, qargs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.dot(other, qargs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the right multiplied operator self \* other. @@ -118,7 +118,7 @@ The operator self \* other. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: other tensor self. @@ -138,7 +138,7 @@ the tensor product operator: other tensor other. -`CNOTDihedral.flip(i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.flip(i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply X to this element. Left multiply the element by X\_i. @@ -146,7 +146,7 @@ Apply X to this element. Left multiply the element by X\_i. -`CNOTDihedral.from_circuit(circuit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.from_circuit(circuit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -178,7 +178,7 @@ Return tuple of input dimension for specified subsystems. -`CNOTDihedral.is_cnotdihedral()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.is_cnotdihedral()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return True if input is a CNOTDihedral element. @@ -194,7 +194,7 @@ Return tuple of output dimension for specified subsystems. -`CNOTDihedral.phase(k, i)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.phase(k, i)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Apply an k-th power of T to this element. Left multiply the element by T\_i^k. @@ -252,7 +252,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the tensor product operator: self tensor other. @@ -272,7 +272,7 @@ the tensor product operator: self tensor other. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -297,7 +297,7 @@ Decompose 1 and 2-qubit CNOTDihedral elements. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -305,7 +305,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -313,7 +313,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Convert to an Operator object. @@ -321,7 +321,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/dihedral.py "view source code") Return the transpose of the CNOT-Dihedral element. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.md index 754b7eacb30..8b2163e96d9 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md index b18f6f79193..d7854d7e13b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.md index 62ed38a919d..cb084321e40 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. @@ -56,7 +56,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -76,7 +76,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -96,7 +96,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -120,7 +120,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.md index e82966c03c0..5be47257523 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md index 3d42ae904cb..087a91924f8 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.md index b74bafa3b11..41820f2d520 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.md index 751d05ee71f..92bd314c40e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md index 0eee1191e89..246b85719a1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts.md index fe011e399c6..f91bdff3ebe 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.md index 1454540bb20..55810cc5d2f 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.md index 397eae2c7c4..d43065093ae 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md index a7421af715c..9c90d276cbf 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -47,7 +47,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -71,7 +71,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -79,7 +79,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(reset=True, barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(reset=True, barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -92,7 +92,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.md index 69e323d90d6..80681d4d48a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.md index 9ec254be6af..8a8b513d769 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epc.md index cfdab2fd85b..ec0a1f4cd25 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epg.md index 1b2f96bb99a..9669d4fdaaa 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epc.md index b5bb6bf8309..7daeb05be5f 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epg.md index facf7d5b643..aea84c5fcf3 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.coherence_limit.md index 0d135b85af3..a4561c1d673 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.combine_counts.md index 95d1c15924f..9e9c4a228d5 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z.md index 430c5a64a9f..21d9ae63350 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z_expvalue.md index bc5a0956aac..2052156a57a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.count_gates.md index ef90a823e16..07f831c3108 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.count_keys.md index 45818240dba..0b0c5bf1406 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.expectation_counts.md index 0f52b196cd2..4070de77231 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.gates_per_clifford.md index 45877c80d49..e8067cff023 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.gateset_tomography_circuits.md index d7e9e5cdd5c..55ed9e4312e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc.md index 53f1e38d070..636fb281cd3 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc_para.md index d14912cb064..1c46ceaf5c7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po.md index facd849e662..5559ce0bd9f 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po_para.md index 8118f0f1438..9d6f0e0ecc7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_simple.md index f66325ec0e0..b8bc631f32d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.lookuptable_decoding.md index c78ef327870..371bd25152e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.marginal_counts.md index cc2f9087a12..ed262d5808b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.ordered_list_generator.md index 12eba09e677..4e3a4127e49 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.postselection_decoding.md index 56c05ff9cd9..0d3a2bacb3d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.process_tomography_circuits.md index 65d65c19f98..4129f2382d1 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.qv_circuits.md index 5e6fd01c6bd..789b93063eb 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.randomized_benchmarking_seq.md index 320b0d047bb..cb20840408d 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.rho_to_fidelity.md index ec6a875a999..e8e210b1ed5 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.state_tomography_circuits.md index 83b6bfdffff..04fac803474 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.twoQ_clifford_error.md index 7026900f3fd..74862bfe993 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.md b/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.md index 967dc980ea8..0bba8af45a7 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.md +++ b/docs/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.circuit.library.RawFeatureVector -`RawFeatureVector(feature_dimension)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector(feature_dimension)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -123,7 +123,7 @@ a handle to the instruction that was just added -`RawFeatureVector.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Call the initialize instruction. @@ -139,7 +139,7 @@ Apply `Barrier`. If qargs is None, applies to all. -`RawFeatureVector.bind_parameters(values)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") +`RawFeatureVector.bind_parameters(values)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/circuit/library/raw_feature_vector.py "view source code") Bind parameters. diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.ad_hoc_data.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.ad_hoc_data.md index f53d2f592c9..62287e8e01e 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.ad_hoc_data.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.ad_hoc_data -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns ad hoc dataset diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.breast_cancer.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.breast_cancer.md index bfb5399794a..0f2e4f68c0d 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.breast_cancer.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.breast_cancer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.breast_cancer -`breast_cancer(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") +`breast_cancer(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/breast_cancer.py "view source code") returns breast cancer dataset diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.digits.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.digits.md index bda77e505f7..5051eca90a4 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.digits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.digits -`digits(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") +`digits(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/digits.py "view source code") returns digits dataset diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.gaussian.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.gaussian.md index 6a901751ab5..bb771c06946 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.gaussian -`gaussian(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") +`gaussian(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/gaussian.py "view source code") returns gaussian dataset diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.iris.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.iris.md index 6af1aa464cf..a80976650bd 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.iris.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.iris -`iris(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") +`iris(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/iris.py "view source code") returns iris dataset diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.sample_ad_hoc_data.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.sample_ad_hoc_data.md index d83ed7a2041..a17cccedf42 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.sample_ad_hoc_data.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.sample_ad_hoc_data.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.sample_ad_hoc_data -`sample_ad_hoc_data(sample_total, test_size, n)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") +`sample_ad_hoc_data(sample_total, test_size, n)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/ad_hoc.py "view source code") returns sample ad hoc data diff --git a/docs/api/qiskit/0.32/qiskit.ml.datasets.wine.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.wine.md index 5713bd323fd..9294eb3d8e4 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.wine.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ml.datasets.wine -`wine(training_size, test_size, n, plot_data=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") +`wine(training_size, test_size, n, plot_data=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/ml/datasets/wine.py "view source code") returns wine dataset diff --git a/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.md index 56fc97fec81..0773653dca8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -194,7 +194,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -210,7 +210,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -234,7 +234,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -250,7 +250,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -262,7 +262,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -286,7 +286,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -306,7 +306,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -318,7 +318,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -334,7 +334,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -346,7 +346,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md index 28c74b79a54..815ea7ecdde 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.32/qiskit.opflow.anti_commutator.md index 3898db790be..85f54d4274f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.commutator.md b/docs/api/qiskit/0.32/qiskit.opflow.commutator.md index fee5b93b02a..d2172385ff8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.md index a00d134ed2c..7ef1f6a17ab 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.md index f2d2e759eed..0a26367547b 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.md index e3684e8963c..ff8184df7d4 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.md index 72f672de34f..573cf535bb1 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.md index 325cb11c1d4..a0e53dbd895 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.md index 93a5e86999e..f2e0bf2a7d2 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md index 4bdc73dda07..b683221f214 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.md index bba55129dca..4fa5d784a81 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.md index ae71ca2719c..54addd5040b 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.md index 4e93b0b8f51..0600758b9f7 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.md index 8993a5179ad..a155c64b246 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c8094df0d06..7be00afa27c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.md index 78ae73fad20..acf94d9f7f3 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.md index e846c732386..2f1524def39 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.md index e781c2e76c8..a33d03b8132 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.md index 95c23779df5..ca6f0b7f2ca 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.md index 161563dd794..dd6c75a56ac 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.md index 79cea305c20..b1225040f62 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.md index 5975abbdf52..5e9dfcf4211 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.md index 33966301d47..b5a981655a4 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.md index afcaea6d4a0..3a013bc4cdd 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.md index f6b8202b43d..79427656c9e 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.md index c07db9f3256..c0b89e29978 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.md index d6afd8ebc0b..0d9fc2a38a1 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.md index f375c3475b6..6b3474abd7c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.md index 598fc181127..20bfc03a64d 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.md index 850df331191..0e6796aed84 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.md index 8d79589afe0..75514ddeefd 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.md index 352d43dd268..3b55901f378 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.md index f4ac8a832c8..e81a6901eab 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.md index 11e541cabb8..78c8e24e3e3 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.md index 08944253b50..68b117566d3 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.md index 407fe1b1b01..15e5bb9139f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.md index 03cc0694b50..2fcddfb0d4e 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.md index 7f1a289097d..2b91bd07914 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.md index 1d21cfa23b8..107a83d4489 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.md index 773dac11de7..a9b207588fd 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.md index 38ff1eda070..2d0c23c165a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.md index 2b3d38ad8d7..462397fa0d4 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.md index a6a95e2a19d..1b5d915c986 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.md index 27e7660a535..f34c50c98a2 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backend by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -183,7 +183,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -205,7 +205,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -249,7 +249,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -265,7 +265,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -286,7 +286,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -310,7 +310,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -322,7 +322,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -338,7 +338,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -350,7 +350,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.md index adc7134555c..82498bf1023 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index e79d5a51100..2cab71b234e 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.md index 7b5e72bf7c5..5d5d896f45c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -65,7 +65,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -81,7 +81,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -89,7 +89,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.md index e4d35b103db..4f8ca4cb019 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.md index e1dd3b4e91f..0f322c553c8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.md index 9206389fb7c..d8cf52cf557 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.md index 33a6664f407..94f60abcd8a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.md index 5e032defd82..039a65f1aed 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.md index 315df2f89ad..a61562894fe 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.md index 5e6a01d2378..d8f21000943 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md index 9372d7fff09..8fe6bc0d377 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QiskitOptimizationError -`QiskitOptimizationError(*message)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") +`QiskitOptimizationError(*message)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/exceptions.py "view source code") Class for errors returned by Qiskit’s optimization module. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md index bdaf05c904f..0dc04028355 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.md index 3c0ddee770b..52040836598 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult -`ADMMOptimizationResult(x, fval, variables, state, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizationResult(x, fval, variables, state, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.md index 8c263ce4d89..16b8400a0a4 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMOptimizer -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -36,7 +36,7 @@ Optimization on Classical and Quantum Computers. arXiv preprint arXiv:2001.02069 -`ADMMOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -80,7 +80,7 @@ Returns True if the problem is compatible, False otherwise. -`ADMMOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Tries to solves the given problem using ADMM algorithm. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.md index 023564a13d5..d3f3337be92 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMParameters -`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMParameters(rho_initial=10000, factor_c=100000, beta=1000, maxiter=10, tol=0.0001, max_time=inf, three_block=True, vary_rho=0, tau_incr=2, tau_decr=2, mu_res=10, mu_merit=1000, warm_start=False, max_iter=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.md index 1ce1e212854..9175824d009 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.ADMMState -`ADMMState(op, rho_initial)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") +`ADMMState(op, rho_initial)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.md index 49ea17d7f80..284d526dbdf 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CobylaOptimizer -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -49,7 +49,7 @@ This initializer takes the algorithmic parameters of COBYLA and stores them for -`CobylaOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -112,7 +112,7 @@ The result of the multi start algorithm applied to the problem. -`CobylaOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") +`CobylaOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cobyla_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.md index 56cf574ed45..b07f8629871 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer -`CplexOptimizer(disp=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer(disp=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -45,7 +45,7 @@ Initializes the CplexOptimizer. -`CplexOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -87,7 +87,7 @@ Returns True if the problem is compatible, False otherwise. -`static CplexOptimizer.is_cplex_installed()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`static CplexOptimizer.is_cplex_installed()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Returns True if cplex is installed @@ -95,7 +95,7 @@ Returns True if cplex is installed -`CplexOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") +`CplexOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/cplex_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.md index f8bec039b40..4f2e129b671 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.md index fdf1e811782..fa887f88aa1 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.GroverOptimizer -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -34,7 +34,7 @@ Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. -`GroverOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -76,7 +76,7 @@ Returns True if the problem is compatible, False otherwise. -`GroverOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") +`GroverOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/grover_optimizer.py "view source code") Tries to solves the given problem using the grover optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.md index c3841732628..7172485413c 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.IntermediateResult -`IntermediateResult(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`IntermediateResult(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md index 0c583aca782..9ede7545b9d 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` @@ -32,7 +32,7 @@ Minimum Eigen Optimizer Result. -`MinimumEigenOptimizationResult.get_correlations()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizationResult.get_correlations()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Get \ correlation matrix from samples. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.md index 7b6b8077e7c..54fc420dd2e 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -53,7 +53,7 @@ This initializer takes the minimum eigen solver to be used to approximate the gr -`MinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -95,7 +95,7 @@ Returns True if the problem is compatible, False otherwise. -`MinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") +`MinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.md index 858b2d9f97a..cf70df4393e 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer -`MultiStartOptimizer(trials=1, clip=100.0)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer(trials=1, clip=100.0)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm`, `abc.ABC` @@ -69,7 +69,7 @@ Returns True if the problem is compatible, False otherwise. -`MultiStartOptimizer.multi_start_solve(minimize, problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") +`MultiStartOptimizer.multi_start_solve(minimize, problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/multistart_optimizer.py "view source code") Applies a multi start method given a local optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.md index 3a5a2cd46a1..a9163ab5585 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm -`OptimizationAlgorithm`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for optimization algorithms in Qiskit’s optimization module. -`abstract OptimizationAlgorithm.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -42,7 +42,7 @@ Returns the incompatibility message. If the message is empty no issues were foun -`OptimizationAlgorithm.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationAlgorithm.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. @@ -62,7 +62,7 @@ Returns True if the problem is compatible, False otherwise. -`abstract OptimizationAlgorithm.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`abstract OptimizationAlgorithm.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.md index a6aa4c989d0..014e77d6c41 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResult -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.md index 8bf9832d57f..21613d9ecb6 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus -`OptimizationResultStatus(value)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`OptimizationResultStatus(value)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md index 24c7b4a162f..12d0272ee2d 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizatio -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md index b292156eee5..99c4d5f3534 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm` @@ -64,7 +64,7 @@ This initializer takes a `MinimumEigenOptimizer`, the parameters to specify unti -`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -106,7 +106,7 @@ Returns True if the problem is compatible, False otherwise. -`RecursiveMinimumEigenOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") +`RecursiveMinimumEigenOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/recursive_minimum_eigen_optimizer.py "view source code") Tries to solve the given problem using the recursive optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.md index 34ca60acc3c..f8cd40fe775 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.optimization_algorithm.OptimizationResult` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.md index d6d8d5db9ae..7136c317531 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Bases: `qiskit.optimization.algorithms.multistart_optimizer.MultiStartOptimizer` @@ -62,7 +62,7 @@ This initializer takes the algorithmic parameters of SLSQP and stores them for l -`SlsqpOptimizer.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -125,7 +125,7 @@ The result of the multi start algorithm applied to the problem. -`SlsqpOptimizer.solve(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") +`SlsqpOptimizer.solve(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/slsqp_optimizer.py "view source code") Tries to solves the given problem using the optimizer. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.md index b4da60e7fe8..f494851b386 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.algorithms.SolutionSample -`SolutionSample(x, fval, probability, status)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") +`SolutionSample(x, fval, probability, status)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/optimization_algorithm.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.md b/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.md index e35345c4ba8..3818968c838 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.InequalityToEquality -`InequalityToEquality(mode='auto')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality(mode='auto')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -47,7 +47,7 @@ To chose the type of slack variables. There are 3 options for mode. -`InequalityToEquality.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a problem with inequality constraints into one with only equality constraints. @@ -73,7 +73,7 @@ The converted problem, that contain only equality constraints. -`InequalityToEquality.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") +`InequalityToEquality.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/inequality_to_equality.py "view source code") Convert a result of a converted problem into that of the original problem. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.md b/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.md index e4a3c3ccc94..6c224c3b544 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.IntegerToBinary -`IntegerToBinary`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -41,7 +41,7 @@ Annealers. arxiv.org:1706.01945. -`IntegerToBinary.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert an integer problem into a new problem with binary variables. @@ -65,7 +65,7 @@ The converted problem, that contains no integer variables. -`IntegerToBinary.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") +`IntegerToBinary.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py "view source code") Convert back the converted problem (binary variables) to the original (integer variables). diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.md b/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.md index b71a8baad93..202c4ef38d3 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty -`LinearEqualityToPenalty(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -26,7 +26,7 @@ Convert a problem with only equality constraints to unconstrained with penalty t -`LinearEqualityToPenalty.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert a problem with equality constraints into an unconstrained problem. @@ -50,7 +50,7 @@ The converted problem, that is an unconstrained problem. -`LinearEqualityToPenalty.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") +`LinearEqualityToPenalty.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/linear_equality_to_penalty.py "view source code") Convert the result of the converted problem back to that of the original problem diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.md b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.md index 7eda37a7c99..f2077921bc9 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramConverter -`QuadraticProgramConverter`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`QuadraticProgramConverter` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for converters of quadratic programs in Qiskit’s optimizatio -`abstract QuadraticProgramConverter.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Convert a QuadraticProgram into another form and keep the information required to interpret the result. @@ -34,7 +34,7 @@ Convert a QuadraticProgram into another form and keep the information required t -`abstract QuadraticProgramConverter.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") +`abstract QuadraticProgramConverter.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_converter.py "view source code") Interpret a result into another form using the information of conversion diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.md b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.md index 630ff285c33..d602667802d 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo -`QuadraticProgramToQubo(penalty=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo(penalty=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter` @@ -37,7 +37,7 @@ Convert a given optimization problem to a new problem that is a QUBO. -`QuadraticProgramToQubo.convert(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.convert(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a problem with linear equality constraints into new one with a QUBO form. @@ -61,7 +61,7 @@ The problem converted in QUBO format. -`static QuadraticProgramToQubo.get_compatibility_msg(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`static QuadraticProgramToQubo.get_compatibility_msg(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with this optimizer. @@ -83,7 +83,7 @@ A message describing the incompatibility. -`QuadraticProgramToQubo.interpret(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.interpret(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Convert a result of a converted problem into that of the original problem. @@ -103,7 +103,7 @@ The result of the original problem. -`QuadraticProgramToQubo.is_compatible(problem)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") +`QuadraticProgramToQubo.is_compatible(problem)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/quadratic_program_to_qubo.py "view source code") Checks whether a given problem can be solved with the optimizer implementing this method. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.md index 6aaa1e61bcd..f07e10ec8f4 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Constraint -`Constraint(quadratic_program, name, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`Constraint(quadratic_program, name, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ Initializes the constraint. -`abstract Constraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") +`abstract Constraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/constraint.py "view source code") Evaluate left-hand-side of constraint for given values of variables. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.md index b1fa58edc45..8b2d46fded4 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint -`LinearConstraint(quadratic_program, name, linear, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint(quadratic_program, name, linear, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -30,7 +30,7 @@ Representation of a linear constraint. -`LinearConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") +`LinearConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.md index c4afeea8ae0..e778ec5c833 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression -`LinearExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The linear expression can be defined via an array, a list, a sparse matrix, or a -`LinearExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the linear expression for given variables. @@ -51,7 +51,7 @@ The value of the linear expression given the variable values. -`LinearExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Evaluate the gradient of the linear expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient of the linear expression given the variable values. -`LinearExpression.to_array()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_array()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as array. @@ -87,7 +87,7 @@ An array with the coefficients corresponding to the linear expression. -`LinearExpression.to_dict(use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") +`LinearExpression.to_dict(use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/linear_expression.py "view source code") Returns the coefficients of the linear expression as dictionary, either using variable names or indices as keys. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.md index 880f9867257..1424ae8c13a 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Bases: `qiskit.optimization.problems.constraint.Constraint` @@ -33,7 +33,7 @@ Constructs a quadratic constraint, consisting of a linear and a quadratic term. -`QuadraticConstraint.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") +`QuadraticConstraint.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_constraint.py "view source code") Evaluate the left-hand-side of the constraint. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.md index 9ec54d30e0e..4b406447014 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression -`QuadraticExpression(quadratic_program, coefficients)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression(quadratic_program, coefficients)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -31,7 +31,7 @@ The quadratic expression can be defined via an array, a list, a sparse matrix, o -`QuadraticExpression.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the quadratic expression for given variables: x \* Q \* x. @@ -51,7 +51,7 @@ The value of the quadratic expression given the variable values. -`QuadraticExpression.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Evaluate the gradient of the quadratic expression for given variables. @@ -71,7 +71,7 @@ The value of the gradient quadratic expression given the variable values. -`QuadraticExpression.to_array(symmetric=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_array(symmetric=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as array. @@ -91,7 +91,7 @@ An array with the coefficients corresponding to the quadratic expression. -`QuadraticExpression.to_dict(symmetric=False, use_name=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") +`QuadraticExpression.to_dict(symmetric=False, use_name=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_expression.py "view source code") Returns the coefficients of the quadratic expression as dictionary, either using tuples of variable names or indices as keys. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.md index d572d67bf56..f566abbc987 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -32,7 +32,7 @@ Constructs a quadratic objective function. -`QuadraticObjective.evaluate(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the quadratic objective for given variable values. @@ -52,7 +52,7 @@ The value of the quadratic objective given the variable values. -`QuadraticObjective.evaluate_gradient(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") +`QuadraticObjective.evaluate_gradient(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_objective.py "view source code") Evaluate the gradient of the quadratic objective for given variable values. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.md index 331b06a13ea..58a09ecaa2f 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram -`QuadraticProgram(name='')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram(name='')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This representation supports inequality and equality constraints, as well as con -`QuadraticProgram.binary_var(name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var(name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a binary variable to the quadratic program. @@ -52,7 +52,7 @@ The added variable. -`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_dict(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of binary variables @@ -80,7 +80,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.binary_var_list(keys, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of binary variables @@ -108,7 +108,7 @@ A list of variable instances. -`QuadraticProgram.clear()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.clear()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. @@ -120,7 +120,7 @@ Clears the quadratic program, i.e., deletes all variables, constraints, the obje -`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds a continuous variable to the quadratic program. @@ -146,7 +146,7 @@ The added variable. -`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of continuous variables @@ -176,7 +176,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.continuous_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a list of continuous variables @@ -206,7 +206,7 @@ A list of variable instances. -`QuadraticProgram.export_as_lp_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.export_as_lp_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the quadratic program as a string of LP format. @@ -222,7 +222,7 @@ A string representing the quadratic program. -`QuadraticProgram.from_docplex(model)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_docplex(model)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads this quadratic program from a docplex model. @@ -244,7 +244,7 @@ Note that this supports only basic functions of docplex as follows: - quadratic -`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.from_ising(qubit_op, offset=0.0, linear=False)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Create a quadratic program from a qubit operator and a shift value. @@ -268,7 +268,7 @@ Create a quadratic program from a qubit operator and a shift value. -`QuadraticProgram.get_feasibility_info(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_feasibility_info(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not along with the violations. :type x: `Union`\[`List`\[`float`], `ndarray`] :param x: a solution value, such as returned in an optimizer result. @@ -288,7 +288,7 @@ feasible -`QuadraticProgram.get_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a linear constraint for a given name or index. @@ -313,7 +313,7 @@ The corresponding constraint. -`QuadraticProgram.get_num_binary_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_binary_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of binary variables. @@ -329,7 +329,7 @@ The total number of binary variables. -`QuadraticProgram.get_num_continuous_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_continuous_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of continuous variables. @@ -345,7 +345,7 @@ The total number of continuous variables. -`QuadraticProgram.get_num_integer_vars()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_integer_vars()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of integer variables. @@ -361,7 +361,7 @@ The total number of integer variables. -`QuadraticProgram.get_num_linear_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_linear_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of linear constraints. @@ -377,7 +377,7 @@ The number of linear constraints. -`QuadraticProgram.get_num_quadratic_constraints()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_quadratic_constraints()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the number of quadratic constraints. @@ -393,7 +393,7 @@ The number of quadratic constraints. -`QuadraticProgram.get_num_vars(vartype=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_num_vars(vartype=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns the total number of variables or the number of variables of the specified type. @@ -413,7 +413,7 @@ The total number of variables. -`QuadraticProgram.get_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a quadratic constraint for a given name or index. @@ -438,7 +438,7 @@ The corresponding constraint. -`QuadraticProgram.get_variable(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.get_variable(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a variable for a given name or index. @@ -458,7 +458,7 @@ The corresponding variable. -`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var(lowerbound=0, upperbound=1e+20, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Adds an integer variable to the quadratic program. @@ -484,7 +484,7 @@ The added variable. -`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_dict(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_dict’ to construct a dictionary of integer variables @@ -514,7 +514,7 @@ A dictionary mapping the variable names to variable instances. -`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.integer_var_list(keys, lowerbound=0, upperbound=1e+20, name=None, key_format='{}')` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Uses ‘var\_list’ to construct a dictionary of integer variables @@ -544,7 +544,7 @@ A list of variable instances. -`QuadraticProgram.is_feasible(x)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.is_feasible(x)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns whether a solution is feasible or not. @@ -564,7 +564,7 @@ Returns whether a solution is feasible or not. -`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.linear_constraint(linear=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a linear equality constraint to the quadratic program of the form: @@ -593,7 +593,7 @@ The added constraint. -`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.maximize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be maximized. @@ -615,7 +615,7 @@ The created quadratic objective. -`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.minimize(constant=0.0, linear=None, quadratic=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Sets a quadratic objective to be minimized. @@ -637,7 +637,7 @@ The created quadratic objective. -`QuadraticProgram.pprint_as_string()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.pprint_as_string()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. :rtype: `str` :returns: A string representing the quadratic program. @@ -645,7 +645,7 @@ DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print -`QuadraticProgram.prettyprint(out=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.prettyprint(out=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). @@ -661,7 +661,7 @@ DEPRECATED Pretty prints the quadratic program to a given output stream (None = -`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.quadratic_constraint(linear=None, quadratic=None, sense='<=', rhs=0.0, name=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") #### Adds a quadratic equality constraint to the quadratic program of the form: @@ -691,7 +691,7 @@ The added constraint. -`QuadraticProgram.read_from_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.read_from_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Loads the quadratic program from a LP file. @@ -716,7 +716,7 @@ Loads the quadratic program from a LP file. -`QuadraticProgram.remove_linear_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_linear_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a linear constraint @@ -737,7 +737,7 @@ Remove a linear constraint -`QuadraticProgram.remove_quadratic_constraint(i)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.remove_quadratic_constraint(i)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Remove a quadratic constraint @@ -758,7 +758,7 @@ Remove a quadratic constraint -`QuadraticProgram.substitute_variables(constants=None, variables=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.substitute_variables(constants=None, variables=None)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Substitutes variables with constants or other variables. @@ -783,7 +783,7 @@ An optimization problem by substituting variables with constants or other variab -`QuadraticProgram.to_docplex()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_docplex()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Returns a docplex model corresponding to this quadratic program. @@ -803,7 +803,7 @@ The docplex model corresponding to this quadratic program. -`QuadraticProgram.to_ising()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.to_ising()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Return the Ising Hamiltonian of this problem. @@ -824,7 +824,7 @@ qubit\_op -`QuadraticProgram.write_to_lp_file(filename)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") +`QuadraticProgram.write_to_lp_file(filename)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program.py "view source code") Writes the quadratic program to an LP file. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.md index f819786e881..6a652de761a 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgramElement -`QuadraticProgramElement(quadratic_program)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") +`QuadraticProgramElement(quadratic_program)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/quadratic_program_element.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.md index 224ffcab330..dd93ab6a778 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.optimization.problems.Variable -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Bases: `qiskit.optimization.problems.quadratic_program_element.QuadraticProgramElement` @@ -38,7 +38,7 @@ The variables is exposed by the top-level QuadraticProgram class in QuadraticPro -`Variable.as_tuple()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") +`Variable.as_tuple()` [GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/problems/variable.py "view source code") Returns a tuple corresponding to this variable. diff --git a/docs/api/qiskit/0.32/qiskit.providers.Backend.md b/docs/api/qiskit/0.32/qiskit.providers.Backend.md index 8f8b2617abf..5d43bc5af2e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md index 624c3efa4ac..37527a2e10f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md index 7982b298902..c1d3b6527a0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md index de4e1e24d13..c2724f27642 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md index 84da9924fa4..b915fd12e9f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md index 5a3be2cefee..2823a2f7486 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.32/qiskit.providers.Job.md b/docs/api/qiskit/0.32/qiskit.providers.Job.md index 63659a6fffd..f3bbce8abc6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobError.md b/docs/api/qiskit/0.32/qiskit.providers.JobError.md index c451db25471..34cdf601cd6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md index 5b2f11fd019..c234d5ec2ff 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md index 5cd9186bd93..e190fbd84cd 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobV1.md b/docs/api/qiskit/0.32/qiskit.providers.JobV1.md index 8a10a273119..9e8e5d7ee99 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.32/qiskit.providers.Options.md b/docs/api/qiskit/0.32/qiskit.providers.Options.md index ac32ae67834..006e6291d63 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Bases: `types.SimpleNamespace` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.32/qiskit.providers.Provider.md b/docs/api/qiskit/0.32/qiskit.providers.Provider.md index 968e515262f..bfcea8694aa 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md index 2b87bbfd5ec..2e5188b77e3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md index ed7ccfe563b..5e7acf5c172 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.md index e73f1efd60e..edbb37c6d86 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.md index 26bfd13c4cc..199c977d93a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.md index 45c4620db2a..b95040a3336 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -160,7 +160,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -168,7 +168,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -184,7 +184,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -218,7 +218,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -226,7 +226,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -314,7 +314,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.md index 35c5903ba27..0f6694ec091 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -147,7 +147,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -205,7 +205,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -231,7 +231,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.md index 9bccd150d8c..46d4271a9e9 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -139,7 +139,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -147,7 +147,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -163,7 +163,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -197,7 +197,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -301,7 +301,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.md index e0deb4d929b..216939d1cb4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -73,7 +73,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -81,7 +81,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -227,7 +227,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.md index fe9fd1e7e12..e2defd25c5a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.md index bd09b928a2b..14911530532 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -107,7 +107,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -115,7 +115,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 79b02f0dd1c..28a05cec894 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 1677292f0f7..5c29d00998b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 47dcb71f194..92bbd042bff 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.md index b91c0717c6f..cbb222737f5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.md index b82a02aae95..2f3b7dd1c3c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.md index 769df845673..3fa77df13d8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.md index 354de533212..2643ef10f37 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.md index 2f084af6024..14674abb5db 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.md index e20f410d2b8..254595e1e9a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.md index ff1c118b222..306a5e8b853 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.md index e7d38aafa3d..ebe8a598f45 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 30a2d26ecec..ead7a8ab0a8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.md index db64cb57ee9..f4df6a88c6a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.md index 18382603f71..8d742cc756e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.md index 22b425d8341..79cbc45cc27 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.md index 9c77eba94d7..24af3581d0e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.md index b8b38a17639..79aea308a9e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.md index 0d4023041c8..e4394dd1499 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.md index e759602c281..0eeb3724bde 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.md index 0d8ad8e8c82..497ab39b422 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.md index 020d0728ea7..ac08ffe9fc5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.md index 1e490ce4ef7..12a0944942d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.md index 2ba6b03db6e..8c51f05fc21 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.md index b0582a7713b..66007879890 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.md index 79d105c1369..f6d60e6d579 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.md index 22e1e4de639..8ec98e46380 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.md index 35c61148419..cefa258d9de 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes.md index d0fd751daa9..f6f88f92a8a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes_squared.md index c8e82191ee3..9e69b08814e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_density_matrix.md index c292865e173..b7fe6d72ad4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value.md index afb0aa6b5cd..b5d6c393030 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value_variance.md index cad935698d1..540f5a6fa5c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_matrix_product_state.md index ad9329fb5b6..042515e636f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities.md index 98709e41a00..c74bc7fb192 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities_dict.md index 232f5123a85..1d2c6e7628c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_stabilizer.md index caa96c0dad7..c9bae83161e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_state.md index 5b43901211e..38b617016f0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector.md index 910688c4069..25ff84a6e48 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector_dict.md index 3e042263bd0..af529254e93 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_unitary.md index 3900cf9ef44..d223f5969b0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_density_matrix.md index 62f93bfba5c..04a01d89e8d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_matrix_product_state.md index 07cb9ac48f9..0fe380ec195 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_stabilizer.md index 47ce108bc7f..ca1043a2443 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_statevector.md index caf2c8ae80d..97f9f6e64c8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_superop.md index a71d2be2b79..2de685817f9 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_unitary.md index 318fc9eccab..e6946858c46 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.md index b7e7e1dd885..591edcd2526 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.md index be262c84116..ff22ab5d765 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel other \* self. @@ -85,7 +85,7 @@ The composition error channel. -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -93,7 +93,7 @@ Make a copy of current QuantumError. -`QuantumError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel self \* other. @@ -118,7 +118,7 @@ The composition error channel. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -143,7 +143,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -167,7 +167,7 @@ the tensor product error channel other ⊗ self. -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if current error object is an identity @@ -175,7 +175,7 @@ Return True if current error object is an identity -`QuantumError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the compose of a error channel with itself n times. @@ -199,7 +199,7 @@ the n-times composition error channel. -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -207,7 +207,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -215,7 +215,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -239,7 +239,7 @@ the tensor product error channel self ⊗ other. -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -247,7 +247,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -255,7 +255,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.md index b2ceb8ec9cd..98829a8f1d2 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -81,7 +81,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -89,7 +89,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -114,7 +114,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -138,7 +138,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -146,7 +146,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -170,7 +170,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -178,7 +178,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -186,7 +186,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -210,7 +210,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -218,7 +218,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.amplitude_damping_error.md index 8e9e6295d9e..dd2ff84f6d0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.coherent_unitary_error.md index 75525914a49..84e4b8ec014 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.depolarizing_error.md index 85a1d7c9498..68d139e8b8c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ee7da332025..25ae7882329 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index f364dd25f2d..3b481f5b563 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_error_values.md index 3ae2a2ff174..d0943efa790 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_length_values.md index 1b13b72489b..892fe67f613 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_param_values.md index 918d4b8a054..93fb9036ea3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.readout_error_values.md index e59808902fb..0fadf024f1e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index 0bacf85f54f..4785b2029bb 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.kraus_error.md index 44ca93fb5ca..90bd27c8bba 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.mixed_unitary_error.md index 3d5c9582a90..111474c892d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.pauli_error.md index 6d368a98133..ccfd737e3c1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index 1e5fd78c8b6..a2f2c78e418 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_damping_error.md index ef2fd39829e..4b71083d507 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.reset_error.md index a254e39f831..63de275e22f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.thermal_relaxation_error.md index 677c791119f..36c3b22a0d8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.md index f80a4e6e134..65f4da8ad16 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.duffing_system_model.md index 24d251b1714..d6036ef8fd1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.md index a79f3f36e95..4e5fc535530 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Transforms one quantum channel to another based on a specified criteria. -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_noise_model.md index 6ac6827b3e9..1ca9fe60950 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_quantum_error.md index cd5acf0deb7..ca9a30e2885 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.insert_noise.md index c9c0300ea59..c29fc6f23ab 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.remap_noise_model.md index 64a6012ca37..8bbffc11ecc 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.md index 1a9600d9787..274cabb8be7 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.md index 6b901b10024..a1a30ea5642 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.md index dbdc2b1476c..32a5b314e49 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.md index 933a7deb632..2c5d6fe17c3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.md index dc2fded523b..698c76540f4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.md index a75d9051fba..14c43d97a79 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.md index ee377ff4552..080fed9feef 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.md index 85016b461db..27ee177b989 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index f32e6661621..142488e7e63 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 4f297b21f45..3ee143a7fbf 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index d5033de02b1..ec2b2ff9ece 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 657ec0e7086..e57c1ea3508 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.md index 24aff3b033d..162460e4350 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index eed050ae3bd..0503262f823 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.md index 0d53acc2879..a9f9fc174c1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -475,7 +475,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.md index 4bdd0f2a060..3c7104091e7 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index c041bbf3bf6..cc590ceedc4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.md index 6dc463b2421..0f3eb783aa8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.md index eb24ee9f625..9893019fc38 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -159,7 +159,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -175,7 +175,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.md index 86f9c45a3d5..9fbc296f482 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.md index 41652141dc8..653ebcaba50 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.md index 6e647420f52..da8eb8f9ae0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.md index eb4cebba7e4..f25a610ee3e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.md index 71d9c42f83f..3e1c60596ad 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.md index 78ec3d1dfb1..0bc0d7a3aa6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.md index 04f279e0cd1..15321015cab 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 4f851752dc3..2df20de8748 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 08f3dd7e2c4..3233af88348 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.md index f954c886cda..1d6c1e5120a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 53f323ab1ab..57f08b83f90 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c2b7202cfc0..51a853d365e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.md index b160d6165e9..964dd419d39 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 1dc23cd056c..ee2630368f8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.md index 3d88360d8d8..014b28bf5ef 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.md index 7d91f3308c2..4778d5d52bc 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.md index dbf01e8af0b..be17ce9e5c5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.md index 1da1f4b7bfe..a8d7a644cc9 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 48bafa04842..2be074447b3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 740582bb1ce..b7cedbeec8f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 9078ea34ddf..608b47aa837 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.md index dddd6edda94..62fb25d7f62 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.job_monitor.md index 56ec96af801..bfce901433d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.least_busy.md index 60d12dd3e3c..438b1da7267 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.md index 0888b9afcd2..b0ef32a0af5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index d89c8d9ca6b..501d8826c4c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 8ce6b93b8f5..48e1f0b6e9c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 83cc49d15fa..62fa44f7e9f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 2d51d9d9f15..5dda3344b39 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 944b4b473e9..ef871dc887a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index c3dbd53a191..49f863db3c3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.md index bb0c317e8c0..30d26bd4a7c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.md index 80baee65fb7..6e87d25958e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.md index 3591537cc7a..aabdf063346 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.md index 5298496e3cb..22dc0c14329 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` @@ -49,7 +49,7 @@ BaseRandomService constructor. -`CQCExtractor.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Retrieve a previously submitted job. @@ -69,7 +69,7 @@ A `CQCExtractorJob` instance. -`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Process input data synchronously. @@ -95,7 +95,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the first extractor asynchronously. @@ -122,7 +122,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the second extractor asynchronously. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.md index 1641499d8ce..f578a084e2c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ CQCExtractorJob constructor. -`CQCExtractorJob.block_until_ready(timeout=None, wait=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.block_until_ready(timeout=None, wait=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Wait for the job to finish and return the result. @@ -70,7 +70,7 @@ Extractor output. -`CQCExtractorJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Query the server for the latest job status. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.md index abc92c11bae..4a3f981d3bd 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ IBMQRandomService constructor. -`IBMQRandomService.get_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.get_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return the random number service with the given name. @@ -60,7 +60,7 @@ Service with the given name. -`IBMQRandomService.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return all random number services available to this account. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 0cb641d0679..e39ed872192 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.md index f7097ba33fc..a20d4c57991 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.md index 5a29db09af8..b298f71d3ef 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9cdaa136c33..efa85d6c02c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a2dd9a65d86..e889c6db58a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index baee1780106..08990c0507e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.md index 98706a664ff..3a6a6148fc8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 373af1cfb82..68152ef5044 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.md index 9b54f2fc279..5f60edd2c6f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.seconds_to_duration.md index 8d21231dabf..c1f60744b78 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.to_python_identifier.md index 44ab31ee0c5..9fa8bc0baa4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.update_qobj_config.md index c126d25f613..ff1f78e53d3 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.utc_to_local.md index 2ad496aa570..da6c598463d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.validate_job_tags.md index b96de6d5ac2..a8f10ceb6a0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.md index 1194041a160..a98f84d7d25 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md index 95a5a196fdd..23cc125a1dc 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Create a new Gate object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.md index 2a77cb0018c..c8310dbaea0 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.Command.md b/docs/api/qiskit/0.32/qiskit.providers.models.Command.md index d59f62fa357..0064c29ba84 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.md index f2567400f56..84751abd71c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.md index fec2e864f50..00e71ba5b63 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.md index 6c8cbdaf67b..2b7d9d81202 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.md index 5b451249c5b..3d849f6b642 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.md index 03a572c07fa..dc79f529a51 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md index c5e76ea2756..8a7866e606c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md index e81c9ad04e6..ddbc145a70a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md index c0c426ea242..29f34ba6a0f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Call.md b/docs/api/qiskit/0.32/qiskit.pulse.Call.md index 7799d85e74d..5984caf0764 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Constant.md b/docs/api/qiskit/0.32/qiskit.pulse.Constant.md index 4d938607047..02184ee1aa7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md index b4dba6f160f..2b778a25c38 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Delay.md b/docs/api/qiskit/0.32/qiskit.pulse.Delay.md index 5b1c53a52df..a14b028f5ee 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Drag.md b/docs/api/qiskit/0.32/qiskit.pulse.Drag.md index 43b41cc3adb..c88bb9a600e 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md index e76436c993a..195322c688f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md index e702d836cdd..41a84546aec 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md index 7f8a3a3f7fd..f3631d07c9b 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md index ed76521b1e2..f15a0f63b7c 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md index 1151ecd4dfb..ffd9fd4586f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -170,7 +170,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -192,7 +192,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -216,7 +216,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md index 37f7f62aa03..01fcf813f1a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md index 9ac277595cf..63bf5b6d97b 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Play.md b/docs/api/qiskit/0.32/qiskit.pulse.Play.md index da5ab8a6b88..74c3dc0b374 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md index 4a3cdeb7c7e..2bcf25644bf 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.PulseError -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md index 09a49766530..42277f2ac23 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md index 26facb29dff..bdfb1e94a0f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -239,7 +239,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -264,7 +264,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -287,7 +287,7 @@ If no arguments are provided, `self` is returned. -`Schedule.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Deprecated. @@ -299,7 +299,7 @@ Deprecated. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -321,7 +321,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -346,7 +346,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -365,7 +365,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -377,7 +377,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -438,7 +438,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md index 6be4597cd35..4ea0dfc1225 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -126,7 +126,7 @@ Return the time of the end of the last instruction over the supplied channels. -`ScheduleBlock.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -142,7 +142,7 @@ Return the time of the start of the first instruction over the supplied channels -`ScheduleBlock.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -232,7 +232,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -265,7 +265,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -296,7 +296,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -318,7 +318,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -343,7 +343,7 @@ New block object with name and metadata. -`ScheduleBlock.insert(start_time, block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.insert(start_time, block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. @@ -366,7 +366,7 @@ This method will be removed. Temporarily added for backward compatibility. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -378,7 +378,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -390,7 +390,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -412,7 +412,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.shift(time, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.shift(time, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") This method will be removed. Temporarily added for backward compatibility. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md index 70e4017f765..bdcaecf284d 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md index 62054c398c0..31416321d95 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md index ccb0461c3b8..e2b5095ff9f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md index b212bcf03ae..4303c5627fa 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md index 0b35a9e071b..2978a2245eb 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md index 64ae0355b64..4f36364a78e 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire.md index 7fb6b0c1c63..958170cf301 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire_channel.md index 98b8ed75896..484673363ea 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.active_backend.md index 29546869ebf..ca6fd922e1f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 4e74842ec4f..16cbc35b5f1 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.active_transpiler_settings.md index f3a15baa159..32640b97eb2 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_equispaced.md index 797ce3da53c..27576ea27dc 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_func.md index 12642213594..2973a9a7619 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_left.md index cbbb71aac73..fd6505616a3 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_right.md index 572951819b6..fb6aa7e45cd 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_sequential.md index 0b1585565a3..8b9a24f84a2 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.barrier.md index 339e1e01b0a..31e64cd6d59 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.build.md index 6e9fef84af6..027f1148f27 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.call.md index d69592c6a61..582dcc9cd79 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.circuit_scheduler_settings.md index 657d3302d88..a65c3624e7e 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.control_channels.md index 762939f242c..160ab43c52c 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.cx.md index 7e02b9e1bb7..95a269bec64 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.delay.md index 4f71e962d27..55ee9d104ff 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.delay_qubits.md index b0f847d24e3..70add771a15 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.drive_channel.md index ff0cf2a08e9..82422de0315 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.frequency_offset.md index e1a747dba9a..f62b75817fd 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.inline.md index 5f57428166d..5b9fedec7e9 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure.md index cc5ba4115b9..3b9a30910cc 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_all.md index 51e42b44561..8c11a4ce0f4 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_channel.md index 81f11f99879..b8b3e622524 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.num_qubits.md index 676d2ed6d40..701276b045b 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.pad.md index 43e967fc609..90f31cddfdd 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.phase_offset.md index 62ba68346f5..2498e5ac893 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.play.md index 18c6de4b90e..a7900788790 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.qubit_channels.md index 5d240a5c0ed..8e32d58a761 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.samples_to_seconds.md index b6d7fcda54f..dd76abd524f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.seconds_to_samples.md index d93f52c4470..79d53f9ed18 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.set_frequency.md index d85f6e4ca0e..5808cfa6cc8 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.set_phase.md index b41660ee5ad..07b01f8d5e1 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_frequency.md index 2544b9eb704..9d4a11f08d6 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_phase.md index 94e436785ef..2451e512b45 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.snapshot.md index e983009dc0b..5a5c3597646 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.transpiler_settings.md index f5fbba68e32..d55a51109be 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.u1.md index 9941efd5892..0372cd49e83 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.u2.md index 593b6b26057..1106180b726 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.u3.md index ec7e467dae9..a78e299a90d 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.32/qiskit.pulse.builder.x.md index 0a4e7cc7f76..db5b0046e3d 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.md index b4d3e2cd393..fd9686e9043 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.md index 81e6a62715f..44f6c9375c0 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Store parameters which will be later assigned to the subroutine. @@ -83,7 +83,7 @@ Self with updated parameters. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -216,7 +216,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.md index b454559b818..2cf252fac58 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -198,7 +198,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.md index 2669c0e7e33..a0d16875406 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Instruction -`Instruction(operands, duration=None, channels=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, duration=None, channels=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Instruction initializer. -`Instruction.append(schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.append(schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Instruction.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Modify and return self with parameters assigned according to the input. @@ -77,7 +77,7 @@ Self with updated parameters. -`Instruction.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return duration of the supplied channels in this Instruction. @@ -93,7 +93,7 @@ Return duration of the supplied channels in this Instruction. -`Instruction.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return minimum start time for supplied channels. @@ -109,7 +109,7 @@ Return minimum start time for supplied channels. -`Instruction.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return maximum start time for supplied channels. @@ -125,7 +125,7 @@ Return maximum start time for supplied channels. -`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Plot the instruction. @@ -156,7 +156,7 @@ matplotlib.figure -`Instruction.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.flatten()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return itself as already single instruction. @@ -168,7 +168,7 @@ Return itself as already single instruction. -`Instruction.insert(start_time, schedule, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.insert(start_time, schedule, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return True iff the instruction is parameterized. @@ -202,7 +202,7 @@ Return True iff the instruction is parameterized. -`Instruction.shift(time, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction.shift(time, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/instruction.py "view source code") Return a new schedule shifted forward by time. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.md index 867a3a2f0f2..df5d8545751 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -57,7 +57,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Play.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Modify and return self with parameters assigned according to the input. @@ -190,7 +190,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.md index 145fda8c30a..a9528d66c33 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.md index 9cb4acecad2..1ebcfb1a11c 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -192,7 +192,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.md index 23fc954ed82..207efa106f7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -184,7 +184,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.md index da52194db0e..48495887d05 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -194,7 +194,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.md index 6a8c84c04ea..413eaa320e4 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -188,7 +188,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.md index b6a1742d533..847bbb1d5b7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.md index 0f819369aff..d54ee604c97 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -131,7 +131,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -155,7 +155,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.md index 8a9a5b4afca..0a37c624210 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -117,7 +117,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -141,7 +141,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.md index 0b10fefe392..806fe3393d7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -135,7 +135,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -159,7 +159,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.md index 73fb571e07c..3c3f56c74b7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -31,7 +31,7 @@ Create new sample pulse command. -`Waveform.assign_parameters(value_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.assign_parameters(value_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return a new pulse with parameters assigned. @@ -101,7 +101,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires.md index 4a6619928c2..0980cb98d6b 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.32/qiskit.pulse.transforms.align_measures.md index 912fbe3c1d7..e455aa7afbd 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.32/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.32/qiskit.pulse.transforms.pad.md index 4fde0d29b1f..708fb7dea2c 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md index 568692c6cec..cd7cbe99aa4 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md index 5811942acdb..e252baff09b 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.32/qiskit.qasm.QasmError.md index 0953fcef5e4..baf3c16ec44 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md index 8577ea17145..d6604047c6b 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md index 4bb241a51f1..996e8f90c48 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md index dc6807f4f47..cb9c76c431b 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md index 250da02a36c..e539df275f8 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md index f32e162938b..61bd5da66dc 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md index 23de14f2b58..13310686dd6 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md index 946eb56277f..6108c37bf58 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md index a102b65db76..26905407c4f 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md index 09e4e8cf6b6..02a106e69be 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md index 93e83cf8204..792aafbd46a 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md index 229e0c25a80..0efb9250ec6 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict(validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict(validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md index 68efc15b60a..8f1af92cd29 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md index 1ac3a0d1412..8a9ab6d04c8 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md index 169ff7f0edd..2f540e16e76 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md index 2a8827e0025..b652e1c615b 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md index 48fab3cc3e7..d5931646cfe 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md index dfdb814e30a..4356b458ef9 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md index 0683e853895..ce821f49651 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md index 8d2804fa7cf..113a5434563 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.md index ebff470a33f..dd0721a2889 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.md index ccf832fe311..4b2db827eaa 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.md index 7ec4ff27c21..53f3ad6cff6 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.md index e69135ac64a..c054c07c1fa 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.md index 45eb39aec8e..60a67bb15d1 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.md index a59d2279a15..bab4107eda2 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.md index d746922fe44..be43b8e566a 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.md index 174a69f047a..fd55e4f045a 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -207,7 +207,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -223,7 +223,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -273,7 +273,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -291,7 +291,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -317,7 +317,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -325,7 +325,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -333,7 +333,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.md index d14a8785d50..9b762b76754 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.md index b8d396e287b..056331534c7 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -344,7 +344,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -366,7 +366,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -401,7 +401,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -426,7 +426,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -460,7 +460,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -468,7 +468,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -500,7 +500,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -546,7 +546,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -595,7 +595,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -611,7 +611,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -636,7 +636,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -662,7 +662,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -670,7 +670,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -690,7 +690,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -710,7 +710,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -728,7 +728,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -736,7 +736,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -763,7 +763,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.md index 26f96fd2a3f..4b0f2149b87 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -372,7 +372,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -396,7 +396,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -426,7 +426,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -454,7 +454,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -462,7 +462,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -480,7 +480,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -560,7 +560,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -623,7 +623,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -647,7 +647,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -676,7 +676,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -706,7 +706,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -714,7 +714,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.md index 6e88c9325d0..50a2affa31b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md index ebd5cb973c2..4a188ed873b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.md index 4580365d9cc..aea5d2c2f59 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.md index b72250d6dc1..e475b2c7eac 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -39,7 +39,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -47,7 +47,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -79,7 +79,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -138,7 +138,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list \[(pauli\_str, coeffs)] @@ -146,7 +146,7 @@ Construct from a list \[(pauli\_str, coeffs)] -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -182,7 +182,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -203,7 +203,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -221,7 +221,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -301,7 +301,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliTable by combining duplicates and removing zeros. @@ -322,7 +322,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -348,7 +348,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -370,7 +370,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -390,7 +390,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -398,7 +398,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.md index 845a37a909b..f4afb057545 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of an operator. @@ -154,7 +154,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -162,7 +162,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -186,7 +186,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -209,7 +209,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -234,7 +234,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -254,7 +254,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -305,7 +305,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -340,7 +340,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -364,7 +364,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -372,7 +372,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.md index 9940f5942fa..401a2557825 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md index d41ce984ff1..a4222278812 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -103,7 +103,7 @@ Return a visualization of the Statevector. -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -129,7 +129,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -154,7 +154,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -178,7 +178,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -199,7 +199,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -225,7 +225,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -253,7 +253,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -286,7 +286,7 @@ The N-qubit basis state density matrix. -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -318,7 +318,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -416,7 +416,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -424,7 +424,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -448,7 +448,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -528,7 +528,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -552,7 +552,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -623,7 +623,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -631,7 +631,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.md index 6b75108f76f..65db3087e12 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.md index c3a7de9df50..2f806ef834b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 033460fc1ea..8011ed5e7e9 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.32/qiskit.quantum_info.average_gate_fidelity.md index 7fb9a34233e..1b5652e7c30 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.32/qiskit.quantum_info.concurrence.md index c78b08178f3..687f9ae3338 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.32/qiskit.quantum_info.decompose_clifford.md index 6ca92850231..7d7e125d7df 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.32/qiskit.quantum_info.diamond_norm.md index 86f41fd7f25..a21fca61eb8 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.32/qiskit.quantum_info.entanglement_of_formation.md index ba0a5cf5d39..474efe05fef 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.32/qiskit.quantum_info.entropy.md index 972b7960c19..75988e6cee9 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.32/qiskit.quantum_info.gate_error.md index 2e21141eb7e..d0cc1eb2da5 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_distance.md index adfb9615a12..1efd2679b14 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_fidelity.md index bb282958bbc..bc78af7e96a 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.32/qiskit.quantum_info.mutual_information.md index e4a660de27e..255470a0614 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.32/qiskit.quantum_info.partial_trace.md index fcab650edfc..c35c456a54e 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_basis.md index 1013541d50e..67e47327c8d 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_group.md index 4e5d94cc6fe..f7f574ad41f 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.32/qiskit.quantum_info.process_fidelity.md index 54dc69af792..0fe2d78fe1c 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.32/qiskit.quantum_info.purity.md index 2508d906b61..dfe63a28948 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_clifford.md index e397857937f..ebc9b143eca 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_cnotdihedral.md index 78482875122..7bf929ca519 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_density_matrix.md index 712a7a1eb2c..53f6e8e95a0 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_hermitian.md index 7822a9824b8..3a7c0fe6d7a 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli.md index bd5ff2607f8..1a1172b860f 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli_table.md index 137ca4d950e..6eafed31d9d 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_quantum_channel.md index 22449571abe..c74cf52ae83 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_stabilizer_table.md index 7b50b105331..3e9133f893d 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_statevector.md index ffd24a93345..c11755caa79 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.32/qiskit.quantum_info.random_unitary.md index fbfab7f787f..8ebc0cd56d2 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.32/qiskit.quantum_info.shannon_entropy.md index 3cffae817a1..d1f3ed5ceb7 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.32/qiskit.quantum_info.state_fidelity.md index a17bb1a7eeb..219305ec9d7 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.32/qiskit.result.Counts.md b/docs/api/qiskit/0.32/qiskit.result.Counts.md index 3e0c1b28c27..b0836bc1dac 100644 --- a/docs/api/qiskit/0.32/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.32/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Return the most frequent count diff --git a/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md index 652a93c0df8..badfda93833 100644 --- a/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md index a3df439e777..2a008309699 100644 --- a/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -121,7 +121,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.32/qiskit.result.Result.md b/docs/api/qiskit/0.32/qiskit.result.Result.md index 1d5d04a9af8..dfea27ddcd8 100644 --- a/docs/api/qiskit/0.32/qiskit.result.Result.md +++ b/docs/api/qiskit/0.32/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.32/qiskit.result.ResultError.md b/docs/api/qiskit/0.32/qiskit.result.ResultError.md index 9636b827e5e..651b0b3a115 100644 --- a/docs/api/qiskit/0.32/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.32/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.32/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.32/qiskit.result.marginal_counts.md index 984ec18e675..4fbf937bd99 100644 --- a/docs/api/qiskit/0.32/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.32/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md index d95b631d265..e3691a3a0d8 100644 --- a/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.32/qiskit.tools.backend_monitor.md index 900dae82e23..8917e8199fd 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.32/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.32/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.32/qiskit.tools.backend_overview.md index 957fb280a60..f988ef320c1 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.32/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.32/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.32/qiskit.tools.job_monitor.md index 3d16ebac30c..92e57bda169 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.32/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.32/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.32/qiskit.tools.parallel_map.md index 07db725f8f3..f232ba2823a 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.32/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md index 5567193156c..9509698d52a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md index 2ce2dfac706..8f25b090032 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -80,7 +80,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -102,7 +102,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -110,7 +110,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return qubits connected on a grid of num\_rows x num\_columns. @@ -118,7 +118,7 @@ Return qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -126,7 +126,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -134,7 +134,7 @@ Return a fully connected coupling map on n qubits. -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -150,7 +150,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -160,7 +160,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -168,7 +168,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -176,7 +176,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -186,7 +186,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -210,7 +210,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -235,7 +235,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -243,7 +243,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md index 2911a55d282..a470e79302b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md index b19b52b8d4b..00e28c66d3c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md index c66a5aa118b..ab556eb695e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md index f535bb13e7b..92846548d61 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name and the qubits. @@ -74,7 +74,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -90,7 +90,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md index fd318dce9c7..5779fc5efcd 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md index d60d3062ea4..cb1d29a7a49 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md index 7a34b30ea18..873ce1041ac 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md index 940178feedb..de3f9b579ed 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md index 58f37fcce1f..0be91a42cf2 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md index 6187572348c..96db165c737 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md index 04921d4f0c9..f58225cdf00 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.md index 5834bbcf5ba..5593d2d9b55 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md index bf869cf5632..3583d27a24b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md index fdea1c26f1a..6f3047aa15a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md index 8dbbf1adade..c2205e3f5d4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md index 3148d827221..9806713ab21 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -72,7 +72,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 868cc99c318..43482e25d9e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md index 90564fc4170..dfa0268fc81 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md index 6d963211a62..86445d2fde4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md index 80c02cf7d65..e8f366aba3a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md index 6f04b9e6248..845de2e0172 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md index b525f3316e5..fea10b8596e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md index c71de599680..b02406f2a5c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md index 6a17860c54c..c3429160e40 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md index 810eaa83cc7..3f997e25f37 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md index 032e151ddc1..4613199f5dd 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md index 744736cbc13..62187c78316 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md index a72caa5131d..46a35082205 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md index 51bec98a443..c16e9ab7a7b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md index 02a07d088d0..2debc209680 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md index 4f9431bb37b..1353af5be91 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index b32c79c6cc3..a34f76b8aea 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md index 997db28662b..f755a0f2838 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md index 4ecd9af788b..b1631964fc6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md index 4821800c0d5..025e85f28f4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md index 718d92615bc..a7b067d0923 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md index 9c0c24fee12..062c118d97e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md index 31691a5df25..75a7b2ffbc6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md index 72a4c9337b5..43705a6217c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md index 58f845efea2..991d31b3594 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md index 75443220b25..695c133ed97 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md index bd591642853..a68660bd460 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -52,7 +52,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md index 526e67b3172..2de48decfaf 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md index 3b941efdc17..8f08841bdd8 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md index c5ef7c51fe2..290a38a2ea6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 18b39f6de80..79baa69b039 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md index bfb88eaa73f..a0e9be18885 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md index a43c925315a..4c3e10a227e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 9f025335f64..deb8bd3bc0e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 247952bd2a6..f4185c64073 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.CalibrationCreator` @@ -32,7 +32,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -63,7 +63,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** @@ -109,7 +109,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilder.supported(node_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index d1e35d9d7f8..0dbf71a687f 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.calibration_creators.RZXCalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(params, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/calibration_creators.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md index e80b597cd86..761812a77ff 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index ea691cfcdcc..ebb876ce4cf 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md index bd287fcc787..cd167884a17 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md index d92c6ed6a1a..1a34098a35f 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md index 43a1246b882..4ea822d5049 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md index 24b02cd5d37..1ec7028a48f 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md index 310f7e38d21..07d7ccb91d0 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md index 088beac9622..46e6c9c2f34 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md index e3518c917f1..07a891b44c3 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md index e9a9ae62a6e..6653a09acf6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md index 44a16cd9703..131fb3ef24a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md index c6dc911389c..963a68b4426 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md index b72a56d66a9..d4ea3debc8f 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md index d55722e6613..1c3cf957287 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 691671212e0..7dd2a3d0438 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md index c02d018eb79..86621524a00 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md index a5078bb49fa..e33af21c9ea 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md index f7e21cd7667..e5e1dddb35c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index ce49450400a..e56210238e8 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 893991f1e1e..5fa14dacdf7 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 2a48a316b60..ad034c98bdb 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 67a6d205867..241fe8b08a2 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md index 328d57f775f..b36be637246 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -65,7 +65,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -85,7 +85,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -116,7 +116,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -136,7 +136,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -148,7 +148,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -156,7 +156,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. :param circuits: circuits to transpile :type circuits: Union\[‘QuantumCircuit’, List\[‘QuantumCircuit’]] diff --git a/docs/api/qiskit/0.32/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.32/qiskit.utils.apply_prefix.md index 2017d1c6643..a28b67fdb37 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.32/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.32/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.32/qiskit.utils.deprecate_arguments.md index 8282d5f19c9..a828755849a 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.32/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.32/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.32/qiskit.utils.deprecate_function.md index 2b87a5fcc00..4f63f06df1f 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.32/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.32/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.32/qiskit.utils.get_entangler_map.md index 6cf74ea4af2..236fae021fb 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.32/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.32/qiskit.utils.has_aer.md b/docs/api/qiskit/0.32/qiskit.utils.has_aer.md index 189bf9bfc23..102a23afe92 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.32/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md index 60361543541..be11ff87ff7 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.32/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.32/qiskit.utils.is_main_process.md index fa2d188fc3a..0ea19e37f4f 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.32/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.32/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.32/qiskit.utils.local_hardware_info.md index 830ffd2cddc..3844e400dc4 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.32/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.32/qiskit.utils.name_args.md b/docs/api/qiskit/0.32/qiskit.utils.name_args.md index eaa2979d4a7..1b871d1ee39 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.32/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.32/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.32/qiskit.utils.summarize_circuits.md index a0271e0a592..80bf315381d 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.32/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.32/qiskit.utils.validate_entangler_map.md index 2b216c7bc49..88c3e19f384 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.32/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.md b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.md index c6da2a2e904..5bfb9a42a70 100644 --- a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.SchemaValidationError -`SchemaValidationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") +`SchemaValidationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/exceptions.py "view source code") Represents an error during JSON Schema validation. diff --git a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.validate_json_against_schema.md b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.validate_json_against_schema.md index 2a574f25167..0b6d588facc 100644 --- a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.validate_json_against_schema.md +++ b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.validate_json_against_schema.md @@ -10,7 +10,7 @@ python_api_name: qiskit.validation.jsonschema.validate_json_against_schema -`validate_json_against_schema(json_dict, schema, err_msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") +`validate_json_against_schema(json_dict, schema, err_msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/validation/jsonschema/schema_validation.py "view source code") Validates JSON dict against a schema. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md index 019d0e86d97..cbd4a33b528 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.32/qiskit.visualization.array_to_latex.md index 6be62f03dfb..6168a0bbc64 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.32/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.32/qiskit.visualization.circuit_drawer.md index dd2b1981dd5..6d7492006de 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.32/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.32/qiskit.visualization.dag_drawer.md index 0f08d94f7a3..390c5fe8267 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.32/qiskit.visualization.pass_manager_drawer.md index df1f70d2634..06fff318385 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_multivector.md index 37803caa67c..b31e99cfbb7 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_vector.md index 280c485eb37..205ba1b01a6 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_circuit_layout.md index 91116696c24..1badc71683f 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_error_map.md index 7b232d8225a..4833dfbeae1 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_gate_map.md index d169b472c3c..f895440d72d 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_histogram.md index 2cfc7603b6b..c427a55d0d6 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_city.md index 636ead24cb8..c20a933d727 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_hinton.md index b5234d4eecf..451a5fc122e 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_paulivec.md index b50878b3d9f..02a696176da 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_qsphere.md index 337e62bc6f4..e13ce1c36b9 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.md index e2d818293eb..8c96b29e9d7 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.md index 53ecd61a0b0..deb943eb89c 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.md index 808cab2e4eb..463ec5974fd 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.draw.md index 4650e2e7a33..ef6f68c7525 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.md index ebc50613fb6..e29877e00b4 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.32/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.32/qiskit.visualization.timeline.draw.md index 16d89eae124..9e2aa628e92 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.32/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.32/qiskit.visualization.visualize_transition.md index f799d8cd91f..bdd0cdda636 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. From 9e19ffc35c933b105371b25dcab67f0f4eb23175 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:35:44 +0100 Subject: [PATCH 14/41] Regenerate qiskit 0.33.1 --- docs/api/qiskit/0.33/execute.md | 2 +- docs/api/qiskit/0.33/logging.md | 2 +- docs/api/qiskit/0.33/pulse.md | 8 +- .../0.33/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.33/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.33/qiskit.algorithms.Grover.md | 8 +- .../0.33/qiskit.algorithms.GroverResult.md | 2 +- docs/api/qiskit/0.33/qiskit.algorithms.HHL.md | 6 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- .../0.33/qiskit.algorithms.LinearSolver.md | 4 +- .../qiskit.algorithms.LinearSolverResult.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- .../qiskit.algorithms.NumPyLinearSolver.md | 4 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.33/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.33/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.33/qiskit.algorithms.Shor.md | 8 +- .../0.33/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.33/qiskit.algorithms.VQE.md | 20 +- .../0.33/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.33/qiskit.algorithms.optimizers.AQGD.md | 8 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 8 +- .../0.33/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.33/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.33/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.33/qiskit.algorithms.optimizers.GSLS.md | 16 +- ...t.algorithms.optimizers.GradientDescent.md | 8 +- .../qiskit.algorithms.optimizers.IMFIL.md | 8 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.33/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 18 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 6 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 8 +- .../0.33/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 8 +- .../0.33/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit/0.33/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.33/qiskit.assembler.disassemble.md | 2 +- .../0.33/qiskit.circuit.AncillaQubit.md | 2 +- .../0.33/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.33/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.33/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.33/qiskit.circuit.Clbit.md | 2 +- .../0.33/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.33/qiskit.circuit.ControlFlowOp.md | 2 +- .../0.33/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.33/qiskit.circuit.Delay.md | 12 +- .../0.33/qiskit.circuit.EquivalenceLibrary.md | 12 +- .../qiskit/0.33/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/0.33/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.33/qiskit.circuit.IfElseOp.md | 4 +- .../qiskit/0.33/qiskit.circuit.Instruction.md | 28 +-- .../0.33/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.33/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.33/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 30 +-- .../0.33/qiskit.circuit.ParameterVector.md | 6 +- .../0.33/qiskit.circuit.QuantumCircuit.md | 224 +++++++++--------- .../0.33/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.33/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.33/qiskit.circuit.Reset.md | 4 +- .../qiskit/0.33/qiskit.circuit.WhileLoopOp.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.AND.md | 2 +- .../0.33/qiskit.circuit.library.Barrier.md | 8 +- .../0.33/qiskit.circuit.library.C3SXGate.md | 4 +- .../0.33/qiskit.circuit.library.C3XGate.md | 6 +- .../0.33/qiskit.circuit.library.C4XGate.md | 6 +- .../0.33/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.33/qiskit.circuit.library.CHGate.md | 4 +- .../0.33/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.33/qiskit.circuit.library.CRXGate.md | 4 +- .../0.33/qiskit.circuit.library.CRYGate.md | 4 +- .../0.33/qiskit.circuit.library.CRZGate.md | 4 +- .../0.33/qiskit.circuit.library.CSXGate.md | 2 +- .../0.33/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.33/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.33/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.33/qiskit.circuit.library.CUGate.md | 4 +- .../0.33/qiskit.circuit.library.CXGate.md | 6 +- .../0.33/qiskit.circuit.library.CYGate.md | 4 +- .../0.33/qiskit.circuit.library.CZGate.md | 4 +- .../0.33/qiskit.circuit.library.DCXGate.md | 2 +- .../0.33/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.33/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.GRZ.md | 2 +- .../0.33/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.33/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.33/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.33/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- ...t.circuit.library.LogNormalDistribution.md | 2 +- .../0.33/qiskit.circuit.library.MCMT.md | 6 +- .../0.33/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.33/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.33/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.33/qiskit.circuit.library.MSGate.md | 2 +- .../0.33/qiskit.circuit.library.Measure.md | 4 +- .../0.33/qiskit.circuit.library.NLocal.md | 12 +- ...skit.circuit.library.NormalDistribution.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 6 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.33/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.33/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.33/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.33/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.33/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.33/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.33/qiskit.circuit.library.RGate.md | 4 +- .../0.33/qiskit.circuit.library.RVGate.md | 6 +- .../0.33/qiskit.circuit.library.RXGate.md | 6 +- .../0.33/qiskit.circuit.library.RXXGate.md | 4 +- .../0.33/qiskit.circuit.library.RYGate.md | 6 +- .../0.33/qiskit.circuit.library.RYYGate.md | 4 +- .../0.33/qiskit.circuit.library.RZGate.md | 6 +- .../0.33/qiskit.circuit.library.RZXGate.md | 4 +- .../0.33/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.33/qiskit.circuit.library.Reset.md | 4 +- .../0.33/qiskit.circuit.library.SGate.md | 4 +- .../0.33/qiskit.circuit.library.SXGate.md | 6 +- .../0.33/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.33/qiskit.circuit.library.SdgGate.md | 4 +- .../0.33/qiskit.circuit.library.SwapGate.md | 6 +- .../0.33/qiskit.circuit.library.TGate.md | 4 +- .../0.33/qiskit.circuit.library.TdgGate.md | 4 +- .../0.33/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.33/qiskit.circuit.library.U1Gate.md | 6 +- .../0.33/qiskit.circuit.library.U2Gate.md | 4 +- .../0.33/qiskit.circuit.library.U3Gate.md | 6 +- .../0.33/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.UniformDistribution.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.33/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.33/qiskit.circuit.library.XOR.md | 2 +- .../0.33/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.33/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.33/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.33/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.33/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.33/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.33/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.33/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.33/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.qpy_serialization.dump.md | 2 +- .../qiskit.circuit.qpy_serialization.load.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.33/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.33/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.33/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.33/qiskit.compiler.transpile.md | 2 +- .../0.33/qiskit.converters.ast_to_dag.md | 2 +- .../0.33/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.33/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.33/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.33/qiskit.dagcircuit.DAGCircuit.md | 126 +++++----- .../0.33/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.33/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.33/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.33/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.33/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.33/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.33/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.33/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.33/qiskit.extensions.Initialize.md | 8 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.33/qiskit.extensions.Snapshot.md | 8 +- .../0.33/qiskit.extensions.UnitaryGate.md | 16 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.33/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.33/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 16 +- .../0.33/qiskit.ignis.verification.BConfig.md | 18 +- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.33/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.33/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- ...it.ignis.verification.QOTPCorrectString.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- .../qiskit/0.33/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.33/qiskit.opflow.OpflowError.md | 2 +- .../0.33/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.33/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.33/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.33/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.33/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.33/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.33/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.33/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 4 +- .../0.33/qiskit.opflow.gradients.QFI.md | 4 +- .../0.33/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.33/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.33/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.33/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.33/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.33/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../qiskit/0.33/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.33/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.33/qiskit.providers.BackendV2.md | 16 +- .../0.33/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.33/qiskit.providers.BaseJob.md | 24 +- .../0.33/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.33/qiskit.providers.Job.md | 2 +- .../qiskit/0.33/qiskit.providers.JobError.md | 2 +- .../qiskit/0.33/qiskit.providers.JobStatus.md | 2 +- .../0.33/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.33/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.33/qiskit.providers.Options.md | 8 +- .../qiskit/0.33/qiskit.providers.Provider.md | 2 +- .../0.33/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.33/qiskit.providers.QubitProperties.md | 2 +- .../0.33/qiskit.providers.aer.AerError.md | 2 +- .../0.33/qiskit.providers.aer.AerProvider.md | 6 +- .../0.33/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.33/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 28 +-- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.33/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 10 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.33/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.33/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.33/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.33/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...skit.providers.ibmq.random.CQCExtractor.md | 10 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 6 +- ...providers.ibmq.random.IBMQRandomService.md | 6 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.33/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.33/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.33/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.33/qiskit.pulse.ScheduleBlock.md | 22 +- .../0.33/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.33/qiskit.pulse.builder.align_func.md | 2 +- .../0.33/qiskit.pulse.builder.align_left.md | 2 +- .../0.33/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.33/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.delay.md | 2 +- .../0.33/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.33/qiskit.pulse.builder.inline.md | 2 +- .../0.33/qiskit.pulse.builder.measure.md | 2 +- .../0.33/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.33/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.pad.md | 2 +- .../0.33/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.33/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.33/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.33/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.33/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.33/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.33/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.33/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.33/qiskit.pulse.instructions.Call.md | 6 +- .../0.33/qiskit.pulse.instructions.Delay.md | 4 +- .../0.33/qiskit.pulse.instructions.Play.md | 4 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.33/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.33/qiskit.pulse.library.Drag.md | 6 +- .../0.33/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.33/qiskit.pulse.library.Waveform.md | 4 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.33/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.33/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.33/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.33/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.33/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.33/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.33/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.33/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.33/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.33/qiskit.qobj.GateCalibration.md | 6 +- .../0.33/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.md | 6 +- .../0.33/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.33/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.33/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.33/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.33/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.33/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.33/qiskit.qobj.Qobj.md | 2 +- .../0.33/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.33/qiskit.qobj.QobjHeader.md | 2 +- .../0.33/qiskit.qobj.QobjMeasurementOption.md | 6 +- .../0.33/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.33/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.33/qiskit.quantum_info.Choi.md | 12 +- .../0.33/qiskit.quantum_info.Clifford.md | 32 +-- .../0.33/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.33/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.33/qiskit.quantum_info.Operator.md | 26 +- .../qiskit/0.33/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.33/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.33/qiskit.quantum_info.PauliList.md | 52 ++-- .../0.33/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.33/qiskit.quantum_info.Quaternion.md | 14 +- .../0.33/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.33/qiskit.quantum_info.SparsePauliOp.md | 34 +-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.33/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.33/qiskit.quantum_info.Stinespring.md | 14 +- .../0.33/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.33/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.33/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.33/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.33/qiskit.quantum_info.entropy.md | 2 +- .../0.33/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.33/qiskit.quantum_info.partial_trace.md | 2 +- .../0.33/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.33/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.33/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.33/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.33/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.33/qiskit.result.ProbDistribution.md | 6 +- .../0.33/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.33/qiskit.result.Result.md | 16 +- .../qiskit/0.33/qiskit.result.ResultError.md | 2 +- .../0.33/qiskit.result.marginal_counts.md | 2 +- .../0.33/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.33/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.33/qiskit.synthesis.ProductFormula.md | 2 +- .../0.33/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../0.33/qiskit.tools.backend_monitor.md | 2 +- .../0.33/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.33/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.33/qiskit.tools.parallel_map.md | 2 +- .../0.33/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.33/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.33/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.33/qiskit.transpiler.Layout.md | 30 +-- .../0.33/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.33/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit/0.33/qiskit.transpiler.Target.md | 32 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.33/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.33/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- .../0.33/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.33/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.33/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.33/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.33/qiskit.transpiler.passes.Width.md | 4 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- .../0.33/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.33/qiskit.utils.apply_prefix.md | 2 +- .../0.33/qiskit.utils.deprecate_arguments.md | 2 +- .../0.33/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.33/qiskit.utils.detach_prefix.md | 2 +- .../0.33/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.33/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.33/qiskit.utils.has_ibmq.md | 2 +- .../0.33/qiskit.utils.is_main_process.md | 2 +- .../0.33/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 6 +- .../api/qiskit/0.33/qiskit.utils.name_args.md | 2 +- .../0.33/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.33/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.33/synthesis_aqc.md | 2 +- 938 files changed, 2784 insertions(+), 2784 deletions(-) diff --git a/docs/api/qiskit/0.33/execute.md b/docs/api/qiskit/0.33/execute.md index a4f1ad75f2f..e2d131d4022 100644 --- a/docs/api/qiskit/0.33/execute.md +++ b/docs/api/qiskit/0.33/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.33/logging.md b/docs/api/qiskit/0.33/logging.md index 8dc3b98896c..e6256887f99 100644 --- a/docs/api/qiskit/0.33/logging.md +++ b/docs/api/qiskit/0.33/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.33/pulse.md b/docs/api/qiskit/0.33/pulse.md index 85a937832f4..67018a2a1e0 100644 --- a/docs/api/qiskit/0.33/pulse.md +++ b/docs/api/qiskit/0.33/pulse.md @@ -66,7 +66,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -141,7 +141,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -192,7 +192,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -634,7 +634,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.md index dcffb32ca34..09796f1b9ba 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.md index 6513550c717..2787befa9fa 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.md index 0ef6344b507..9047993d6e2 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.md index 888ad52d28d..b5e13f1daeb 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.md index 6394f4a48e5..65e0f63facc 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.md index 4a62a84859e..5e86316b1c6 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.md index 3c42d8ddae4..d6245ae32b6 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.md index d58562f9b49..8b6c661ce2e 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.md index ec241f13481..d5eecdde2c8 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.md index e100b081f8d..0f59e4619d7 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.md index b8d7b5fd7bb..3177c5c687e 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.33/qiskit.algorithms.Grover.md index 51b61834a01..4afb0eccbe9 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -114,7 +114,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -140,7 +140,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.md index 43fed8a4ac8..f93a4bcb3d3 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.33/qiskit.algorithms.HHL.md index cfe97f58581..77a0f6d73c1 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -90,7 +90,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.md index 7a35f02d8dd..8252adf92a0 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 195114c20e6..35cc4d040ad 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.md index d3b9ed042b7..29898a26e14 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 9fe22dcf301..6a40c0f853c 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.md index fae1a04c588..1642d5ee479 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.md index 6f2c27f1710..2b3f83cf669 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.md index 52c343222ad..89e3090103b 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index e210c32938e..b259022305b 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 2a0d35ce1b6..a0da150d0ba 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.md index 61f8473925a..ff301859451 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.md index d6af225f883..abaaea97742 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.md index d4f963d3a7e..04ee1dbe14c 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.md index a229428a930..a63b256deac 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.md index 7c93f1a4d32..d29fdd4c3ff 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.md index a671dc623ff..48c3794b6ed 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.md index e57f60ea5d3..64e2b570db6 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.md index 47073d27c61..b0b493c3eb2 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.md index 1c56917b681..9bc37f3e439 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.33/qiskit.algorithms.Shor.md index b1a3f71e319..1ebe8d4e5c4 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.md index e8de8e2c795..87b9508f821 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.33/qiskit.algorithms.VQE.md index 0912d9d5920..f5ff3e3209e 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -50,7 +50,7 @@ set parameterized circuits to None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -71,7 +71,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -92,7 +92,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -147,7 +147,7 @@ dict -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -174,7 +174,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.get_optimal_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the circuit with the optimal parameters. @@ -186,7 +186,7 @@ Get the circuit with the optimal parameters. -`VQE.get_optimal_cost()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_cost()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the minimal cost or energy found by the VQE. @@ -198,7 +198,7 @@ Get the minimal cost or energy found by the VQE. -`VQE.get_optimal_vector()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_optimal_vector()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Get the simulation outcome of the optimal circuit. @@ -226,7 +226,7 @@ get probabilities for counts -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -242,7 +242,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.md index 0f07c0883a9..b7cb7c92e9d 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -125,7 +125,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -163,7 +163,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.md index ecc220a6abc..77929d915e1 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. @@ -108,7 +108,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.md index 20891c90d2a..57b6eb2db72 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. @@ -88,7 +88,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.md index d81f0e4bb77..a183fbd5650 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.md index cf2b20e8eac..c388e441ec5 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.md index 923b8559128..5eda4003eb2 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.md index b9eea41f5bd..5332369a25a 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5b400eb042a..3e0de4f67b9 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.md index 8760b7e00cb..286e70356c6 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.md index c055d164d2e..f163e8ee225 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -157,7 +157,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -195,7 +195,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -219,7 +219,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.md index 53d5ecf4819..451ae61c86e 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Minimize the scalar function. @@ -101,7 +101,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.md index a9a07625b1b..fe623998017 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. @@ -88,7 +88,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.md index ca904cfb152..328c29647ee 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.md index f7674d9d30d..373badfe37a 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.md index 512dff17f72..e6e2ea03bbb 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.md index 6f6b883a70f..a808ede6653 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.md index 71d564e17bb..b09b89e5c84 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -104,7 +104,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -112,7 +112,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -120,7 +120,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -134,7 +134,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.md index 9112bcb649f..49cc8c414f7 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index b1b363deb91..858cb4a8012 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.md index e60f09a3fd2..795cf6fde1f 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.md index 27d800798f6..3620668e330 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. @@ -91,7 +91,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.md index 3ccebde9cbf..cd4b3f74937 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -125,7 +125,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.md index 24c12ba5973..6cc6ce7ef2d 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.md index fa26a0fd8ff..a8963f0daa2 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. @@ -91,7 +91,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.md index 4ff0f795d61..c035119efbb 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -104,7 +104,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -140,7 +140,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -152,7 +152,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -183,7 +183,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -206,7 +206,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.md index 645002b5c19..06947ca38c1 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. @@ -85,7 +85,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.md index 4ec95935cca..2ad304d8c86 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.md index a8062b6a8da..f1b06f47490 100644 --- a/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.33/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.33/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.33/qiskit.assembler.assemble_circuits.md index b5c27a11337..4ac7b9c079e 100644 --- a/docs/api/qiskit/0.33/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.33/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.33/qiskit.assembler.assemble_schedules.md index 8831c6baa64..99aec3a3913 100644 --- a/docs/api/qiskit/0.33/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.33/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.33/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.33/qiskit.assembler.disassemble.md index 1f62bc8fa7b..c23858c352b 100644 --- a/docs/api/qiskit/0.33/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.33/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.md index 8bb546fe338..c617606ba4d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.md index 99346207eda..976e3acdc50 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.md index 5fa424ac679..9a085c384bf 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.md index 09e365b467e..d161cadc8c5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -47,7 +47,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.33/qiskit.circuit.Clbit.md index 052b519df0c..709a6ae2ebe 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.md index e6d816132ae..83d634affbd 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.md index ee85588248d..7637ee69d84 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: `qiskit.circuit.instruction.Instruction`, `abc.ABC` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.md index 96d740b0e61..4cb2964bb20 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -224,7 +224,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Delay.md b/docs/api/qiskit/0.33/qiskit.circuit.Delay.md index 4d386ee5840..78f05f68913 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -203,7 +203,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -219,7 +219,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.md index b29808f4aa8..87398abd1c5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.md index 90ba918b8f2..eeb26f03878 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Gate.md b/docs/api/qiskit/0.33/qiskit.circuit.Gate.md index c9d0a9a07bd..32b96c71c4c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -212,7 +212,7 @@ reversed. -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -310,7 +310,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -330,7 +330,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.md index 5201ed3c312..69b7b0f3261 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/if_else.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` @@ -100,7 +100,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.33/qiskit.circuit.Instruction.md index 341ea85ea58..bf724a03151 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -87,7 +87,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -109,7 +109,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -133,7 +133,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -141,7 +141,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.mirror()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") DEPRECATED: use instruction.reverse\_ops(). @@ -159,7 +159,7 @@ reversed. -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -169,7 +169,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -193,7 +193,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -213,7 +213,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -233,7 +233,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.md index fb3b425d096..3c9c995ba06 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -85,7 +85,7 @@ This same instance of [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.c -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Measure.md b/docs/api/qiskit/0.33/qiskit.circuit.Measure.md index ccc45a3e42a..8e83202a679 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.33/qiskit.circuit.Parameter.md index 4832af4ccc7..8ab2bc0ff52 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -175,7 +175,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.md index c368a7285f5..4a2fd3645f1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.md index 3280ac65435..eef38ce14ab 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.md index 6559735cc35..071069bc168 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -139,7 +139,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -162,7 +162,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -174,7 +174,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -201,7 +201,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -301,7 +301,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -317,7 +317,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -344,7 +344,7 @@ copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -368,7 +368,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -380,7 +380,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -400,7 +400,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -425,7 +425,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -450,7 +450,7 @@ A handle to the instructions created. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -462,7 +462,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -474,7 +474,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -503,7 +503,7 @@ A handle to the instructions created. -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -531,7 +531,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -586,7 +586,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -610,7 +610,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -636,7 +636,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -656,7 +656,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -672,7 +672,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -698,7 +698,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -724,7 +724,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -750,7 +750,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -776,7 +776,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -802,7 +802,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -827,7 +827,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -856,7 +856,7 @@ A handle to the instructions created. -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -882,7 +882,7 @@ A handle to the instructions created. -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -910,7 +910,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -935,7 +935,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -960,7 +960,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -985,7 +985,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1008,7 +1008,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1028,7 +1028,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1054,7 +1054,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1105,7 +1105,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1179,7 +1179,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1202,7 +1202,7 @@ A handle to the instructions created. -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -1230,7 +1230,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1261,7 +1261,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1316,7 +1316,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1344,7 +1344,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1364,7 +1364,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1384,7 +1384,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1404,7 +1404,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1434,7 +1434,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1454,7 +1454,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1476,7 +1476,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1502,7 +1502,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1548,7 +1548,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1724,7 +1724,7 @@ circuit.draw() -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1830,7 +1830,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1853,7 +1853,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1939,7 +1939,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1980,7 +1980,7 @@ A handle to the instructions created. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -2004,7 +2004,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2041,7 +2041,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2066,7 +2066,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2088,7 +2088,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2117,7 +2117,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply `MSGate`. @@ -2140,7 +2140,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2160,7 +2160,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2174,7 +2174,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2190,7 +2190,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2202,7 +2202,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2225,7 +2225,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2246,7 +2246,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2273,7 +2273,7 @@ A circuit implementing this circuit raised to the power of `power`. -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2300,7 +2300,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2320,7 +2320,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2340,7 +2340,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2367,7 +2367,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2394,7 +2394,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2418,7 +2418,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2443,7 +2443,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2467,7 +2467,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2489,7 +2489,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2509,7 +2509,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2529,7 +2529,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2575,7 +2575,7 @@ the circuit with reversed bit order. -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2619,7 +2619,7 @@ the reversed circuit. -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2646,7 +2646,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2670,7 +2670,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2694,7 +2694,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2718,7 +2718,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2742,7 +2742,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2765,7 +2765,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2789,7 +2789,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2813,7 +2813,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3200,7 +3200,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3368,7 +3368,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3592,7 +3592,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3615,7 +3615,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3637,7 +3637,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3659,7 +3659,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3681,7 +3681,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3703,7 +3703,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3756,7 +3756,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3777,7 +3777,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3798,7 +3798,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3826,7 +3826,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3851,7 +3851,7 @@ A handle to the instructions created. -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -3874,7 +3874,7 @@ A handle to the instructions created. -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -3898,7 +3898,7 @@ A handle to the instructions created. -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -4044,7 +4044,7 @@ Apply unitary gate to q. -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -4089,7 +4089,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -4105,7 +4105,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4128,7 +4128,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4150,7 +4150,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.md index e6b318a0712..2e6d0b83de6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -47,7 +47,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.33/qiskit.circuit.Qubit.md index 60e37dc9c86..3855ed62f49 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.Reset.md b/docs/api/qiskit/0.33/qiskit.circuit.Reset.md index 49221b30c55..74f00654c2f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.md index 16c8787a3c3..a1e547fa4f5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` @@ -97,7 +97,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.md index fe9df7844ee..f162189978d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -306,7 +306,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -348,7 +348,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.md index 9456633e9c5..0d6fc6c30ed 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -302,7 +302,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -324,7 +324,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -360,7 +360,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 79745f5dd22..566d7245b2b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 2705eae1f00..995ccd85b3f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.33/qiskit.circuit.library.AND.md index 15ccf260a7c..171175d4cc6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.md index 4cea3d0c959..5a9c58b3af2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new barrier instruction. -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -45,7 +45,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -57,7 +57,7 @@ Set a classical equality condition on this instruction between the register or c -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.md index a69fa8a2fee..88b32cb935c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None, *, angle=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None, *, angle=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -36,7 +36,7 @@ Create a new 3-qubit controlled sqrt-X gate. -`C3SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C3X is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.md index 8748ef538fd..7ac520a0a7c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(angle=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(angle=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.md index 0aca19f541d..dfa5dabb15d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.md index 472b2b3faa2..9c3e58b9d70 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.md index 9f2ca382a05..5b33b91b895 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.md index 6d331c654cb..76bb1aa98cb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -70,7 +70,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.md index e929b1ae907..63b472fa143 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.md index 08c0e968822..bda196e95ef 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.md index 161cc8bc8b8..66d723d88b1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.md index 4af895d5c32..64527ac9f46 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.md index acb8da2d9a4..4ccbf6b7962 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.md index d00d3fcefea..8de5e6f2efc 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.md index 519752509df..0f31efa8455 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.md index 7366d134b25..19761918dc3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.md index 9337fa2c5e4..018e5f20a8b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.md index fae09586130..c20da7d5408 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.md index 4cf58c93de9..86196adf7c6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.md index 58fc95534a5..f952a57c360 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.md index 03f997d1d0a..abe5e782823 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.md index bcdd234f59e..5760f9a94b5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.md index e99fa10f814..bcf23efd941 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.md index e1205dc9a74..e21a2f19327 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.md index 08be5ad0026..1a6cc19024c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.md index d8201f18d51..fa566b471cb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.md index 609c2923b77..f27018d83fe 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.md index b1624b0a29b..2383f2b04b6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.md index d4df275b3f3..a377f587922 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.md index db7a60dee4b..a7e9af6020c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.md index 51fc11f0301..ba02891593c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GR.md index 546a3cf9c9d..466270db322 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.md index 022924c3639..87a8b53d46c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.md index 7fdd03aa3ee..d992826dc96 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.md index a62de415e5e..fb3e0f9f344 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.md index 30c502e58a3..fff35e8b094 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.md index 93687982603..2c7b3cbb936 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.md index 40d27084329..f16aa34c20f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.md index 82e8815e260..3a6e6c72a79 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.md index a0c6ffcf087..8b6cf801f8a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.md index 394972e55d6..18589266bc7 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.md index 60d8931ae2b..b0c4a48c4b2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.md index 575dc8b34e0..76d46236f2b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.md index acfc7417aca..79fb0d3e438 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.md index 651119a45a7..126194184d3 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.md index 240b3121c76..f5353cb8123 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.md b/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.md index 7f46a072a0a..8d58f87914f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LogNormalDistribution -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") +`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/probability_distributions/lognormal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.md index d60754783b5..d79bd94b529 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.md index 21367a20065..76b5482567e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.md index b673905762f..0cb1344e128 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.md index 99405948048..cafd8b51c37 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -60,7 +60,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.md index 18bf510090e..97606c4a426 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.md index 1311dc47733..f6cca9b684c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.md index 66d4af2ad74..f391dd975f8 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.md index d914eaf633e..067fcf2c78d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.md index 0fc12b7fab9..04a6506165e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new measurement instruction. -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.md index ef5ea7d1d66..6980f3f2177 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.md b/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.md index 21e1d051027..ea749291299 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NormalDistribution -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/probability_distributions/normal.py "view source code") +`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/probability_distributions/normal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.33/qiskit.circuit.library.OR.md index fb6d6a751b0..3e2b1db97ef 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.md index 6d367a65f48..1fdf6612468 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ $$ -`PauliEvolutionGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/pauli_evolution.py "view source code") Invert this instruction. @@ -71,7 +71,7 @@ a fresh instruction for the inverse -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.md index 04f9668cdb5..d888fdc0160 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.md index b2749a3a166..6800c108ee2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.md index 60376781a01..c974bc44e16 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.md index b04ed3c4454..899855ede48 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.md index 5680278dba6..6172a94760b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.md index b166749940b..36d18759f7f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.md index e8143edb071..95b910cd372 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.md index cc8a197b5d5..64cd597ed83 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index ed559ccbfa0..1ae9c10e0c6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 243cd3856f0..0acbb2c338c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.md index 55a861be6bb..f017740ad5b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.md index a9f9708b970..65fe1a66656 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.md index b75281fb62b..59457b8a046 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.md index 4003cc5dd7d..1f3fa9a0ac7 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.md index b4bf716097b..0fc38b24054 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.md index a9b6957aca8..d3874a386b7 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.md index 4b045974370..1b95c46c25d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.md index 4708a1252c3..7f192cbf83b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.md index f1dfdddbed4..b5abc8a4bcd 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.md index 879ec7d0105..aa1ff09bd81 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.md index 0ac0266c123..1c733cf33c1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.md index e5f929aa1c4..7196836bf2f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.md index 85fbc9a64c0..a2dcb9e7bd9 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.md index 528f29a0456..3b6ae7a8a14 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.md index 0170a1c8105..c7af8495061 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.md index 3bec5718508..2aff018e218 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.md index b08ee6c3d7c..fbd8993c39f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.md index 9d7a6321fda..fdbf7c74f32 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.md index ca1e5e43074..6f274f010c4 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,7 +24,7 @@ Create new reset instruction. -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.md index 7050ef298f5..048440e4c92 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.md index 693032051a7..21b68ad60d8 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.md index 154aca541d3..9a3fb354d2a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.md index 3ce71beeb3b..1343d7e1d7e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.md index b035cdef78b..9e6d04a937e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.md index da173cbc526..922ee4e620b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.md index 2edbd58279e..9f62e0859ef 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.md index ae63764809b..148b4a59509 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.md index 6396374c849..502666d4941 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.md index 83a7ce0dbe6..c2c820b07a0 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.md index 2591df24658..173d98eed9c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.md index 412e6c87305..02dc1bfe659 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.md b/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.md index 51283b173b9..1c8b8e3c609 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UniformDistribution -`UniformDistribution(num_qubits, name='P(X)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/probability_distributions/uniform.py "view source code") +`UniformDistribution(num_qubits, name='P(X)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/probability_distributions/uniform.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.md index a937421f332..4814017dafb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.md index 1aee9e39343..044ef9a643b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.md index 782a8f59175..49b1c8423f5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.md index 64e3675bf4a..b96852f6a9c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.md index 0d048b6b8c7..8b0789f7081 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.md index 6754b5a3479..b2dc069163f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.md index 8bcbfb562b0..63e351dd8a8 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.md index 94622026a49..31c3fd17341 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_1.md index 5fa33697eb8..0eda0589d72 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_2.md index a16c239a722..2603429b5d5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_3.md index df622c0d8e8..ee4c23d7233 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_4.md index 238d6f0ac3d..2ef4c38814b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_3_1.md index 580c8261fd7..8241d64764a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_1.md index f194d68787f..414e5340fc1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_2.md index b11dac741f7..a0261e4d676 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_3.md index 3eb5d54799e..0162a6eadfc 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_4.md index dc05d3e7ba9..98f1e21180d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_5_1.md index 5074d568843..0c01497652f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_1.md index 9b28896896b..43f0df6ae0d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_2.md index 8e41e459269..d5234e41b73 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_3.md index 7062b0fb226..6e19f8dc928 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_4.md index 0d05208d9fd..28a7e78a0cf 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_5.md index 454c2c8a323..0c1047a271e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_1.md index f2ad204aea8..204ed8a1fef 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_2.md index 4a3e5fbe3f0..63d9856ce14 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_3.md index 41df75c5ec9..9ab26982933 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.md index d5585b35e53..507950a9406 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_cy.md index 855746017d3..7ad1537176f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_xz.md index cec4550c82d..a58aa6fe4ed 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_yz.md index 524dd792356..544f317d442 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz1.md index c6ebc38ed7b..d7341a2f850 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz2.md index 92189895659..618bd631979 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz3.md index e849d554ee8..43859301133 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 6085db2daea..8acda85d6b6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index fa88af599e2..2b2a06c2dfb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index ea043cee30a..1f4d7b971f6 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 86004e06cf2..ff9d85c2041 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 0cca7746a83..779db89e585 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 6f52490eb97..8cf8dec3974 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 0ef8aa65a18..57e1a6c7214 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 52bb629c954..97dc27c1caf 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 909178d922c..133b4a94eb1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 8d144399a4a..acf5b27a5bd 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 03761cb65b0..cf92371a7e1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index 4b86a8844b9..133a23a353c 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 3f835ddc3c2..1fd3cb7fd73 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 5e7465f3c6a..3a1ad48f908 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 1c7de3071d0..9a8dadee005 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 42fb6e1ace1..b94f9e0dab1 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 9fc3f9456f3..b5d4536addb 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index 1be66623cc8..ca92ccf9276 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 0ce603cfc19..79b90197856 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 5775022bc06..3c5a44517c2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index c5c11ab14d6..6101fee8c22 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index dbe9a81f8d9..400319ef5f2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index c30ddbb8dd0..739a6585241 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 781d895ee6a..46723f1c5da 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 6a47753e23f..5db5e9e990f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 2999d6691a1..caa6f5bef52 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 15a84289ad7..2be5b608ecc 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 66eb99b19c3..2029e034500 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8f9d12dd0de..f16a7006ba2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 2b2889bc044..d078e3fd2f2 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index de72ab0a96e..c30ad65c41f 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index eb97f5c96ce..6e7c36a5819 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 559b9e377af..60635bf7913 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index a7888991cb1..db071a2a8c9 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 46eb7c01f4f..e1ad4de2023 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 64e417765da..b8911e022ea 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 620caa8b522..0f0013ee61a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 3075a9c35e6..7ded2866e02 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 6da6d114246..f0c6520c0a5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index e1b4dccb6da..1001daa832d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 88b891f59ac..a1d542768f5 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 50f689276b5..c13e8eab3ac 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 010d5e11d40..55d754b4b0d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index d578c0bd1f8..8d9c15f7f19 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 7152f1d5631..228f734da1a 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 28c609e6df5..c6136427d4e 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 790e878514b..83c3b7a7b34 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.dump.md b/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.dump.md index 91d4e305033..9cc56935806 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.dump.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.dump -`dump(circuits, file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/qpy_serialization.py "view source code") +`dump(circuits, file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/qpy_serialization.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.load.md b/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.load.md index 79dacbbbfe0..61036f0d27b 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.load.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.qpy_serialization.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.qpy_serialization.load -`load(file_obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/qpy_serialization.py "view source code") +`load(file_obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/qpy_serialization.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.33/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.33/qiskit.circuit.random.random_circuit.md index a6769dee5b8..df77372d47d 100644 --- a/docs/api/qiskit/0.33/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.33/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.33/qiskit.compiler.assemble.md b/docs/api/qiskit/0.33/qiskit.compiler.assemble.md index 3fc008c5b95..58a30298506 100644 --- a/docs/api/qiskit/0.33/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.33/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.33/qiskit.compiler.schedule.md b/docs/api/qiskit/0.33/qiskit.compiler.schedule.md index 1af45522678..f5da25ff24a 100644 --- a/docs/api/qiskit/0.33/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.33/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.33/qiskit.compiler.sequence.md b/docs/api/qiskit/0.33/qiskit.compiler.sequence.md index 66384157a6d..8e1b0a9ca61 100644 --- a/docs/api/qiskit/0.33/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.33/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.33/qiskit.compiler.transpile.md b/docs/api/qiskit/0.33/qiskit.compiler.transpile.md index 701ef72e163..f65c855d5b8 100644 --- a/docs/api/qiskit/0.33/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.33/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, pass_manager=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.33/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.33/qiskit.converters.ast_to_dag.md index aa9319b358e..a11ac0ff31d 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.33/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dag.md index 326f20f114c..32f67e1123e 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dagdependency.md index 9c516d3898f..40abfdca42b 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_gate.md index debfc16c2e6..1bb2739afb4 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_instruction.md index 39590f5968f..93bf567b586 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.33/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.33/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.33/qiskit.converters.dag_to_circuit.md index 10ea1eb3903..48e9c553b7e 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.33/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.33/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.33/qiskit.converters.dag_to_dagdependency.md index ed118402627..adf79798726 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.33/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_circuit.md index 916ae9b2226..a4e9b2103b6 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_dag.md index b69448769fd..39154d8baa5 100644 --- a/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.33/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.md index a44eb3e6181..0347e91857c 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -215,7 +215,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -225,7 +225,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -237,7 +237,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -245,7 +245,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -269,7 +269,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -291,7 +291,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -318,7 +318,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -326,7 +326,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -342,7 +342,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -350,7 +350,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -370,7 +370,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -378,7 +378,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -386,7 +386,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -400,7 +400,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -408,7 +408,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -416,7 +416,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -424,7 +424,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -432,7 +432,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -452,7 +452,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -464,7 +464,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -485,7 +485,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -493,7 +493,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -501,7 +501,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -509,7 +509,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -530,7 +530,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -538,7 +538,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -546,7 +546,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -554,7 +554,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -562,7 +562,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -570,7 +570,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -578,7 +578,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -594,7 +594,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -607,7 +607,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -615,7 +615,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -623,7 +623,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -631,7 +631,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -641,7 +641,7 @@ Add edges from predecessors to successors. -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single. @@ -662,7 +662,7 @@ This is used to consolidate a block of DAGOpNodes into a single operation. A typ -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -678,7 +678,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -688,7 +688,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -696,7 +696,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -723,7 +723,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -749,7 +749,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -757,7 +757,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -765,7 +765,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -785,7 +785,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -807,7 +807,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -815,7 +815,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.md index 5d9edf9cf5e..3e1fd14bdad 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.md index 9c7952bbdac..92680e3cdd2 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.md index e5e175fa966..fb25bd8a1b4 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.md index 2ac3232a05a..fb5a94aa713 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.md index 8e51bce209e..f3710c31bbb 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.md index fd8c197a3d0..e4a8b7a911b 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.md index 8a0b366e77c..59124c4351d 100644 --- a/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.33/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.md index 76ad2cacdef..982b6db6e3b 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.33/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -331,7 +331,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -339,7 +339,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.33/qiskit.extensions.Initialize.md index 066999260d6..167ac6b5cd0 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.33/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -60,7 +60,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -115,7 +115,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. @@ -255,7 +255,7 @@ bool -`Initialize.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/initializer.py "view source code") Initialize instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.md index 55422e56581..e95d6598a18 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.33/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -315,7 +315,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.md index ed6d7ae4808..511baf916b1 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.33/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.md index 566a55dc24f..78d2465e36c 100644 --- a/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.33/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -124,7 +124,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -132,7 +132,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -181,7 +181,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.md index b6a065421b3..f7bcabbf999 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.md index 445940b2453..cb4c05d6690 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.md index 72390a7400f..f1dd548a089 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.md index 8e34b105743..34bb022876f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.md index 6d992298e71..0fb7f2385e9 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.md index 34fb34bbd65..f249e3e7a7c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.md index d6a0edbb6ec..973f43032e3 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.md index 372f017addd..28a066d8ce8 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.md index c0278abfc7e..207580331a4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.md index f6032306e0e..0d5de5146a4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.md index ca32ce2a39a..391277c14a8 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.md index d5ef72ada1e..15ccd84be1c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 403817016d4..53d9fc2448d 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_cx_circuits.md index 09dc059db30..23052c4321f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_1Q_circuits.md index bea081fef35..7457a6a8d7b 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_cx_circuits.md index fff2b94403d..26d2f78212f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.drag_schedules.md index 0af961d3c2f..7352fe740d7 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.get_single_q_pulse.md index dc53d3a0226..4f6fbde2321 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.rabi_schedules.md index 42ea4ca52bd..aa0bbcbf677 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.t1_circuits.md index 508ad9af4d6..e4a3cc2e03c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2_circuits.md index 04c20edb55f..b9f20d4cbd3 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2star_circuits.md index fd7a3a9313e..0fae4900b05 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.update_u_gates.md index 5d9b1fa3315..d72811bf256 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.33/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.characterization.zz_circuits.md index 1188ca79ac3..02ca087303c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.md index ad2fef2c8f5..60d8b19a375 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.md index baf6d1a8ded..8611b4ab8e4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.md index 0b95a9f7a46..ab74a5b494f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.md index 0866faeff43..86c1b8d75a0 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.md index 877a0613248..6b0aa21b2f1 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.md index ef7794ad9f7..3df5b0cd935 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 10b24aab347..5e3982fea64 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.md index baa69f9e0b9..54bb0a1ba3c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 1f75d6df980..46a867616d4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0d3f8eb3543..78443ccf05a 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.md index f8ee6953663..0edea69dc53 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index f56948c221f..a0afa4a5ebd 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.md index 083559659f0..c9ed1e0fe59 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 15ee8da8a10..fa11407f7b0 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.md index bfa7ac5af6d..afe433ce0ec 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.md index e8f9921e866..a9dae640d04 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.complete_meas_cal.md index d8e9218ffdd..5108e210fec 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expectation_value.md index a235ad984f0..4709cbce409 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index 484c9ac6867..90a90a2c637 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.tensored_meas_cal.md index 2c0591998d6..c09b4736d27 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.md index 0a5224159fe..cb2f7b29eb2 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -59,7 +59,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.md index e99c8d57b07..9e28ade246a 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Data can be input either as qiskit result objects, or as lists of bitstrings (th -`AccreditationFitter.AppendResults(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.AppendResults(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single run of accreditation protocol, data input as qiskit result object assumed to be single shot @@ -49,7 +49,7 @@ Single run of accreditation protocol, data input as qiskit result object assumed -`AccreditationFitter.AppendStrings(strings, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.AppendStrings(strings, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single run of accreditation protocol, data input as a list of output strings @@ -63,7 +63,7 @@ Single run of accreditation protocol, data input as a list of output strings -`AccreditationFitter.FullAccreditation(confidence)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.FullAccreditation(confidence)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence interval desired. This protocol is from \[1] and fully treats non-Markovian errors @@ -87,7 +87,7 @@ dict -`AccreditationFitter.MeanAccreditation(confidence)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.MeanAccreditation(confidence)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence interval desired. This protocol is from \[2] and assumes Markovianity but gives an improved bound @@ -107,7 +107,7 @@ dict -`AccreditationFitter.Reset()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.Reset()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Reset the accreditation class object @@ -115,7 +115,7 @@ Reset the accreditation class object -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") DEPRECATED-This function computes the bound on variation distance based and the confidence :param theta: number between 0 and 1 :type theta: float @@ -127,7 +127,7 @@ DEPRECATED-This function computes the bound on variation distance based and the -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") DEPRECATED-Single protocol run of accreditation protocol :param results: results of the quantum job :type results: Result :param postp\_list: list of strings used to post-process outputs :type postp\_list: list :param v\_zero: position of target :type v\_zero: int diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.md index 4fc927ea9fa..7173a7fad94 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.md index f916cb66faf..d0557c6955a 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.md index 583deb9126f..c60cbebb3a7 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.md index 304851b8e69..5cd02b0fd01 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None, brute=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None, brute=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results, logical='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results, logical='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. :param results: A results dictionary, as produced by the :type results: dict :param process\_results method of the code.: :param logical: Logical value whose results are used. :type logical: string @@ -52,7 +52,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -72,7 +72,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -92,7 +92,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -116,7 +116,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.md index 904bf41bcce..2e320a8d621 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.md index 546ec4b3d0a..d17997d3f38 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.md index ac47c456f8d..32fd28d2bc6 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.md index d5895121282..2a93804ae9b 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTP.md index 73b24b6b443..94055214d79 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectCounts.md index a01de06d5bf..c65ef987a54 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectString.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectString.md index e17c285b023..bcda1ea7fb5 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectString.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.QOTPCorrectString.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectString -`QOTPCorrectString(qotp_string, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectString(qotp_string, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a measurement string, shifting the qotp diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.md index d727c76d29c..ffda35caa18 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.md index 88a92ae06e8..7aeb89808e7 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.md index 46b369b81ad..cf96f6d2bdb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0, xbasis=False, resets=False, delay=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0, xbasis=False, resets=False, delay=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -50,7 +50,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -74,7 +74,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -82,7 +82,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(final=False, barrier=False, delay=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(final=False, barrier=False, delay=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -96,7 +96,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.md index 943b23e550a..6d75bf220ce 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.md index 508c52aef7b..1d6f0728a6d 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epc.md index c438e74ea51..6a21000a800 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epg.md index d5722d92327..a3233d6c5f8 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epc.md index 72dfdb86c02..d31054f275f 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epg.md index 8144d7203da..67a3f8aaf54 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.coherence_limit.md index 03981397ec3..80526b35de2 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.combine_counts.md index 2ebdbacad89..9e8adbdd4c9 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z.md index 80e7bf056b5..28715965b77 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z_expvalue.md index a7ae10b833c..c04f146899b 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.count_gates.md index 44b548665be..850c6feec6b 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.count_keys.md index 6f44c215679..bb417e61fed 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.expectation_counts.md index 975c0154436..1f2256aeb5c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.gates_per_clifford.md index 30006e27eb5..6ef3542be57 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.gateset_tomography_circuits.md index db01bf2a76f..27026f4adea 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc.md index 5b5131afc30..4f255fd9f2d 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc_para.md index f4dd3e599c9..3358ebb30cb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po.md index c3804f6fb55..e70e4458ea4 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po_para.md index 3000fbba603..97b6773cbdb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_simple.md index 034766ed548..3f5471787bb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.lookuptable_decoding.md index f0dd6c9571b..44e5019912a 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.marginal_counts.md index 5389acadc83..7ee9f59cc18 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.ordered_list_generator.md index c1e174d8460..baa787e47d6 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.postselection_decoding.md index 60df02a7ab6..50215c213dc 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.process_tomography_circuits.md index 468696a3fb2..ba1ef665a33 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.qv_circuits.md index 471a2aadfc2..cb96d7e931c 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.randomized_benchmarking_seq.md index d0db986adbc..d0d740ecefb 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.rho_to_fidelity.md index 882eb7fb26c..1576597133e 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.state_tomography_circuits.md index 8ebd16870cb..6e232437363 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.twoQ_clifford_error.md index 20364819a15..36eb1281be7 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.md index 6a8b10f44c1..08722075adb 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.md index 116dcb98b08..8588024ddda 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.33/qiskit.opflow.anti_commutator.md index 63df1be9ad4..4965cae510c 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.commutator.md b/docs/api/qiskit/0.33/qiskit.opflow.commutator.md index 8f1815cb676..333b6ac206a 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.md index 788911f7b44..3170003afeb 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.md index 6d52a539fe0..3bad5b21eaa 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.md index 1d5ffc4ff59..3830c9af820 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.md index d04a0073898..826abcda6e5 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.md index f05903e4285..9ebce7e9c90 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.md index 358d5de3e88..5539fe8ea01 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.33/qiskit.opflow.double_commutator.md index 8301be23826..edbed1d2214 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.md index 91372f20282..7875cf96df5 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.md index 92252c00f32..16d39d7e0f9 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.md index 0f0cecd9a3d..deb9aa4ded9 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.md index 451ed2fb3fa..33c139a8206 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 6b46e523ab8..a050527aef5 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.md index 794a873e534..ab3c1c58e2e 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.md index 974e198338d..4a91f1719f6 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.md index 8e8555829dd..76c22015b5d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.md index 33ad5bc4549..60fcceae815 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.md index b6b3a4133c8..a7dc5e9eed1 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.md index 59728f7865c..2e9e3e3ac11 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.md index 249e4aeaf06..1a8ac5a270a 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.md index 3ddb463cc63..d50b45defc3 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.md index f7fb5482085..1e3bd1a6652 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.md index 1bfa6b12952..04b928f0843 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.md index fe92d254d0c..49ce398b619 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.md index a72201fb516..349b7948e52 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.md index 21b6ab560b3..9d58f61e3e0 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.md index ce15c03b4bb..de9e53d3470 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.md index 40267003104..9a0807da985 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.md index d838fa483f6..94ab921d10f 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.md index 4eb91562538..6cf5fe8637b 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.md index fd867ab80f8..e8417e78394 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.md index 28457387f23..221d91b334c 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.md index 3e59721f214..02b69956f8d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.md index bba7776641c..d56c770e15b 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.md index d1855587408..38736ab4534 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.md index e93646eedf7..53e63a7511f 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.md index 9a345badc42..9deba17c2db 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.md index 27a01c19385..0f5bff3cb86 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.md index 92d80b9c9f3..9cba44d6a82 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.md index c6e75320c40..09576b21c10 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.md index 34324a0c865..45e91cdc7c6 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.md index ccf29d47a11..58a64a55d43 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backend by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -181,7 +181,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -193,7 +193,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -215,7 +215,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -235,7 +235,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -259,7 +259,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -275,7 +275,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -296,7 +296,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.md index a76ad1f3637..c7f60dc16b7 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index fc61687ee3c..919cebc961e 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.md index b18bdaf1527..38b583dd203 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -57,7 +57,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -65,7 +65,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -81,7 +81,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -89,7 +89,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.md index 10dafcc415a..81596a606b7 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.md index 58b25b45207..dd41af330d8 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.md index 14d5e655e32..b6662f8d462 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.md index 313b456d62c..887851ed234 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.md index 796dca12047..e3c143e42f7 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.md index bea3d1569dd..dae75a1af78 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.md index 707470648e1..afbb1993aad 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.33/qiskit.providers.Backend.md b/docs/api/qiskit/0.33/qiskit.providers.Backend.md index cc885d96365..f4fd31a71ab 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.33/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.md index fd8a66b704c..6f51c8755dd 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.33/qiskit.providers.BackendV1.md index 4efb0aa6b1a..4b5b739f873 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.33/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.33/qiskit.providers.BackendV2.md index adc26dc5e9f..9936ead9304 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.33/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -43,7 +43,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -65,7 +65,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -93,7 +93,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -115,7 +115,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -137,7 +137,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -159,7 +159,7 @@ If there are no defined or the backend doesn’t support querying these details -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Run on the backend. @@ -182,7 +182,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.md index 3b96d5e28f7..11d124a1df1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.33/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.33/qiskit.providers.BaseJob.md index 281ad58f474..33ba9506333 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.md index 0d2252d7a70..04318b52cce 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.33/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.33/qiskit.providers.Job.md b/docs/api/qiskit/0.33/qiskit.providers.Job.md index 6c7ecd99200..884b94347cf 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.33/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobError.md b/docs/api/qiskit/0.33/qiskit.providers.JobError.md index 1eda1168245..62c055a1cda 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.33/qiskit.providers.JobStatus.md index 5777f9fb5ad..36be333fdeb 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.33/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.md index a9119d088db..e1a026f0b57 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.33/qiskit.providers.JobV1.md b/docs/api/qiskit/0.33/qiskit.providers.JobV1.md index 7ecaccfdf07..66411c12552 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.33/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.33/qiskit.providers.Options.md b/docs/api/qiskit/0.33/qiskit.providers.Options.md index 018242280a5..9a16982abfa 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.33/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.33/qiskit.providers.Provider.md b/docs/api/qiskit/0.33/qiskit.providers.Provider.md index c37d48836d8..752f0fd35dd 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.33/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.md index 77ac440d0db..c689df13095 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.md index 82639e1f4bb..acda0f4a14a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.md index 5ef8d5269dd..aa0ab431436 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.33/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.md index e73f1efd60e..edbb37c6d86 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.md index 26bfd13c4cc..199c977d93a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.md index 45c4620db2a..b95040a3336 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -160,7 +160,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -168,7 +168,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -184,7 +184,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -218,7 +218,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -226,7 +226,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -314,7 +314,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.md index 35c5903ba27..0f6694ec091 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -147,7 +147,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -205,7 +205,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -231,7 +231,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.md index 9bccd150d8c..46d4271a9e9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -139,7 +139,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -147,7 +147,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -163,7 +163,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -197,7 +197,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -301,7 +301,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.md index e0deb4d929b..216939d1cb4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -73,7 +73,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -81,7 +81,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -227,7 +227,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.md index fe9fd1e7e12..e2defd25c5a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.md index e4200ef4094..bfc1dc67fe7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -111,7 +111,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -119,7 +119,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 57c7c9a6840..316752327db 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index f8721414d08..6ad1d6bbbaa 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.md index c04decb201d..0f24b6dfa27 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.md index ee574a6e866..8067b7d20a8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.md index 5cef94b6d27..7e9c04cfe0a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.md index 769df845673..3fa77df13d8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.md index 354de533212..2643ef10f37 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.md index c076a867c25..a491b732295 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.md index 761a3c8e39e..7d2cd61c50d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.md index 651f3b9802e..42b86325d80 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.md index bd4efd9ba78..f3021914edb 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 7b8335f8ba0..7febd2d6674 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.md index 07b17239934..7d627994328 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.md index d702619c483..f07ae2fce86 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.md index b79f699d002..d6b4a7bc00a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.md index d4de5dd2683..c96e623cbb4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.md index 83ae97c396a..a3bdb399c54 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.md index 5bc57137c20..1c27a3cb80e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.md index 44f8268a26b..ffa7c9b3fd5 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.md index c167f768eda..08fa66151d9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.md index 2f85bad79e5..473d9e88d46 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.md index 383fbc06fda..3eb0f49d9ff 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.md index c4fa0bd73a8..4a211251b36 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.md index 2e4ee91ebb9..676a78d48ef 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.md index 4bb5a2764ec..4b509551229 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.md index edf52852f18..de888ffac4d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.md index d58e11772a8..01d17d21c05 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes.md index d0fd751daa9..f6f88f92a8a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes_squared.md index c8e82191ee3..9e69b08814e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_density_matrix.md index c292865e173..b7fe6d72ad4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value.md index afb0aa6b5cd..b5d6c393030 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value_variance.md index cad935698d1..540f5a6fa5c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_matrix_product_state.md index ad9329fb5b6..042515e636f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities.md index 98709e41a00..c74bc7fb192 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities_dict.md index 232f5123a85..1d2c6e7628c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_stabilizer.md index caa96c0dad7..c9bae83161e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_state.md index 5b43901211e..38b617016f0 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector.md index 910688c4069..25ff84a6e48 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector_dict.md index 3e042263bd0..af529254e93 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_unitary.md index 3900cf9ef44..d223f5969b0 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_density_matrix.md index 62f93bfba5c..04a01d89e8d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_matrix_product_state.md index 07cb9ac48f9..0fe380ec195 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_stabilizer.md index 47ce108bc7f..ca1043a2443 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_statevector.md index caf2c8ae80d..97f9f6e64c8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_superop.md index a71d2be2b79..2de685817f9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_unitary.md index 318fc9eccab..e6946858c46 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.md index b7e7e1dd885..591edcd2526 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.md index be262c84116..ff22ab5d765 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel other \* self. @@ -85,7 +85,7 @@ The composition error channel. -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -93,7 +93,7 @@ Make a copy of current QuantumError. -`QuantumError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the composition error channel self \* other. @@ -118,7 +118,7 @@ The composition error channel. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -143,7 +143,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -167,7 +167,7 @@ the tensor product error channel other ⊗ self. -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if current error object is an identity @@ -175,7 +175,7 @@ Return True if current error object is an identity -`QuantumError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the compose of a error channel with itself n times. @@ -199,7 +199,7 @@ the n-times composition error channel. -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -207,7 +207,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -215,7 +215,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product quantum error channel self ⊗ other. @@ -239,7 +239,7 @@ the tensor product error channel self ⊗ other. -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -247,7 +247,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -255,7 +255,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.md index b2ceb8ec9cd..98829a8f1d2 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -53,7 +53,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -81,7 +81,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -89,7 +89,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -114,7 +114,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -138,7 +138,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -146,7 +146,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -170,7 +170,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -178,7 +178,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -186,7 +186,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -210,7 +210,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -218,7 +218,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.amplitude_damping_error.md index 8e9e6295d9e..dd2ff84f6d0 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.coherent_unitary_error.md index 75525914a49..84e4b8ec014 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.depolarizing_error.md index 85a1d7c9498..68d139e8b8c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ee7da332025..25ae7882329 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=True, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index f364dd25f2d..3b481f5b563 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_error_values.md index 3ae2a2ff174..d0943efa790 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_length_values.md index 1b13b72489b..892fe67f613 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_param_values.md index 918d4b8a054..93fb9036ea3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.readout_error_values.md index e59808902fb..0fadf024f1e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index 0bacf85f54f..4785b2029bb 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.kraus_error.md index 44ca93fb5ca..90bd27c8bba 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.mixed_unitary_error.md index 3d5c9582a90..111474c892d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.pauli_error.md index 6d368a98133..ccfd737e3c1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index 1e5fd78c8b6..a2f2c78e418 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_damping_error.md index ef2fd39829e..4b71083d507 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.reset_error.md index a254e39f831..63de275e22f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.thermal_relaxation_error.md index 677c791119f..36c3b22a0d8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.md index f80a4e6e134..65f4da8ad16 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.duffing_system_model.md index 24d251b1714..d6036ef8fd1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.md index a79f3f36e95..4e5fc535530 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Transforms one quantum channel to another based on a specified criteria. -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_noise_model.md index 6ac6827b3e9..1ca9fe60950 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_quantum_error.md index cd5acf0deb7..ca9a30e2885 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.insert_noise.md index c9c0300ea59..c29fc6f23ab 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.remap_noise_model.md index 64a6012ca37..8bbffc11ecc 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.33/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.md index ef983b6b00c..92ce1f88d17 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.md index e5023d4d2b4..bf2baa4a8fa 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.md index 29bc0dce1de..94c62f32639 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.md index 9d8ad7fb073..6a955fe3e8c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 6ed6dcefd2c..d72bface678 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.md index 892e9fbb129..86ce2710404 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.33/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.md index ee377ff4552..080fed9feef 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.md index 85016b461db..27ee177b989 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index f32e6661621..142488e7e63 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 4f297b21f45..3ee143a7fbf 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index d5033de02b1..ec2b2ff9ece 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 657ec0e7086..e57c1ea3508 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.md index 24aff3b033d..162460e4350 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index eed050ae3bd..0503262f823 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.md index 0d53acc2879..a9f9fc174c1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -475,7 +475,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.md index 4bdd0f2a060..3c7104091e7 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index c041bbf3bf6..cc590ceedc4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.md index 6dc463b2421..0f3eb783aa8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.md index eb24ee9f625..9893019fc38 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -159,7 +159,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -175,7 +175,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.md index 86f9c45a3d5..9fbc296f482 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.md index 41652141dc8..653ebcaba50 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.md index 6e647420f52..da8eb8f9ae0 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.md index eb4cebba7e4..f25a610ee3e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.md index 71d9c42f83f..3e1c60596ad 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.md index 78ec3d1dfb1..0bc0d7a3aa6 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.md index 04f279e0cd1..15321015cab 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 4f851752dc3..2df20de8748 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 08f3dd7e2c4..3233af88348 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.md index f954c886cda..1d6c1e5120a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 53f323ab1ab..57f08b83f90 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c2b7202cfc0..51a853d365e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.md index b160d6165e9..964dd419d39 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 1dc23cd056c..ee2630368f8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.md index 3d88360d8d8..014b28bf5ef 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.md index 7d91f3308c2..4778d5d52bc 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.md index dbf01e8af0b..be17ce9e5c5 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.md index 1da1f4b7bfe..a8d7a644cc9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 48bafa04842..2be074447b3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 740582bb1ce..b7cedbeec8f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 9078ea34ddf..608b47aa837 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.md index dddd6edda94..62fb25d7f62 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.job_monitor.md index 56ec96af801..bfce901433d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.least_busy.md index 60d12dd3e3c..438b1da7267 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.md index 0888b9afcd2..b0ef32a0af5 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index d89c8d9ca6b..501d8826c4c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 8ce6b93b8f5..48e1f0b6e9c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 83cc49d15fa..62fa44f7e9f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 2d51d9d9f15..5dda3344b39 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 944b4b473e9..ef871dc887a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index c3dbd53a191..49f863db3c3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.md index bb0c317e8c0..30d26bd4a7c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.md index 80baee65fb7..6e87d25958e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.md index 3591537cc7a..aabdf063346 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.md index 5298496e3cb..22dc0c14329 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` @@ -49,7 +49,7 @@ BaseRandomService constructor. -`CQCExtractor.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Retrieve a previously submitted job. @@ -69,7 +69,7 @@ A `CQCExtractorJob` instance. -`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Process input data synchronously. @@ -95,7 +95,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the first extractor asynchronously. @@ -122,7 +122,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the second extractor asynchronously. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.md index 1641499d8ce..f578a084e2c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ CQCExtractorJob constructor. -`CQCExtractorJob.block_until_ready(timeout=None, wait=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.block_until_ready(timeout=None, wait=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Wait for the job to finish and return the result. @@ -70,7 +70,7 @@ Extractor output. -`CQCExtractorJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Query the server for the latest job status. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.md index abc92c11bae..4a3f981d3bd 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ IBMQRandomService constructor. -`IBMQRandomService.get_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.get_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return the random number service with the given name. @@ -60,7 +60,7 @@ Service with the given name. -`IBMQRandomService.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return all random number services available to this account. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 0cb641d0679..e39ed872192 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.md index f7097ba33fc..a20d4c57991 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.md index 5a29db09af8..b298f71d3ef 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9cdaa136c33..efa85d6c02c 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a2dd9a65d86..e889c6db58a 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index baee1780106..08990c0507e 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.md index 98706a664ff..3a6a6148fc8 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 373af1cfb82..68152ef5044 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.md index 9b54f2fc279..5f60edd2c6f 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.seconds_to_duration.md index 8d21231dabf..c1f60744b78 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.to_python_identifier.md index 44ab31ee0c5..9fa8bc0baa4 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.update_qobj_config.md index c126d25f613..ff1f78e53d3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.utc_to_local.md index 2ad496aa570..da6c598463d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.validate_job_tags.md index b96de6d5ac2..a8f10ceb6a0 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.33/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.md index 4ef91363209..e0262b56e74 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.md index e0b7b625a6f..87a0329d1a3 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.md index f7fd0cc15ae..e734584ba61 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.Command.md b/docs/api/qiskit/0.33/qiskit.providers.models.Command.md index 8998d370a91..f273be4a7f1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.md index a05a90a3e4a..a5f5e70efca 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.md index d452cfd0c16..c350d844ad1 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.md index aaa11b85720..de1b6c192aa 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.md index 7ce3c676e04..73016c29357 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.md index d3b4958d536..e6aedce31e9 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.md index 2abdd71a502..8ba0c2f268d 100644 --- a/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.33/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.md index 75b8189193e..2da4994b906 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -159,7 +159,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -182,7 +182,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -204,7 +204,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -228,7 +228,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.33/qiskit.pulse.Schedule.md index a29d505b190..cce1e8d3a2c 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.md index f490431afef..2a20c4c9e9e 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -172,7 +172,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -205,7 +205,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -236,7 +236,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -258,7 +258,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -283,7 +283,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -295,7 +295,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -307,7 +307,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire.md index fa67e4ba3d7..a68992bbba1 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire_channel.md index eef7ff624ab..bb5f75c74d9 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.active_backend.md index d5d4c00b9b5..f6373e81d9f 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.active_circuit_scheduler_settings.md index cec0d96becb..9c66dd59400 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.active_transpiler_settings.md index cc13fb2e123..f8809d48967 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_equispaced.md index bf500436cda..f3eaaa1e13b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_func.md index d7c7b37e0f4..f365d374b2c 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_left.md index d0e669ed26f..3627d9ae46c 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_right.md index d9f004bea79..fefdb0d9bc0 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_sequential.md index 37b25ab958a..60d4e85572b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.barrier.md index eae18e7fb7f..4503708c203 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.build.md index accbf270ca3..4cfda7d5b8b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.call.md index a75f35054fd..4dc0a689589 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.circuit_scheduler_settings.md index 1b3f40fd29d..3a64586d173 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.control_channels.md index aaed9cf6483..f2aff411594 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.cx.md index 55aa5873a85..a135a663f16 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.delay.md index 11e908b1394..6ca258835b2 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.delay_qubits.md index 648bd15838f..f201eff0a98 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.drive_channel.md index e93957b6e5e..54be52b8b2d 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.frequency_offset.md index dfe513927bd..c9f5dc8c937 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.inline.md index fbf7a7b2a40..f3e13da42c4 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.measure.md index b884b4615bb..f29d6c35bf3 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_all.md index 20ab8af9e9a..0a95e6f3d27 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_channel.md index 02dfc2261a8..1edc2463ef2 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.num_qubits.md index 24922eb0605..ac9a954e347 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.pad.md index fedd05f9b49..e3eb052a125 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.phase_offset.md index 07c50f5be9d..8994c42d74d 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.play.md index 8bdff48c040..f2ded24023f 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.qubit_channels.md index 093812e31ce..2fe31ef3252 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.samples_to_seconds.md index 3f4bd9a2316..9a62aa39587 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.seconds_to_samples.md index b53d2e26b5b..ac2f1c9b852 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.set_frequency.md index 17057dd98ba..70ab33e8292 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.set_phase.md index 2b2ef1e40bf..a8f7c27abc9 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_frequency.md index a4acfc45a11..331031bbe82 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_phase.md index 5bf10420d55..ae95a1b081b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.snapshot.md index ce36302879f..cb79a04d7a8 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.transpiler_settings.md index de25dfa7bfc..558c0147f2f 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.u1.md index 7c48b99504a..23dc352f0a7 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.u2.md index d78e70eeb9c..92ac8ed0203 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.u3.md index 4db07aae35f..86760a36276 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.33/qiskit.pulse.builder.x.md index d8a1bb97075..627ae9f2e58 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.md index e810a0ad181..1c15d7dca7f 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.md index 32102995d0d..886a4d1207d 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.md index 50da3876031..b10fd667a34 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.md index b6c44b7bd54..74ef217e504 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.md index 059835278e0..f95b3383088 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.md index 8ea23a43ec1..d2ef47f3af3 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.md index 0d403d9d63f..6365d5f13a1 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.md index 03c77d3110d..9271f2f7d3e 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.md index 98a1d0f04e0..2718085e248 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -182,7 +182,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.md index 453397b147b..7f29a3a786c 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.md index a32c932aeb1..ada9d8bddf9 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -158,7 +158,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.md index ac854890c64..5f3506641c7 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.md index 569f3c58102..a53b29c8212 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.md index 3d9264f7f34..74ce404fc26 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.md index 4baf507ac9e..07ec2d2021b 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.md index 14135450048..d2b745d3edc 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -156,7 +156,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.md index 18d2fa9d917..39a10f6ffd8 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -74,7 +74,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -98,7 +98,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.md index 98ba9c619c6..34818a2326a 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -88,7 +88,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -112,7 +112,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.md index 17feba7cd3a..f958164f9b6 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -74,7 +74,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -98,7 +98,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.md index 5f94dbec345..fc9ad532ce5 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -92,7 +92,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -116,7 +116,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.md index 2f9f3f334f5..3ee2324fcbc 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.md index f9c16da3be4..1e38a4e85c6 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.md index ba65fa6aac0..2b7066bf5ab 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -40,7 +40,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -62,7 +62,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.md index d8285f3ed1a..0936dac2561 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.md index c6e742e914d..6d130b09d44 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.md index 5461a104f8f..d25c6758864 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.add_implicit_acquires.md index 5d79c203379..5fe8e37895e 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.align_measures.md index 9fad97f83f5..c3667536e99 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_dag.md index 99605be2240..2bc226c33f2 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_schedule.md index e96078d505f..fe3ed7311ac 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.compress_pulses.md index 79077bfbff8..a3a80eee92c 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.flatten.md index 5561e0f95a6..2840bbe8830 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.inline_subroutines.md index bb7c1c6b935..9c0606427ea 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.pad.md index 2800ed49f27..b220f0cd523 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_directives.md index 0ec1ec04665..1d16ec6e715 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_trivial_barriers.md index adc88869967..d2a345394fc 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.33/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.33/qiskit.pulse.transforms.target_qobj_transform.md index efd87b55736..60828025114 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.md index 8869a61f284..078ee3e2443 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.33/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.33/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.33/qiskit.qasm.Qasm.md index eeacaa89e1c..b3b0bece822 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.33/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.33/qiskit.qasm.QasmError.md index bcd2a8ae1f9..ae227359da0 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.33/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.md index b05ee7d556c..a31749d33d1 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.33/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.md index 7e942729b3d..b26eba1557b 100644 --- a/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.33/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.md index 37db8f2b456..236c0179333 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.md index 1e5f95a0c98..29b02037637 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.md index d1814810ede..11efbd5dc36 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.md index 7d3137075bd..9bdfd6e9817 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.md index cc391ea9b89..f565a045e83 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.md index a6eb167dcfd..4e5a6b2dcbd 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.md index 320f1f10838..2b2846ee6be 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.md index c5e2c5afd95..dfb77ec8180 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.md index deeeac3ec80..ef4928c7344 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.md index 54f0f26eb65..d53e797b59e 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.md index 880d1023c60..318fe32a25c 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.md index 9f30502f3c0..e771a4e0e9f 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.md index f82ea4f85b9..4292e4d5686 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.33/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.33/qiskit.qobj.Qobj.md index 7f71949e2a4..7c3d89f4074 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.md index b807f1cf620..4db9865a64b 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.md index 5224191da5d..d39518efbbd 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.md index 4f718669487..9b4792de303 100644 --- a/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.33/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.md index a8942d20778..6117f9e0e3c 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.md index c967f986660..705ac1fd8d5 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.md index 55187e7a11d..61cd35644b6 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.md index c2e22229487..a541ae6d048 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.md index aa8742eca77..635e1564331 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.md index 2486f3191b5..c1cba540dbc 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.md index c14761076e5..8024439d7bc 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.md index 155cfb04c59..33fd7e8bb69 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -207,7 +207,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -223,7 +223,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -273,7 +273,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -291,7 +291,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -317,7 +317,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -325,7 +325,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -333,7 +333,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.md index 96730e0ebb7..6e77cb7cd6c 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.md index 52f773f0e90..7370a70ddb5 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -344,7 +344,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -366,7 +366,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -401,7 +401,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -426,7 +426,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -460,7 +460,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -468,7 +468,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -500,7 +500,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -546,7 +546,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -595,7 +595,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -611,7 +611,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -636,7 +636,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -662,7 +662,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -670,7 +670,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -690,7 +690,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -710,7 +710,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -728,7 +728,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -736,7 +736,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -763,7 +763,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.md index 0575e05d4a8..4bccee0abcb 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -372,7 +372,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -396,7 +396,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -418,7 +418,7 @@ the constructed PauliList. -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -442,7 +442,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -470,7 +470,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -478,7 +478,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -496,7 +496,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -576,7 +576,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -639,7 +639,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -663,7 +663,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -692,7 +692,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -722,7 +722,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -730,7 +730,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.md index 70091f07999..2ba7353d02c 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.md index 4d9e4d90e54..86f46ee911e 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.md index 22388bf7e4d..2094c427e7e 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.md index 076c5b7f713..5f02785bc80 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -50,7 +50,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -90,7 +90,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -149,7 +149,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list \[(pauli\_str, coeffs)] @@ -157,7 +157,7 @@ Construct from a list \[(pauli\_str, coeffs)] -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -193,7 +193,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -214,7 +214,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -232,7 +232,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -312,7 +312,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -333,7 +333,7 @@ the simplified SparsePauliOp operator. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -361,7 +361,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -387,7 +387,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -409,7 +409,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -429,7 +429,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -437,7 +437,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.md index e62bb076543..81478da949a 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of an operator. @@ -154,7 +154,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -162,7 +162,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -186,7 +186,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -209,7 +209,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -234,7 +234,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -254,7 +254,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -305,7 +305,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -340,7 +340,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -364,7 +364,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -372,7 +372,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.md index 3d28280826a..fd837a8da93 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.md index bb757c923e5..54af2d76ca9 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ $$ -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.md index 9f17b00da3b..b1a9727d7ce 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.md index 1aba53fd967..5e497b886f6 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 1c0769e9c29..108a24d7c99 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.md index 0f911d6b1a7..5e4d713f4ea 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.33/qiskit.quantum_info.average_gate_fidelity.md index cbfe2484615..936b5faedb8 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.33/qiskit.quantum_info.concurrence.md index e773fc76fcf..e95d214ce29 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.33/qiskit.quantum_info.decompose_clifford.md index 4bb59ef49b8..1910ef99dd7 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.33/qiskit.quantum_info.diamond_norm.md index 01737deac5e..0790f6b9887 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.33/qiskit.quantum_info.entanglement_of_formation.md index 6bc17aea71a..39c376e100c 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.33/qiskit.quantum_info.entropy.md index 3652a3f9b13..78f26cd9e89 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.33/qiskit.quantum_info.gate_error.md index f3875351969..f8068c0433c 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_distance.md index 2f2258c03a5..a0887a47f76 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_fidelity.md index 86830e691be..c8584c15a8e 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.33/qiskit.quantum_info.mutual_information.md index 0fea876101c..3743a204ad0 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.33/qiskit.quantum_info.partial_trace.md index a454296be84..e5875ec5096 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_basis.md index 5d7d7b028ae..3d761f5054b 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_group.md index 05541acd509..472e7b40938 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.33/qiskit.quantum_info.process_fidelity.md index bddd55a0ec8..e64630c777a 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.33/qiskit.quantum_info.purity.md index ac520a9f809..ce541fd7b53 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_clifford.md index fa266cbbfdf..0872aa00c1f 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_cnotdihedral.md index 006e68c2a02..cea4b3770da 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_density_matrix.md index a663df9b0cc..571336e75c7 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_hermitian.md index dd2b4167210..8a8a51da348 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli.md index 9fef3959af7..3b91d6bf981 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_list.md index 801de5960c5..9f489eaa1ca 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_table.md index 3f8f6608399..7676ab658d7 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_quantum_channel.md index 59b8f1fbdf6..021864c1e5d 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_stabilizer_table.md index 9cc5968aff7..696c8fd8bd5 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_statevector.md index 3c70d7a0e94..a52877c403a 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.33/qiskit.quantum_info.random_unitary.md index ef0b5e0a507..330c3d36ec2 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.33/qiskit.quantum_info.shannon_entropy.md index 52f72ad14a7..9622e9ebcf8 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.33/qiskit.quantum_info.state_fidelity.md index 75113b08c5f..1d81f4eca8b 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.md index a235c0ffaf3..79528c696d0 100644 --- a/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.33/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.md index 664ebf39030..5484fe1daad 100644 --- a/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.33/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(amat, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(amat, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.33/qiskit.result.Counts.md b/docs/api/qiskit/0.33/qiskit.result.Counts.md index 06df890034e..3d87df1f7d1 100644 --- a/docs/api/qiskit/0.33/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.33/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") Return the most frequent count @@ -174,7 +174,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.md index 8a77e362f38..80104f59513 100644 --- a/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.33/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(amats=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(amats=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.md index 34e7eb72644..f3010695bac 100644 --- a/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.33/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.md index 1aefb817ba2..12bacee40d6 100644 --- a/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.33/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.33/qiskit.result.Result.md b/docs/api/qiskit/0.33/qiskit.result.Result.md index b568e22b670..67f1d502bb4 100644 --- a/docs/api/qiskit/0.33/qiskit.result.Result.md +++ b/docs/api/qiskit/0.33/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.33/qiskit.result.ResultError.md b/docs/api/qiskit/0.33/qiskit.result.ResultError.md index 78b094c3568..c4cdebc19c2 100644 --- a/docs/api/qiskit/0.33/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.33/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.33/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.33/qiskit.result.marginal_counts.md index 82b83844e53..308b603ce4b 100644 --- a/docs/api/qiskit/0.33/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.33/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.md index e59ae01fd9d..c216d5f0839 100644 --- a/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.md index 33d03177f5f..900c796985b 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.33/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.md index b47abe591ed..45f87a78a89 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.33/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.md index b4825fc64a9..256023c3de3 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.33/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.md index 34be90f2f4a..ec710d7b63a 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.33/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` diff --git a/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.md index 9250e876841..f0ebc9f2035 100644 --- a/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.33/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.33/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.33/qiskit.tools.backend_monitor.md index f61c8ecef18..f139a5403b6 100644 --- a/docs/api/qiskit/0.33/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.33/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.33/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.33/qiskit.tools.backend_overview.md index 7502f832ed4..96deb65339b 100644 --- a/docs/api/qiskit/0.33/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.33/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.33/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.33/qiskit.tools.job_monitor.md index c4150eec137..19cf48e6620 100644 --- a/docs/api/qiskit/0.33/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.33/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.33/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.33/qiskit.tools.parallel_map.md index 29b6d64cfd3..f254f2f5f2d 100644 --- a/docs/api/qiskit/0.33/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.33/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.md index 2f391ff313c..465172c0ea8 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.md index f30f0d17df7..c1e34982fe3 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -112,7 +112,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -124,7 +124,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -136,7 +136,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -161,7 +161,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -186,7 +186,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -208,7 +208,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -220,7 +220,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -232,7 +232,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -248,7 +248,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -258,7 +258,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -266,7 +266,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -274,7 +274,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -284,7 +284,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -308,7 +308,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -333,7 +333,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -341,7 +341,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.md index 68afdb943cf..c7f13466426 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.md index 093794fcdda..ed654522dec 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.md index 1db1ebc7505..dbfabf9e6ac 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.md index 073f06dbb83..74cd619c268 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name and the qubits. @@ -74,7 +74,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -90,7 +90,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.md index f463949d3a2..7a3599d8c39 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.33/qiskit.transpiler.Layout.md index 4669d50521e..ed13d67a244 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.md index 949694cd787..674328d10f3 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.md index e98c3746f22..bff6de4795c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.md index c69a4bd544d..6244e904a0f 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.Target.md b/docs/api/qiskit/0.33/qiskit.transpiler.Target.md index ad5caf98ed3..7d48fc54666 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -88,7 +88,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -128,7 +128,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -155,7 +155,7 @@ for this target. -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -179,7 +179,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -201,7 +201,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -241,7 +241,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -257,19 +257,19 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.items() → a set-like object providing a view on D’s items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D’s items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D’s keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D’s keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -289,7 +289,7 @@ The Instruction instance corresponding to the name -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qarg @@ -313,7 +313,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -333,7 +333,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -349,7 +349,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -388,7 +388,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -406,7 +406,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D’s values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D’s values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.md index 0a7721fbd42..adeaf24bbc2 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.md index d12f391b3ed..27e84ae6a22 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.md index 5b21baa69fe..c089274befc 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.md index 71b418317f1..f760754ef89 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.md index f1a782c4bfb..fa2e8105504 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.md index 243bbeb82b8..4fb15b5ce76 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.md index f6ec430bef6..8dae5a84df0 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.md index 420ff534056..6bf9552f065 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index e42becc5367..000cb7da913 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.md index 3f6191b5531..e792652750d 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.md index bfc86cebb29..95b0c759466 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.md index 1c2c685a4b3..ce42bb1fdb7 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.md index 847d1aea126..5b77e468685 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.md index c407a0fec9c..b29f913d393 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.md index a511845d6e2..2618dab08bc 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.md index 32f010e3134..9afbef235a7 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.md index 27a17785b65..981ccb02d86 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.md index f6001bc6e2f..a6bd4135165 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.md index 157be065cb8..3cf448b8253 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.md index 8f6b9c90ec9..9fe97d959a4 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.md index 3ef28817701..bd7910dac9e 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.md index 2967d92e5b7..8caba2e3c74 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.md index 0bfb5e90188..8c4a4f3d7c9 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.md index 299d442011a..d51ff16e5ca 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.md index 4c6e9d9e74a..a0c7310a05c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.md index c43ae72e2f9..0823a4120d7 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 2f621b5cefd..b00c02cbab1 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.md index 6bc8c69b411..2f6f917bb98 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.md index 48772d6af67..5b2020e569f 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.md index 92e4565861f..098d92e1672 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None, gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None, gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.md index d18e73ef19e..5fa27d5814c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.md index d28aad6da96..8c8c428944d 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.md index 73180397303..adb825a5ed8 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 0a22e4173ad..f49b7943371 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.md index 0fdeb76d765..92f9fff584a 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.md index d1a4e136aba..42414f69efc 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.md index d764f8e52ac..fdb52239250 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.md index 7aae10093e5..896e50e69e2 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.md index ce82da4e99a..cb5dcaf11ea 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.md index 399e4fa4124..8efbc743f9c 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.md index 6324d69805d..97a7b74a2f8 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.md index 6e97b61cb83..d79f87b9d3f 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.md index b63f21c7c1f..279384f573f 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 97f819fcd68..b71d90bf12a 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.md index aba79d34c9c..8239c207b46 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.md index e394d6bae6b..194f0bb68cd 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index e9d18a06d4d..530a7dea3d4 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 503af1813b0..169de3145e8 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.md index d7a8c5f4107..f70acf29ceb 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 8b9b1eb05c4..b4d76752746 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -67,7 +67,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") **Parameters** @@ -113,7 +113,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 4d2e9f0cad5..df6857162ef 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder` @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.md index 8fc12f40c88..e4a6950fc71 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 3e52da2e872..7d2fac5232a 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.md index f03582fc1cd..ad49f8029f9 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.md index 27f0e22b326..7adce5dc6b8 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.md index 413abd464b4..0a6929760d0 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.md index 56eaa2f44eb..c8f44b29f32 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.md index 0dedfbb441a..54e9ad21698 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.md index 958361548cc..810949d50e7 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.md index a2caa71edf9..269ab3ed0ae 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.md index 2184ebba597..827f25e025d 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.md index f4e77184d87..5d2c51769c0 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.md index ab725fa39b1..58ac3657896 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.md index 338a4fe8811..411b57c4337 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.md index 886c449992b..e7caed007c5 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.md index ecd43f6e17a..406b2482c7d 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.md index d2f20a3eaad..5a342ddd834 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.md index dcbdcb28ae2..d683f0e9b2a 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -48,7 +48,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.md index 7130d2813a0..a6391956683 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/scheduling/instruction_alignment.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.md index 767274848c9..57cac188714 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 097ef252aaf..141161fbaa5 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 8ec386678fd..2120b3ccfc8 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 4162269b162..dbe0aecefe5 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index af802b2d555..121a100ab9f 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 9a0be2fdfe6..06d17327351 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 872db383297..cd23e593f67 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index cc108bbccec..78fe5bfe5fe 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.md index bd91af43666..7ec9eb00667 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 9a798efb2c6..88cca14bfa0 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index 38f214acb23..f4d0a1d6754 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`, `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 822fe26477d..e5318e819d3 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index c0814dd7c95..7982db1e523 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit` @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 3554b308741..dd1d426c66b 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`, `abc.ABC` diff --git a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 3144a4b3bab..dd463414c25 100644 --- a/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.33/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective` @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.md index 53ffae4c439..71087c585e9 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.33/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=10, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.33/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.33/qiskit.utils.apply_prefix.md index 3e2373cbf2d..a189897b4cf 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.33/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.33/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.33/qiskit.utils.deprecate_arguments.md index a94b2faa5c3..37194699529 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.33/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.33/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.33/qiskit.utils.deprecate_function.md index 7677889da5d..eba21590faf 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.33/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.33/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.33/qiskit.utils.detach_prefix.md index 3602e23ba8a..7e0744f6c80 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.33/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.33/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.33/qiskit.utils.get_entangler_map.md index c291a3c6a23..62537ff8297 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.33/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.33/qiskit.utils.has_aer.md b/docs/api/qiskit/0.33/qiskit.utils.has_aer.md index 4ecaee9a006..30f920d5d8e 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.33/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.33/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.33/qiskit.utils.has_ibmq.md index 094b9e7b244..b60b4bf6491 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.33/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.33/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.33/qiskit.utils.is_main_process.md index 57d51fe7245..e24ec97e453 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.33/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.33/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.33/qiskit.utils.local_hardware_info.md index af87c698b4b..bbe539a62ae 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.33/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.md index 950f3bbf939..56d8a38defa 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.33/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.md index 9d5ec55a869..5612da73a76 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.33/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.33/qiskit.utils.name_args.md b/docs/api/qiskit/0.33/qiskit.utils.name_args.md index e69bccde390..530000e8f56 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.33/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.33/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.33/qiskit.utils.summarize_circuits.md index 93d655ef9fc..6c8765aa0df 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.33/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.33/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.33/qiskit.utils.validate_entangler_map.md index dcef9bac139..3d323625a32 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.33/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.md index eb6c483dceb..ec32cf03b8d 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.33/qiskit.visualization.array_to_latex.md index 01ad1064e39..788cf6fdea4 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.33/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.33/qiskit.visualization.circuit_drawer.md index 80eea99a081..c781f27fa73 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.33/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.33/qiskit.visualization.dag_drawer.md index a6874905282..4bfe0b717d2 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.33/qiskit.visualization.pass_manager_drawer.md index 3fe0b4e6ffe..8ded4290460 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_multivector.md index ba8840cdc34..49068764dfe 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_vector.md index a8e40d49f66..5158b6ec19e 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_circuit_layout.md index a912b663a40..8ad6641c2a7 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_coupling_map.md index 6c233754fca..32b24c43146 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_error_map.md index e44b77e09b1..ba355f6e825 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_gate_map.md index b68915dea09..8be68a2ccd6 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_histogram.md index 1d12b4ce381..b4b04cf41af 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_city.md index 7b5af067ef1..ddb0d332c5d 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_hinton.md index cbb81c9413d..30647b73f68 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_paulivec.md index 9f9c74cb248..ad6fc09fd6f 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_qsphere.md index dfb06ac2f2e..e65a1f0249e 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.md index cc040499844..4151a184d7d 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.md index a1dedc338f8..5dc7d71f187 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.md index 9d5276855fb..54d2508dabc 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.draw.md index 609fabbb184..58b019dfb26 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.md index 23c889820b0..e90dbc0e985 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.33/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.33/qiskit.visualization.timeline.draw.md index 08d5667656f..63cc387ce44 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.33/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.33/qiskit.visualization.visualize_transition.md index b591adb0fea..f156c69047c 100644 --- a/docs/api/qiskit/0.33/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.33/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.33/synthesis_aqc.md b/docs/api/qiskit/0.33/synthesis_aqc.md index 728752427d1..b089f073c7e 100644 --- a/docs/api/qiskit/0.33/synthesis_aqc.md +++ b/docs/api/qiskit/0.33/synthesis_aqc.md @@ -127,7 +127,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. From bed08e329de5c6fd61de1a4d3b0b4a3d4177504b Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:37:52 +0100 Subject: [PATCH 15/41] Regenerate qiskit 0.35.0 --- docs/api/qiskit/0.35/execute.md | 2 +- docs/api/qiskit/0.35/logging.md | 2 +- docs/api/qiskit/0.35/pulse.md | 8 +- .../0.35/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.35/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.35/qiskit.algorithms.Grover.md | 8 +- .../0.35/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.35/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.35/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.35/qiskit.algorithms.Shor.md | 8 +- .../0.35/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.35/qiskit.algorithms.VQE.md | 14 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 8 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- .../0.35/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.35/qiskit.algorithms.optimizers.AQGD.md | 8 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 8 +- .../0.35/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.35/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.35/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.35/qiskit.algorithms.optimizers.GSLS.md | 16 +- ...t.algorithms.optimizers.GradientDescent.md | 8 +- .../qiskit.algorithms.optimizers.IMFIL.md | 8 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.35/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 18 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 6 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 8 +- .../0.35/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 8 +- .../0.35/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit/0.35/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.35/qiskit.assembler.disassemble.md | 2 +- .../0.35/qiskit.circuit.AncillaQubit.md | 2 +- .../0.35/qiskit.circuit.AncillaRegister.md | 2 +- .../api/qiskit/0.35/qiskit.circuit.Barrier.md | 8 +- .../qiskit/0.35/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.35/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.35/qiskit.circuit.Clbit.md | 2 +- .../0.35/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.35/qiskit.circuit.ControlFlowOp.md | 2 +- .../0.35/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.35/qiskit.circuit.Delay.md | 12 +- .../0.35/qiskit.circuit.EquivalenceLibrary.md | 12 +- .../qiskit/0.35/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/0.35/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.35/qiskit.circuit.IfElseOp.md | 4 +- .../qiskit/0.35/qiskit.circuit.Instruction.md | 26 +- .../0.35/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.35/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.35/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.35/qiskit.circuit.ParameterVector.md | 6 +- .../0.35/qiskit.circuit.QuantumCircuit.md | 224 +++++++++--------- .../0.35/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.35/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.35/qiskit.circuit.Reset.md | 4 +- .../qiskit/0.35/qiskit.circuit.WhileLoopOp.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.AND.md | 2 +- .../0.35/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.35/qiskit.circuit.library.C3XGate.md | 6 +- .../0.35/qiskit.circuit.library.C4XGate.md | 6 +- .../0.35/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.35/qiskit.circuit.library.CHGate.md | 4 +- .../0.35/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.35/qiskit.circuit.library.CRXGate.md | 4 +- .../0.35/qiskit.circuit.library.CRYGate.md | 4 +- .../0.35/qiskit.circuit.library.CRZGate.md | 4 +- .../0.35/qiskit.circuit.library.CSXGate.md | 2 +- .../0.35/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.35/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.35/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.35/qiskit.circuit.library.CUGate.md | 4 +- .../0.35/qiskit.circuit.library.CXGate.md | 6 +- .../0.35/qiskit.circuit.library.CYGate.md | 4 +- .../0.35/qiskit.circuit.library.CZGate.md | 4 +- .../0.35/qiskit.circuit.library.DCXGate.md | 2 +- .../0.35/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.35/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.GRZ.md | 2 +- .../0.35/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.35/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.35/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.35/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.35/qiskit.circuit.library.MCMT.md | 6 +- .../0.35/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.35/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.35/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.35/qiskit.circuit.library.MSGate.md | 2 +- .../0.35/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.35/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.35/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.35/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.35/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.35/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.35/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.35/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.35/qiskit.circuit.library.RGate.md | 4 +- .../0.35/qiskit.circuit.library.RVGate.md | 6 +- .../0.35/qiskit.circuit.library.RXGate.md | 6 +- .../0.35/qiskit.circuit.library.RXXGate.md | 4 +- .../0.35/qiskit.circuit.library.RYGate.md | 6 +- .../0.35/qiskit.circuit.library.RYYGate.md | 4 +- .../0.35/qiskit.circuit.library.RZGate.md | 6 +- .../0.35/qiskit.circuit.library.RZXGate.md | 4 +- .../0.35/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.35/qiskit.circuit.library.SGate.md | 4 +- .../0.35/qiskit.circuit.library.SXGate.md | 6 +- .../0.35/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.35/qiskit.circuit.library.SdgGate.md | 4 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.35/qiskit.circuit.library.SwapGate.md | 6 +- .../0.35/qiskit.circuit.library.TGate.md | 4 +- .../0.35/qiskit.circuit.library.TdgGate.md | 4 +- .../0.35/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.35/qiskit.circuit.library.U1Gate.md | 6 +- .../0.35/qiskit.circuit.library.U2Gate.md | 4 +- .../0.35/qiskit.circuit.library.U3Gate.md | 6 +- .../0.35/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.35/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.35/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 4 +- .../qiskit.circuit.library.XXPlusYYGate.md | 4 +- .../0.35/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.35/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.35/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.35/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.35/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.35/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.35/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.35/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.35/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.35/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.35/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.35/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.35/qiskit.compiler.transpile.md | 2 +- .../0.35/qiskit.converters.ast_to_dag.md | 2 +- .../0.35/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.35/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.35/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.35/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.35/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.35/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.35/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.35/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.35/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.35/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.35/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.35/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.35/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.35/qiskit.extensions.Snapshot.md | 8 +- .../0.35/qiskit.extensions.UnitaryGate.md | 16 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.35/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.35/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 16 +- .../0.35/qiskit.ignis.verification.BConfig.md | 18 +- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.35/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.35/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- ...it.ignis.verification.QOTPCorrectString.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- .../qiskit/0.35/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.35/qiskit.opflow.OpflowError.md | 2 +- .../0.35/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.35/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.35/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.35/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.35/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.35/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.35/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.35/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.35/qiskit.opflow.gradients.QFI.md | 4 +- .../0.35/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.35/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.35/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.35/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.35/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.35/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../0.35/qiskit.primitives.BaseEstimator.md | 4 +- .../0.35/qiskit.primitives.BaseSampler.md | 4 +- .../0.35/qiskit.primitives.Estimator.md | 4 +- .../0.35/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.35/qiskit.primitives.Sampler.md | 4 +- .../0.35/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.35/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.35/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.35/qiskit.providers.BackendV2.md | 16 +- .../0.35/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.35/qiskit.providers.BaseJob.md | 24 +- .../0.35/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.35/qiskit.providers.Job.md | 2 +- .../qiskit/0.35/qiskit.providers.JobError.md | 2 +- .../qiskit/0.35/qiskit.providers.JobStatus.md | 2 +- .../0.35/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.35/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.35/qiskit.providers.Options.md | 8 +- .../qiskit/0.35/qiskit.providers.Provider.md | 2 +- .../0.35/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.35/qiskit.providers.QubitProperties.md | 2 +- .../0.35/qiskit.providers.aer.AerError.md | 2 +- .../0.35/qiskit.providers.aer.AerProvider.md | 6 +- .../0.35/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.35/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...skit.providers.aer.library.SaveClifford.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...kit.providers.aer.library.save_clifford.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_superop.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- ...skit.providers.aer.noise.LocalNoisePass.md | 4 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 24 +- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...providers.aer.noise.RelaxationNoisePass.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...oviders.aer.utils.transform_noise_model.md | 2 +- ...oviders.aer.utils.transpile_noise_model.md | 2 +- ...iders.aer.utils.transpile_quantum_error.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.35/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 10 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.35/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.35/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.35/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.35/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...skit.providers.ibmq.random.CQCExtractor.md | 10 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 6 +- ...providers.ibmq.random.IBMQRandomService.md | 6 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.35/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.35/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.35/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.35/qiskit.pulse.ScheduleBlock.md | 22 +- .../0.35/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.35/qiskit.pulse.builder.align_func.md | 2 +- .../0.35/qiskit.pulse.builder.align_left.md | 2 +- .../0.35/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.35/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.delay.md | 2 +- .../0.35/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.35/qiskit.pulse.builder.inline.md | 2 +- .../0.35/qiskit.pulse.builder.measure.md | 2 +- .../0.35/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.35/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.pad.md | 2 +- .../0.35/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.35/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.35/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.35/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.35/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.35/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.35/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.35/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.35/qiskit.pulse.instructions.Call.md | 6 +- .../0.35/qiskit.pulse.instructions.Delay.md | 4 +- .../0.35/qiskit.pulse.instructions.Play.md | 4 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.35/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.35/qiskit.pulse.library.Drag.md | 6 +- .../0.35/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.35/qiskit.pulse.library.Waveform.md | 4 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.35/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.35/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.35/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.35/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.35/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.35/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.35/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.35/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.35/qiskit.qasm.QasmTerminalStyle.md | 2 +- docs/api/qiskit/0.35/qiskit.qasm3.Exporter.md | 6 +- docs/api/qiskit/0.35/qiskit.qasm3.dump.md | 2 +- docs/api/qiskit/0.35/qiskit.qasm3.dumps.md | 2 +- .../0.35/qiskit.qobj.GateCalibration.md | 6 +- .../0.35/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.md | 6 +- .../0.35/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.35/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.35/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.35/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.35/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.35/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.35/qiskit.qobj.Qobj.md | 2 +- .../0.35/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.35/qiskit.qobj.QobjHeader.md | 2 +- .../0.35/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.35/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.35/qiskit.qpy.load.md | 2 +- .../0.35/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.35/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.35/qiskit.quantum_info.Choi.md | 12 +- .../0.35/qiskit.quantum_info.Clifford.md | 32 +-- .../0.35/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.35/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.35/qiskit.quantum_info.Operator.md | 28 +-- .../qiskit/0.35/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.35/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.35/qiskit.quantum_info.PauliList.md | 52 ++-- .../0.35/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.35/qiskit.quantum_info.Quaternion.md | 14 +- .../0.35/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.35/qiskit.quantum_info.SparsePauliOp.md | 40 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.35/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.35/qiskit.quantum_info.Stinespring.md | 14 +- .../0.35/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.35/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.35/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.35/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.35/qiskit.quantum_info.entropy.md | 2 +- .../0.35/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.35/qiskit.quantum_info.partial_trace.md | 2 +- .../0.35/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.35/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.35/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.35/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.35/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.35/qiskit.result.ProbDistribution.md | 6 +- .../0.35/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.35/qiskit.result.Result.md | 16 +- .../qiskit/0.35/qiskit.result.ResultError.md | 2 +- .../0.35/qiskit.result.marginal_counts.md | 2 +- .../0.35/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.35/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.35/qiskit.synthesis.ProductFormula.md | 2 +- .../0.35/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../0.35/qiskit.tools.backend_monitor.md | 2 +- .../0.35/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.35/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.35/qiskit.tools.parallel_map.md | 2 +- .../0.35/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.35/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.35/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.35/qiskit.transpiler.Layout.md | 30 +-- .../0.35/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.35/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit/0.35/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.35/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.35/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...ranspiler.passes.CollectLinearFunctions.md | 4 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- .../0.35/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.35/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 4 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- .../0.35/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.35/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.35/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.35/qiskit.transpiler.passes.Width.md | 4 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- .../0.35/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.35/qiskit.utils.apply_prefix.md | 2 +- .../0.35/qiskit.utils.deprecate_arguments.md | 2 +- .../0.35/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.35/qiskit.utils.detach_prefix.md | 2 +- .../0.35/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.35/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.35/qiskit.utils.has_ibmq.md | 2 +- .../0.35/qiskit.utils.is_main_process.md | 2 +- .../0.35/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 6 +- .../api/qiskit/0.35/qiskit.utils.name_args.md | 2 +- .../0.35/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.35/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.35/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.35/synthesis_aqc.md | 2 +- docs/api/qiskit/0.35/utils.md | 6 +- 977 files changed, 2871 insertions(+), 2871 deletions(-) diff --git a/docs/api/qiskit/0.35/execute.md b/docs/api/qiskit/0.35/execute.md index 73117459428..74a97a08f1c 100644 --- a/docs/api/qiskit/0.35/execute.md +++ b/docs/api/qiskit/0.35/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.35/logging.md b/docs/api/qiskit/0.35/logging.md index 8dc3b98896c..e6256887f99 100644 --- a/docs/api/qiskit/0.35/logging.md +++ b/docs/api/qiskit/0.35/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.35/pulse.md b/docs/api/qiskit/0.35/pulse.md index b1d097bac2b..e74e4253a54 100644 --- a/docs/api/qiskit/0.35/pulse.md +++ b/docs/api/qiskit/0.35/pulse.md @@ -66,7 +66,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -141,7 +141,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -192,7 +192,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -634,7 +634,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.md index 5aa00b3fd7f..731ff50ce09 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.md index 4b245a063cd..84104e244d1 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.md index bc7e4128bb5..e16b6cd2c19 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.md index 4e9c06e5cd7..d7b4b7dc148 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.md index 86b95964f3c..71e929c7e9c 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.md index 7e33de156fc..abb53c279a3 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.md index 9ec83633a4e..ac7927c8c11 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.md index 5d51fbe5bce..8c824e3a29c 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.md index 769b3c730a8..ef6415cf733 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.md index c140a6a50cf..820662cf059 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.md index a019db22701..c73da42fdad 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.md index b46bbbf41fe..1b6f71b2da8 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.35/qiskit.algorithms.Grover.md index bd083ccab96..5418d5d0b2a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -114,7 +114,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -140,7 +140,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.md index 3b3812d2e17..786ab89506b 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.md index 0bdfb5d28f4..d324b6bc3ff 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 46c046e6813..90916b20ac3 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.md index 10c3d230711..7575d560f1a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 771ca018cf3..587eb011c9f 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.md index e4988bcdb48..fd0a035546c 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 874ef6075f0..838e6beb990 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 94abd2666b7..a52679f2d23 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.md index a1ed88cca05..a7169e96a80 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.md index 00a241bfbea..b0c1e139d8e 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.md index 3b7153b1331..f87cae67c31 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.md index 39e6543d93c..d0051b90cf4 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.md index 0d5995b17c3..9db6b7dc000 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.md index 3ed287b63c7..019ee0f4e46 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.md index c1ede4b535c..d2a9cf46ebb 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.md index 3372e3f2c5b..72110fa23bd 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.35/qiskit.algorithms.Shor.md index 9317a99a660..fe190ffca3a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.md index c15b285bd25..e9884d486f5 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.35/qiskit.algorithms.VQE.md index 59fbb77ac38..eb9ee10b66d 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -50,7 +50,7 @@ The above signature also allows to directly pass any SciPy minimizer, for instan -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -71,7 +71,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -92,7 +92,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -119,7 +119,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -146,7 +146,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -162,7 +162,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.35/qiskit.algorithms.eval_observables.md index 4e43207be55..a471cbd0847 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/aux_ops_evaluator.py "view source code") Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 59365a4079e..88d24370362 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -54,7 +54,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -74,7 +74,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -94,7 +94,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -114,7 +114,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.md index 78fea156431..edef8791b0f 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -90,7 +90,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.md index 2f6d33ea2a8..cc55e63e03a 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.md index 1aea3df4c75..81c8626c904 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index 079e3e670d2..94f63df8c64 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -488,7 +488,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1116,7 +1116,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2151,7 +2151,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index de0565ebf46..53c1d400f38 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 0635b4a6f32..0621127543f 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: `qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable` @@ -69,7 +69,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -89,7 +89,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -109,7 +109,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -129,7 +129,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index c2058bf5b79..2b56f7f9f32 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.md index 01ec3c9cd83..f0f601e6afe 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` @@ -511,7 +511,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1139,7 +1139,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1660,7 +1660,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2174,7 +2174,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index 127b92630bf..09f40c9a86d 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` @@ -524,7 +524,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1152,7 +1152,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1673,7 +1673,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2187,7 +2187,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.md index 44eac04155d..6315c797596 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -125,7 +125,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -163,7 +163,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.md index 3db2468aa91..be6360aa261 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. @@ -108,7 +108,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.md index de0f482c22c..f157ff0f670 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. @@ -88,7 +88,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.md index 00591e12938..b2db0e0f0c7 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.md index 03fcc1db7f9..736bcd18008 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.md index 4a2d2a9b64f..bd026810599 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.md index 1d9b6ccd59c..0246f311c82 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 7b2df7edde3..85db15e64dd 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.md index 3a9cfcfd3ab..bdd48c8f5ff 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.md index 05cd316d90e..973a0dd487d 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -157,7 +157,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -195,7 +195,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -219,7 +219,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.md index 2df4e72489c..515e5a258f1 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Minimize the scalar function. @@ -101,7 +101,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.md index 7812f3e24fc..3edc32385f3 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. @@ -88,7 +88,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.md index bf5c8fd0d12..3e86e294fb6 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.md index 74448209582..8af1ef6f500 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.md index 429caf256a2..2134d440692 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.md index a4bf6569eec..9cc90cf271f 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.md index 0bedafb363b..c254c580dfd 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -104,7 +104,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -112,7 +112,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -120,7 +120,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -134,7 +134,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.md index cefc228ca8b..b75ee8391c2 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 628b3e516f9..ed6514afe25 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.md index d576b488bc4..c8764ceef42 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.md index 9295dc89682..7831570cf15 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. @@ -91,7 +91,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.md index 0083135fd10..da4cf243b96 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -125,7 +125,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.md index a28853e2dc8..43a9511d2d6 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.md index 206f5aa3c84..79194561568 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. @@ -91,7 +91,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.md index 9ca3df93fff..667311458d3 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -104,7 +104,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -140,7 +140,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -152,7 +152,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -183,7 +183,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -206,7 +206,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.md index 021bba76262..072c5833fd6 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. @@ -85,7 +85,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.md index 2a5aca217ab..589356cbb2d 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.md index 92263461817..7cd9214e828 100644 --- a/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.35/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.35/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.35/qiskit.assembler.assemble_circuits.md index 662a2b1a99f..c6e57cd0aa2 100644 --- a/docs/api/qiskit/0.35/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.35/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.35/qiskit.assembler.assemble_schedules.md index fd361ce969b..32065c25e91 100644 --- a/docs/api/qiskit/0.35/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.35/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.35/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.35/qiskit.assembler.disassemble.md index ffc93d96c1f..da32755af53 100644 --- a/docs/api/qiskit/0.35/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.35/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.md index ee9555067a0..46acc3daa0e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.md index 954020bfece..bcabdc75f79 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Barrier.md b/docs/api/qiskit/0.35/qiskit.circuit.Barrier.md index b38bbaeec2b..8d6e4383fc7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Barrier.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.md index 7b223a0e1ab..4d8bf5fcaf9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.md index fcdf55ea7e1..bffdc3b607c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.35/qiskit.circuit.Clbit.md index e1e765e854b..803fa5ed2f7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.md index 300feca79b0..159994a70c2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.md index c280f216030..0d2f7ecd33b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: `qiskit.circuit.instruction.Instruction`, `abc.ABC` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.md index 09b6c3fdaa4..dd8dbaba6ad 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -224,7 +224,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Delay.md b/docs/api/qiskit/0.35/qiskit.circuit.Delay.md index 779072e9210..8b27a1603d8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.md index e9c215000dc..38d28518ffc 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.md index 791fbc37451..aa8bd56325b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Gate.md b/docs/api/qiskit/0.35/qiskit.circuit.Gate.md index 1b5e8881748..b010a65c98d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.md index 400479155cf..609eabdaab3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` @@ -100,7 +100,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.35/qiskit.circuit.Instruction.md index df47b0013f1..9e90a2ec7c5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -87,7 +87,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -109,7 +109,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -133,7 +133,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -141,7 +141,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -151,7 +151,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -175,7 +175,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -195,7 +195,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -215,7 +215,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.md index 9456fe42347..bf0d00e9c19 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -85,7 +85,7 @@ This same instance of [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.c -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Measure.md b/docs/api/qiskit/0.35/qiskit.circuit.Measure.md index e1aba951f5c..83dd030a876 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.35/qiskit.circuit.Parameter.md index a2e31e2b989..0afa792cc41 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -206,7 +206,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.md index f407603fe2a..0adbab5ec90 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -218,7 +218,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.md index 637c8b3f693..7d0f14bac0e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.md index ff8f4f48b96..d2ca6dceb66 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -139,7 +139,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -162,7 +162,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -174,7 +174,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -201,7 +201,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -301,7 +301,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Barrier`](qiskit.circuit.Barrier "qiskit.circuit.Barrier"). If qargs is empty, applies to all qubits in the circuit. @@ -317,7 +317,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -344,7 +344,7 @@ copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -368,7 +368,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -380,7 +380,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -400,7 +400,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -425,7 +425,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -450,7 +450,7 @@ A handle to the instructions created. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -462,7 +462,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -474,7 +474,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -503,7 +503,7 @@ A handle to the instructions created. -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -531,7 +531,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -586,7 +586,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -610,7 +610,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -636,7 +636,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -656,7 +656,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -672,7 +672,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -698,7 +698,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -724,7 +724,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -750,7 +750,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -776,7 +776,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -802,7 +802,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -827,7 +827,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -856,7 +856,7 @@ A handle to the instructions created. -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -882,7 +882,7 @@ A handle to the instructions created. -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -910,7 +910,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -935,7 +935,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -960,7 +960,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -985,7 +985,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1008,7 +1008,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1028,7 +1028,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1054,7 +1054,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1105,7 +1105,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1179,7 +1179,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1202,7 +1202,7 @@ A handle to the instructions created. -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -1230,7 +1230,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1261,7 +1261,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1316,7 +1316,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1344,7 +1344,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1364,7 +1364,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1384,7 +1384,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1404,7 +1404,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1434,7 +1434,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1454,7 +1454,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1476,7 +1476,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1502,7 +1502,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1548,7 +1548,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1715,7 +1715,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1817,7 +1817,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1840,7 +1840,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1926,7 +1926,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1967,7 +1967,7 @@ A handle to the instructions created. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1991,7 +1991,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2028,7 +2028,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2053,7 +2053,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2075,7 +2075,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2104,7 +2104,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `MSGate`. @@ -2127,7 +2127,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2147,7 +2147,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2161,7 +2161,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2177,7 +2177,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2189,7 +2189,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2212,7 +2212,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2233,7 +2233,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2372,7 +2372,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2399,7 +2399,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2419,7 +2419,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2439,7 +2439,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2466,7 +2466,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2493,7 +2493,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2517,7 +2517,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2542,7 +2542,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2566,7 +2566,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2588,7 +2588,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2608,7 +2608,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2628,7 +2628,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2670,7 +2670,7 @@ q_1: ┤ H ├─────■────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2710,7 +2710,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2737,7 +2737,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2761,7 +2761,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2785,7 +2785,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2809,7 +2809,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2833,7 +2833,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2856,7 +2856,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2880,7 +2880,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2904,7 +2904,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3316,7 +3316,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3484,7 +3484,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3708,7 +3708,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3731,7 +3731,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3753,7 +3753,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3775,7 +3775,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3797,7 +3797,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3819,7 +3819,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3872,7 +3872,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3893,7 +3893,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3914,7 +3914,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3942,7 +3942,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3967,7 +3967,7 @@ A handle to the instructions created. -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -3990,7 +3990,7 @@ A handle to the instructions created. -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -4014,7 +4014,7 @@ A handle to the instructions created. -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -4160,7 +4160,7 @@ Apply unitary gate to q. -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -4205,7 +4205,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -4221,7 +4221,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4244,7 +4244,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4266,7 +4266,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.md index 76faba86ff8..30dff914eb0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.35/qiskit.circuit.Qubit.md index 7e45f239de5..b4d27b939c2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.Reset.md b/docs/api/qiskit/0.35/qiskit.circuit.Reset.md index cb61a1000e1..74880ecad35 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.md index 5c95bbfd679..2502a278980 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` @@ -97,7 +97,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.md index 6f6182a4e59..af3803bee63 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.md index a0bfcf8e486..3585dba6201 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index d932c7552b3..049e8ee3d88 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 0875249c124..e4f0b9261c0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.35/qiskit.circuit.library.AND.md index 9380db59d4e..19593951195 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.md index d10f5b2e295..ef2b72c8939 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.md index 92763a4064d..d8ff3f54815 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.md index ac389fa28ac..5ffd031bec7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.md index 2e4b827a87f..98c42907fb8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.md index 138c096fa2d..c7ff3fccdd1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.md index f9426a6dab5..ffde750bc98 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -70,7 +70,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.md index 5bcc86bd430..226d324f62d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.md index 73d04ddce83..3ce67b449d7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.md index dc80ad5dd04..9953b48db46 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.md index 7122a244eae..ef12b9ff3bd 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.md index 54b4737d469..64a85382c18 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.md index 810682d92ef..a228fc9d9dc 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.md index 66a4f579b3a..98bfc91da4d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.md index 58cbf2a0f6b..e02356fc0b9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.md index 7fb1960fbbe..7cf95d906a7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.md index 9fe8d13f4d6..2f1a2447001 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.md index b2b2861b62c..52d28e60672 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.md index 2294b8de312..f16fcea3565 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.md index 4aa31364b67..54e1d98fad9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.md index 100a5d63c31..f98ac67c3a2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.md index e24a495ec01..fb5c22dd6f7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.md index 6c0948ac1f1..7f860b8ac5c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.md index 4dfd85789dc..60ca8a522cf 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 105d10c117d..035af95b0c9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.md index 89c4b43332d..932c895935f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.md index fc8645ea901..05d99512812 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.md index 51c319db270..db4ae7535a0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.md index a7b669c076e..5cc175b3db5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.md index 6bb464d2c1a..f627ad7a21a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GR.md index d33b3be0538..26895a016e4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.md index 00f895033bd..5e8f2b3327c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.md index ac1ff2b3c74..ec1beecd0c3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.md index 3522ef9db85..45efc52ed01 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.md index 0dc9a3b4e82..0dba4e5c8b4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.md index afdfb6844b5..5facab71017 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.md index 9282112d503..e6fc8abc86a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.md index aee57c3d57e..e715dd574d8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.md index 62fdfdf514f..278b004b476 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.md index 616a2c714fd..3df6befc282 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.md index c9d56b0b076..bbc4b1b3dad 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.md index 972cd5f988c..181a7012723 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.md index c5a22dbd9fe..422a207468b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.md index d4100fe1e0a..d4dbd866f49 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.md index 97fe92917df..ac2280a118f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.md index 5e8e7997780..6a2293e02a1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.md index 4637c02155b..5d89c60c5e8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.md index bec8a6f77a8..17a3ce038f7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.md index f3f429efc46..3955bb002e8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.md index 52484758be2..35646f6fc7f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -60,7 +60,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.md index 0fbabd7c2b9..caf09f70354 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.md index b152469912d..48d969bb03c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.md index 54fe2e098c4..a07cac1de51 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.md index ef8e1c26ef8..376cef5e857 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.md index 7ad15c39ac7..8324af51a47 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.35/qiskit.circuit.library.OR.md index 3914d47f7c2..ee04dd94453 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.md index 049612a8d0d..7684f94aa2c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.md index 60222f6f49f..5d6e76d46da 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.md index 19d826d05a2..f5bd226ef72 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.md index 11fba8f0eeb..ef6342cf07c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.md index 03d3e22a6cd..4f7bb8fcde6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.md index d86acb47f31..2c7bf1280e4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.md index 6b25e4aff7d..e89553ffce4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.md index 6e773c8dfbc..659ab01290a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.md index ef2bd63c044..7b7f348068a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index a7cd558fb7a..7a6c69b5d9b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index f4115298819..4acca5f7943 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.md index 6b228788a6a..97b23c62992 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.md index 5fd538ca0ec..0eaa41639ec 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.md index 7da037563fb..3257eedaa8e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.md index 10bbf802e14..e7aa12e1036 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.md index c14aae9588f..9bbb4529b15 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.md index f7a74f2d50e..9680708057d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.md index edd07feea8a..f039abdec9c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.md index ac076c87dd9..e83fe6de919 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.md index f3d8539bd66..bedfdd71384 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.md index 8c85b514838..f8f1df08ce8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.md index 4208bd57f8f..3b1d336dae0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.md index 51e18d6dd21..03b7d7b23a2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.md index 3e80f505c74..d8fee8b1a92 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.md index 9a835a644f3..398315fa435 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.md index 50343d33a29..999a0da2a68 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.md index 44d5aa65583..7d5e94d0a39 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.md index ee8ae0bf5a0..6c57e7bc5b7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.md index 9dfc536f4f5..03fc76eee53 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.md index 4e876cee6b4..73277975106 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.md index 01022d58465..ee420060cf4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.md index 47a0c5d56bc..96550614667 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.md index afcd4877ea9..f67024403ac 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.md index 10f2e9b6ad4..6e154275d68 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.md index 7f90dfb380d..d9828d764d6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.md index 92234d903cc..8e2328c4c5f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.md index f4b0f48ce66..84db056ce73 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.md index 077b47a1102..ee07b5d6fe9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.md index 0e4e03ef0a4..f82ea096c06 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.md index b995e5a8be3..18da5e4cc99 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.md index 137bce1c25c..a2832722e07 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.md index 8ecbd836d12..c86ee1937f3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -66,7 +66,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.md index bd27bb50948..780eda81939 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.md index 09080817fd2..6539077603b 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.md index c210977aab9..1e60daec56c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.md index 7beb9acd278..176a722a057 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.md index 95a29912d7d..6fb57575cab 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.md index 5fbdbc15507..64a42f89910 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.md index b7e670f16db..465fb673ad3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.md index 639ae39e61c..9622bac0fc2 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.md index ee75c57ee96..89206e97eda 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.md index 8ed5928736e..bc2cb1bae38 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_1.md index bcc82a63945..59c35275ce9 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_2.md index f1f4f5fbfa4..19d2085c0ca 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_3.md index 6eee6991972..cb6026daa30 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_4.md index 6d33d58ab64..b5810059613 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_3_1.md index fb0708216da..0c7fa2f0427 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_1.md index 277456a146d..2aa7f4894a0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_2.md index e4f49e1cd09..601ea4d8dec 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_3.md index dad866829e9..24f28a2fce3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_4.md index 0b7369cb5d3..d4f94149bb4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_5_1.md index ea700db72b3..511ec3f4e42 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_1.md index 72d2456f07d..0d2d5955be1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_2.md index bbb3efc9005..8ee01874364 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_3.md index 9544dfb72be..08a1e405106 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_4.md index e090e774dfc..9c4d96e37d0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_5.md index a284b26388f..c41ed6024ec 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_1.md index 06043da3409..04797a2b7ed 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_2.md index 01fa253c1eb..35cc8665f87 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_3.md index f5c964f2b8a..26816cfe94c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.md index 28e132629fb..d7b2dd591b3 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_cy.md index f2ab84e233b..b90ba9284b8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_xz.md index 058f0ebd101..530cdf14348 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_yz.md index 321ed7f3cd0..31254221116 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz1.md index 6cad7107a32..bd4f3d1e56a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz2.md index 2627333299f..aab2307ac85 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz3.md index 909bce1250a..14ddf39dabd 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index a3f65e5d5aa..b36319ceffc 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 9a70608e99c..13a301a385a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index e48d626d193..081b9013956 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index c439b1304f6..8a9f6715110 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 3b487c1836b..29ca3d3e58a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 5b8b59faf09..9be9987a63c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 438547a49dc..f2e511cb494 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 22ea27a8f45..6f27f3105c1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index a0c9ca908b1..0c2c3e92968 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 88a2c8ddaa3..0e4fafb6a0e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index c904b9bf622..c68407ffa08 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index dfc8e1bd8cd..b7799c9d9a6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 7d1dffd36ab..25a398bad3a 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 47675114d64..b72d4acec69 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index e4fde4a2c58..e6ec62ea040 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 8c97adfe0ad..8225e160de6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 3d61fd6ff5b..e4b6cc8af7c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index 12b04889a4c..17e1c9364fa 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index a6b29cea2dc..3f217d9b58c 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 99a21406ebe..4ad6655d0ef 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 832911d619b..f6b94d6d1d4 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index c26cabd9acf..1b6e0341317 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 5b60d4e8ae9..b505c5683cf 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index f4f9a429d73..6aaf7f948e8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 5bfe20770e3..c1728d9633f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index c63e734ad30..416485425b7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 3b83acf7d38..5064779010d 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 62334ef1429..2d28f5be1a8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8d2bb9a22d6..86371dff0db 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 52b2f7ef64f..f2401c73fd8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 317900d6909..da30c3d7d1f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 819b6c141f9..5716fd111b8 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 2b686ec0cfa..98a74263a9f 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 665a2bf1871..8a8e69d4ae1 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 2065bbc7a8e..d5cb4d2a537 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index e1789169c9d..20727f68f59 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index c70339c3e31..e82a9d4550e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 27a335562dd..1ab51ba27e7 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 7b19f004a9f..3e0022bbf59 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index ad82ad86851..5c6dd562aa6 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index f25906e4f98..547d95157f0 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index abd306d0225..30292420fcc 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 777de9cd5a8..5dd92103749 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 6ea8c0e6e13..5a59971c967 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 53075d43ef9..e1a05dd150e 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 8c21d9890c8..c4df94dd3aa 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index c4fcdbc9b4b..7bdf7d92af5 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.35/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.35/qiskit.circuit.random.random_circuit.md index 719ce86a463..018b2ebf741 100644 --- a/docs/api/qiskit/0.35/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.35/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.35/qiskit.compiler.assemble.md b/docs/api/qiskit/0.35/qiskit.compiler.assemble.md index 2d6333af84f..5cd6330d146 100644 --- a/docs/api/qiskit/0.35/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.35/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.35/qiskit.compiler.schedule.md b/docs/api/qiskit/0.35/qiskit.compiler.schedule.md index 10d21eba0f9..67d337929bf 100644 --- a/docs/api/qiskit/0.35/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.35/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.35/qiskit.compiler.sequence.md b/docs/api/qiskit/0.35/qiskit.compiler.sequence.md index 8ec599f5219..d5840c72ea4 100644 --- a/docs/api/qiskit/0.35/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.35/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.35/qiskit.compiler.transpile.md b/docs/api/qiskit/0.35/qiskit.compiler.transpile.md index 1f8a56ef20c..3d4ba4d9010 100644 --- a/docs/api/qiskit/0.35/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.35/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.35/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.35/qiskit.converters.ast_to_dag.md index 2966fc0e3e6..877b15e0e24 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.35/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dag.md index de189fa12d7..558cdba96aa 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dagdependency.md index 421cc841eb6..1ada1399f79 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_gate.md index 84c31da1899..c3fbb70f669 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_instruction.md index a3bc93c89ed..513d502ebf1 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.35/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.35/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.35/qiskit.converters.dag_to_circuit.md index 9c42256fffc..ad00d160a42 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.35/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.35/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.35/qiskit.converters.dag_to_dagdependency.md index daa815af045..1e01418fa01 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.35/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_circuit.md index 4a9abfaec4b..babbac72185 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_dag.md index 546ec988c6f..7b5330ed340 100644 --- a/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.35/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.md index 3becfb9cbb1..ebab06cae23 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -238,7 +238,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -248,7 +248,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -260,7 +260,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -268,7 +268,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -292,7 +292,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -314,7 +314,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -341,7 +341,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -349,7 +349,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -365,7 +365,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -373,7 +373,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -393,7 +393,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -401,7 +401,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -409,7 +409,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -423,7 +423,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -431,7 +431,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -439,7 +439,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -447,7 +447,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -455,7 +455,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -475,7 +475,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -487,7 +487,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -508,7 +508,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -516,7 +516,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -524,7 +524,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -532,7 +532,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -553,7 +553,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -569,7 +569,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -577,7 +577,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -585,7 +585,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -593,7 +593,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -617,7 +617,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -630,7 +630,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -638,7 +638,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -646,7 +646,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -654,7 +654,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -664,7 +664,7 @@ Add edges from predecessors to successors. -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single. @@ -685,7 +685,7 @@ This is used to consolidate a block of DAGOpNodes into a single operation. A typ -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -701,7 +701,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -711,7 +711,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -719,7 +719,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -746,7 +746,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -772,7 +772,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -780,7 +780,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -788,7 +788,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -808,7 +808,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -830,7 +830,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -838,7 +838,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.md index a8b959a47cb..87eeb8548fe 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.md index 0f3b98266af..72e2f0cc67f 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.md index c75b21f4dc2..b5f0b2f0f80 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.md index 8287b64f573..1f3f04d50b2 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.md index b910aac4083..8b1875c31b6 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.md index 53d3bcbcb83..0de38b8ada8 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.md index e4884205fe7..2c3ed36bb20 100644 --- a/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.35/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.md index 49abc338e9d..28671fcf742 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.35/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.35/qiskit.extensions.Initialize.md index be3463aaac7..b2412ce9b9b 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.35/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.md index 1b91c247d73..fa7dd8a1697 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.35/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.md index ef6ccfd9949..fd95e14759e 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.35/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.md index c9be376388c..799315d9b27 100644 --- a/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.35/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -124,7 +124,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -132,7 +132,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -181,7 +181,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -313,7 +313,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -321,7 +321,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.md index b6a065421b3..f7bcabbf999 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.md index 445940b2453..cb4c05d6690 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.md index 72390a7400f..f1dd548a089 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.md index 8e34b105743..34bb022876f 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.md index 6d992298e71..0fb7f2385e9 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.md index 34fb34bbd65..f249e3e7a7c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.md index d6a0edbb6ec..973f43032e3 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.md index 372f017addd..28a066d8ce8 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.md index c0278abfc7e..207580331a4 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.md index f6032306e0e..0d5de5146a4 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.md index ca32ce2a39a..391277c14a8 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.md index d5ef72ada1e..15ccd84be1c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 403817016d4..53d9fc2448d 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_cx_circuits.md index 09dc059db30..23052c4321f 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_1Q_circuits.md index bea081fef35..7457a6a8d7b 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_cx_circuits.md index fff2b94403d..26d2f78212f 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.drag_schedules.md index 0af961d3c2f..7352fe740d7 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.get_single_q_pulse.md index dc53d3a0226..4f6fbde2321 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.rabi_schedules.md index 42ea4ca52bd..aa0bbcbf677 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.t1_circuits.md index 508ad9af4d6..e4a3cc2e03c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2_circuits.md index 04c20edb55f..b9f20d4cbd3 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2star_circuits.md index fd7a3a9313e..0fae4900b05 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.update_u_gates.md index 5d9b1fa3315..d72811bf256 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.35/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.characterization.zz_circuits.md index 1188ca79ac3..02ca087303c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.md index ad2fef2c8f5..60d8b19a375 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.md index 2755cdcb815..91335aa8873 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.md index 0b95a9f7a46..ab74a5b494f 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.md index 0866faeff43..86c1b8d75a0 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.md index 877a0613248..6b0aa21b2f1 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.md index ef7794ad9f7..3df5b0cd935 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 10b24aab347..5e3982fea64 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.md index baa69f9e0b9..54bb0a1ba3c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 1f75d6df980..46a867616d4 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0d3f8eb3543..78443ccf05a 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.md index f8ee6953663..0edea69dc53 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index f56948c221f..a0afa4a5ebd 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.md index 083559659f0..c9ed1e0fe59 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 15ee8da8a10..fa11407f7b0 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.md index bfa7ac5af6d..afe433ce0ec 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.md index e8f9921e866..a9dae640d04 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.complete_meas_cal.md index d8e9218ffdd..5108e210fec 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expectation_value.md index a235ad984f0..4709cbce409 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index d3a2a786083..9491646c0e0 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.tensored_meas_cal.md index 2c0591998d6..c09b4736d27 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.md index 0a5224159fe..cb2f7b29eb2 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -59,7 +59,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.md index e99c8d57b07..9e28ade246a 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Data can be input either as qiskit result objects, or as lists of bitstrings (th -`AccreditationFitter.AppendResults(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.AppendResults(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single run of accreditation protocol, data input as qiskit result object assumed to be single shot @@ -49,7 +49,7 @@ Single run of accreditation protocol, data input as qiskit result object assumed -`AccreditationFitter.AppendStrings(strings, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.AppendStrings(strings, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single run of accreditation protocol, data input as a list of output strings @@ -63,7 +63,7 @@ Single run of accreditation protocol, data input as a list of output strings -`AccreditationFitter.FullAccreditation(confidence)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.FullAccreditation(confidence)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence interval desired. This protocol is from \[1] and fully treats non-Markovian errors @@ -87,7 +87,7 @@ dict -`AccreditationFitter.MeanAccreditation(confidence)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.MeanAccreditation(confidence)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence interval desired. This protocol is from \[2] and assumes Markovianity but gives an improved bound @@ -107,7 +107,7 @@ dict -`AccreditationFitter.Reset()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.Reset()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Reset the accreditation class object @@ -115,7 +115,7 @@ Reset the accreditation class object -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") DEPRECATED-This function computes the bound on variation distance based and the confidence :param theta: number between 0 and 1 :type theta: float @@ -127,7 +127,7 @@ DEPRECATED-This function computes the bound on variation distance based and the -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") DEPRECATED-Single protocol run of accreditation protocol :param results: results of the quantum job :type results: Result :param postp\_list: list of strings used to post-process outputs :type postp\_list: list :param v\_zero: position of target :type v\_zero: int diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.md index 4fc927ea9fa..7173a7fad94 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.md index f916cb66faf..d0557c6955a 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.md index 583deb9126f..c60cbebb3a7 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.md index 304851b8e69..5cd02b0fd01 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None, brute=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None, brute=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results, logical='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results, logical='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. :param results: A results dictionary, as produced by the :type results: dict :param process\_results method of the code.: :param logical: Logical value whose results are used. :type logical: string @@ -52,7 +52,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -72,7 +72,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -92,7 +92,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -116,7 +116,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.md index 904bf41bcce..2e320a8d621 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.md index 546ec4b3d0a..d17997d3f38 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.md index ac47c456f8d..32fd28d2bc6 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.md index d5895121282..2a93804ae9b 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTP.md index 73b24b6b443..94055214d79 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectCounts.md index a01de06d5bf..c65ef987a54 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectString.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectString.md index e17c285b023..bcda1ea7fb5 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectString.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.QOTPCorrectString.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectString -`QOTPCorrectString(qotp_string, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectString(qotp_string, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a measurement string, shifting the qotp diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.md index d727c76d29c..ffda35caa18 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.md index 88a92ae06e8..7aeb89808e7 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.md index 46b369b81ad..cf96f6d2bdb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0, xbasis=False, resets=False, delay=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0, xbasis=False, resets=False, delay=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -50,7 +50,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -74,7 +74,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -82,7 +82,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(final=False, barrier=False, delay=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(final=False, barrier=False, delay=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -96,7 +96,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.md index 943b23e550a..6d75bf220ce 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.md index 508c52aef7b..1d6f0728a6d 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epc.md index c438e74ea51..6a21000a800 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epg.md index d5722d92327..a3233d6c5f8 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epc.md index 72dfdb86c02..d31054f275f 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epg.md index 8144d7203da..67a3f8aaf54 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.coherence_limit.md index 03981397ec3..80526b35de2 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.combine_counts.md index 2ebdbacad89..9e8adbdd4c9 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z.md index 80e7bf056b5..28715965b77 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z_expvalue.md index a7ae10b833c..c04f146899b 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.count_gates.md index 44b548665be..850c6feec6b 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.count_keys.md index 6f44c215679..bb417e61fed 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.expectation_counts.md index 975c0154436..1f2256aeb5c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.gates_per_clifford.md index 7e60d7b1d68..e0075055ca6 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.gateset_tomography_circuits.md index db01bf2a76f..27026f4adea 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc.md index 5b5131afc30..4f255fd9f2d 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc_para.md index f4dd3e599c9..3358ebb30cb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po.md index c3804f6fb55..e70e4458ea4 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po_para.md index 3000fbba603..97b6773cbdb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_simple.md index 034766ed548..3f5471787bb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.lookuptable_decoding.md index f0dd6c9571b..44e5019912a 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.marginal_counts.md index 5389acadc83..7ee9f59cc18 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.ordered_list_generator.md index c1e174d8460..baa787e47d6 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.postselection_decoding.md index 60df02a7ab6..50215c213dc 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.process_tomography_circuits.md index 468696a3fb2..ba1ef665a33 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.qv_circuits.md index 471a2aadfc2..cb96d7e931c 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.randomized_benchmarking_seq.md index d0db986adbc..d0d740ecefb 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.rho_to_fidelity.md index 882eb7fb26c..1576597133e 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.state_tomography_circuits.md index 8ebd16870cb..6e232437363 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.twoQ_clifford_error.md index 20364819a15..36eb1281be7 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.md index 7b1f73f7f16..fde3b7e1299 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.md index 5a206826e93..dbdea0dc70d 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.35/qiskit.opflow.anti_commutator.md index 14c6786f03a..ea8d838548e 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.commutator.md b/docs/api/qiskit/0.35/qiskit.opflow.commutator.md index e6e237e6c18..d4b058854b3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.md index 42416e19455..9faf73b4408 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.md index cfd6569b3a5..f0288197837 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.md index 96a064d3308..64a6a9d2884 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.md index 79a94a6d9b5..d55e8dd0267 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.md index ce76fcb233c..cb2ae0b0983 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.md index eebf48b0298..c3e73b60451 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.35/qiskit.opflow.double_commutator.md index dad7f9dd505..8ef58dabf09 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.md index a14ceef2475..1c1cedd223b 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.md index a67b4b41b51..749cbb7bac4 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.md index f7249508271..2137c21b745 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.md index 8cfa87748fb..9eda01c6a08 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.md index e80673df1d1..e6c32bd7926 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.md index 82b0edb14f2..96bb536a215 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.md index 3445ecd128f..31f71deceb7 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.md index c993504d0f4..be86b40e5b3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.md index 3a0803b5920..addc1408ea8 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.md index 1aa43b3b813..1217f3d7e24 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.md index 3c38314cc47..f2e819654d1 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.md index 0eeb44d03c4..81d72aeb683 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.md index 209dffbe780..30438ae4008 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.md index a6c3cbea941..ebf431c7db2 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.md index 957af810215..d34b9a4123a 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.md index 4daf8c8034b..628f20685c4 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.md index 6afc7bb0eed..e6c3b682609 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.md index bf8881960e7..e00258ba1cf 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.md index 92a0989eeaf..6d629d70278 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.md index a79bf38be5d..81477d9eb45 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.md index 9766688f647..6751f67d920 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.md index 3b3d81f8527..2399432d7e5 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.md index d47366ec179..bef62d87dd5 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.md index dc1f576aaa6..9f1ba55f4b3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.md index 082cb47c934..f56a7959b70 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.md index 9460866c4f2..5e32f4a7ae4 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.md index a95aaf7c82f..b139706e5ca 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.md index c3bce0deda8..56201cfc751 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.md index bb9057d009e..2e25b6470ab 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.md index 7482f9f2c42..7f1e0029f60 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.md index 75fdd5416db..87948a4dbb1 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.md index ab2f0479e08..0676f775188 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.md index 3f2c221d970..44bbc60c27f 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.md index 8c7a3630923..f16c1d823f7 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -181,7 +181,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -193,7 +193,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -215,7 +215,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -235,7 +235,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -259,7 +259,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -275,7 +275,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -296,7 +296,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.md index 8860500d6b7..9654316c3cd 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index f4a8ad71339..12908688c83 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.md index fcc16288fdf..0143ccb3e62 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -66,7 +66,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -82,7 +82,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -90,7 +90,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.md index 42640937a93..055753c7588 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.md index e564d3595b0..c3a513401b1 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.md index 4bb3ed2ed86..985256b364b 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.md index 23d0f6d7d53..16f2e3c22d3 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.md index 513e1cdc15e..6b2bcb3a59c 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.md index 75e020c6c22..f4ffc46948e 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.md index 5b631f7adb2..a7648461b44 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.md index 958e26ce2cb..e9bd4a21ee8 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.35/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits, observables, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") +`BaseEstimator(circuits, observables, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") Bases: `abc.ABC` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`abstract BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") +`abstract BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.md index 5a513c47f85..f2a905f0f6d 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.35/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") +`BaseSampler(circuits, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") Bases: `abc.ABC` @@ -33,7 +33,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`abstract BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") +`abstract BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.35/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.35/qiskit.primitives.Estimator.md index ffe8f8f1ccc..d0425443cca 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.35/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits, observables, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits, observables, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") Bases: `qiskit.primitives.base_estimator.BaseEstimator` @@ -35,7 +35,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.md index 283a28acc53..93c00d5d831 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.35/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.35/qiskit.primitives.Sampler.md index d0fa46368b3..230e4021e18 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.35/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") Bases: `qiskit.primitives.base_sampler.BaseSampler` @@ -30,7 +30,7 @@ Sampler class -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.md index 922ae049a2f..ece4ccfda60 100644 --- a/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.35/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.providers.Backend.md b/docs/api/qiskit/0.35/qiskit.providers.Backend.md index 66843ac6699..beae1b515d3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.35/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.md index 0b0a32177d5..9ca4b967328 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.35/qiskit.providers.BackendV1.md index b104b2049f7..c6efab63d2f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.35/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.35/qiskit.providers.BackendV2.md index eb70e8352a8..006b637234c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.35/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -43,7 +43,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -65,7 +65,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -93,7 +93,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -115,7 +115,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -137,7 +137,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -163,7 +163,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Run on the backend. @@ -186,7 +186,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.md index 9a21f288dd2..cc3824df29f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.35/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.35/qiskit.providers.BaseJob.md index 7d89ef2f73f..9ae813e8997 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.md index 900c488347f..06875420712 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.35/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.35/qiskit.providers.Job.md b/docs/api/qiskit/0.35/qiskit.providers.Job.md index fbe9fa5c3de..b384f9a17f1 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.35/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobError.md b/docs/api/qiskit/0.35/qiskit.providers.JobError.md index e33482e9c92..84527fb1dcb 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.35/qiskit.providers.JobStatus.md index 0d5d4d6cfdb..507d1adab7d 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.35/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.md index 68590082dba..959344f5dee 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.35/qiskit.providers.JobV1.md b/docs/api/qiskit/0.35/qiskit.providers.JobV1.md index 1e6ac2ffe9e..9b712b5241e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.35/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.35/qiskit.providers.Options.md b/docs/api/qiskit/0.35/qiskit.providers.Options.md index d3b52e9320b..29e4a2c7850 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.35/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.35/qiskit.providers.Provider.md b/docs/api/qiskit/0.35/qiskit.providers.Provider.md index 3d2b6efc9ba..7c6faf3e82c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.35/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.md index c76217bea8b..32f4c78a6be 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.md index 4486b31c895..52695155607 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.md index 3b8775fb669..aa05de6ae71 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.35/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.md index c9d0d668a98..03f100aa884 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.md index 7df0e876c34..6a631f16582 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.md index 0c07b8a06bb..159dbb1bece 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -185,7 +185,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -193,7 +193,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -209,7 +209,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -243,7 +243,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -251,7 +251,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -339,7 +339,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.md index e9f6b725254..cfb27ed06ea 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.md index 2faf456b13d..5f5fea54d4b 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.md index f84f6ceec55..d170055da16 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.md index 6d7f8665b69..90aaf4fe5bd 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.md index 94b6522592e..b22daa40acb 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -111,7 +111,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -119,7 +119,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 0effff46a9a..56c29f35d49 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 743c9408ff8..84120db53fa 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.md index c8497e60b44..fbb528874c4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.md index d8d2ae01540..dadfc41ebbd 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.md index f8ca5b63d6b..b337f8c3c3a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.md index a1b096ece7a..e1e3aeefb39 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.md index ed165a97cc0..f5dad3cc8a6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.md index 6cd0ccbbda0..ecf7551eaba 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.md index 3bb5a22d24d..f08248e8cd1 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.md index 2876e2ff7bd..4eb1cae5a01 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.md index dcc719376c5..e0c50f4fe13 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.md index e9494d58227..7daa7f03ef3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 56e913d9a4d..4e7f01b87aa 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.md index 7358d9a8a17..2dae85d2dd8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.md index 1fdfbb7a05f..7b3ad852ad6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.md index edbb5c8c6a2..7c2e4185223 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.md index d577c32fe20..b6d300f74f6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.md index d7c7bfb82d4..0449c2a77e5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.md index b99cb90d53f..ea16c1cff47 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.md index 219f710cdbb..34e834a4ae5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.md index 375e743630f..b4ab370a921 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.md index 0917e55c6b3..02a2cffc041 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.md index 43d30bb001d..8d4bebbc69e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.md index 0ad05f62172..3364dc61d71 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.md index 3cf8ca8847e..34beb03bb0f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.md index 131b898643f..d6d56e3e96c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.md index b2b771c82ea..3be0f145103 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.md index cae997d02f4..8c64b1953b8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes.md index 6a13d926a38..a4a203a3491 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes_squared.md index 062a1c91353..eea7d4cf9e0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_clifford.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_clifford.md index 4f14f97b138..000ca032692 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_clifford.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_density_matrix.md index 291686fe2db..282a10cb17d 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value.md index 7103d8722b2..e75393f0cff 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value_variance.md index a24adf5e5a1..4e195786ad8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_matrix_product_state.md index c670bea271c..6d69aa8667c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities.md index 7ca5a88ff97..2dacdffc24c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities_dict.md index f073b756427..dd06f62df2c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_stabilizer.md index 1a4f726abb7..35ab80e59f5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_state.md index 7b05f633ceb..855e187fc51 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector.md index 81e559b9687..a7b4154840a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector_dict.md index 5dcfd30ee90..ec01caea11d 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_superop.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_superop.md index 0ecef858f02..b154bb253d3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_superop.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_unitary.md index 8db27bbcb5b..7b0c94f151b 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_density_matrix.md index 5b553a67c48..8bb80af7d7e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_matrix_product_state.md index d98c5a76865..15e771861e8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_stabilizer.md index ce7e9a509b5..9912834fdf6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_statevector.md index e7581c0bcd6..cebb8fb0124 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_superop.md index 3dbebceb8fd..c93a433e30f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_unitary.md index d911d25a185..f9c8bccee08 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.md index 2f3f882ede1..c93f8e6d13c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: `DAGCircuit` :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.md index 1247e52f123..75abc490d96 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.md index b2eb61cf304..6c1162fb3fd 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -125,7 +125,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -150,7 +150,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -172,7 +172,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -246,7 +246,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -254,7 +254,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -262,7 +262,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -288,7 +288,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -296,7 +296,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -304,7 +304,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.md index 2fb79644c87..8eacb9c4d32 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.md index 8d2875d2d8f..322e3e6116c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: `qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass` diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.amplitude_damping_error.md index 2bc7de3d3e7..afef934915d 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.coherent_unitary_error.md index 1c9a2a9f64d..f8097665bd6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.depolarizing_error.md index bbbe4d0f7b7..07c710fea35 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ce7e7abaeba..c7f87eba5fa 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index fb277fd28dd..a577cfc022a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_error_values.md index 0ce4115bd93..c1f21a62240 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_length_values.md index 3c2c5f23334..f7992b91e97 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_param_values.md index 86a287d0afc..ce5427292f5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.readout_error_values.md index 88cd0f9ad0e..ab6e01038d7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index ec6e650fa60..6721ae46ec3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.kraus_error.md index f0fb3742112..56e560125f2 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.mixed_unitary_error.md index dd7f9434768..a6afa4cc627 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.pauli_error.md index ae03836579e..012f973c05c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index ffa103d1939..e23dc9a7b4a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_damping_error.md index 26d234433ce..c258bb0356e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.reset_error.md index 0de3a334da5..587100de267 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.thermal_relaxation_error.md index 2ae3454801c..fad6d2a0c8a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.md index 9a5c7da246e..faef97589c8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.duffing_system_model.md index a5e56ada57e..cc6b846aa7f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.md index a73fc8a3c38..bbcee90f47f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_noise_model.md index bc76519e380..721c78a3ee0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_quantum_error.md index 7375eab0182..079e1acaff4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.insert_noise.md index 745f84bfd4e..5d930938583 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.remap_noise_model.md index 4afa3125223..bbae7213024 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transform_noise_model.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transform_noise_model.md index 306e20e828f..c58b82a7b30 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_noise_model.md index 2a11b7f650b..c170a903bde 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_quantum_error.md index 6fd2be1adf3..15f5f62f783 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.35/qiskit.providers.aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.md index 1e38e511223..938d08cd1b8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.md index 37482d08983..c55ddd3d3d9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.md index 82447ca161a..952b5d9fc14 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.md index 826a7ae4303..addf46fe85f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 80605af28c2..26935607642 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.md index 63c12964f53..d56f604a560 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.35/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.md index ee377ff4552..080fed9feef 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.md index 85016b461db..27ee177b989 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index f32e6661621..142488e7e63 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 4f297b21f45..3ee143a7fbf 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index d5033de02b1..ec2b2ff9ece 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 657ec0e7086..e57c1ea3508 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.md index 24aff3b033d..162460e4350 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index eed050ae3bd..0503262f823 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.md index 0d53acc2879..a9f9fc174c1 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -475,7 +475,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.md index 4bdd0f2a060..3c7104091e7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index c041bbf3bf6..cc590ceedc4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.md index 6dc463b2421..0f3eb783aa8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.md index eb24ee9f625..9893019fc38 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -159,7 +159,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -175,7 +175,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.md index 86f9c45a3d5..9fbc296f482 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.md index 41652141dc8..653ebcaba50 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.md index 6e647420f52..da8eb8f9ae0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.md index eb4cebba7e4..f25a610ee3e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.md index 71d9c42f83f..3e1c60596ad 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.md index 78ec3d1dfb1..0bc0d7a3aa6 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.md index 04f279e0cd1..15321015cab 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 4f851752dc3..2df20de8748 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 08f3dd7e2c4..3233af88348 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.md index f954c886cda..1d6c1e5120a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 53f323ab1ab..57f08b83f90 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c2b7202cfc0..51a853d365e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.md index b160d6165e9..964dd419d39 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 1dc23cd056c..ee2630368f8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.md index 3d88360d8d8..014b28bf5ef 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.md index 7d91f3308c2..4778d5d52bc 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.md index dbf01e8af0b..be17ce9e5c5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.md index 1da1f4b7bfe..a8d7a644cc9 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 48bafa04842..2be074447b3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 740582bb1ce..b7cedbeec8f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 9078ea34ddf..608b47aa837 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.md index dddd6edda94..62fb25d7f62 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.job_monitor.md index d9170cecd42..6a1783f0042 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.least_busy.md index 60d12dd3e3c..438b1da7267 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.md index 0888b9afcd2..b0ef32a0af5 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index d89c8d9ca6b..501d8826c4c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 8ce6b93b8f5..48e1f0b6e9c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 83cc49d15fa..62fa44f7e9f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 2d51d9d9f15..5dda3344b39 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 944b4b473e9..ef871dc887a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index c3dbd53a191..49f863db3c3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.md index bb0c317e8c0..30d26bd4a7c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.md index 80baee65fb7..6e87d25958e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.md index 3591537cc7a..aabdf063346 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.md index 5298496e3cb..22dc0c14329 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractor -`CQCExtractor(name, provider, client, methods)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor(name, provider, client, methods)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Bases: `qiskit.providers.ibmq.random.baserandomservice.BaseRandomService` @@ -49,7 +49,7 @@ BaseRandomService constructor. -`CQCExtractor.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Retrieve a previously submitted job. @@ -69,7 +69,7 @@ A `CQCExtractorJob` instance. -`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Process input data synchronously. @@ -95,7 +95,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext1(ext1_input_num_bits, ext1_output_num_bits, ext1_raw_bytes, ext1_wsr_bytes)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the first extractor asynchronously. @@ -122,7 +122,7 @@ An instance of `CQCExtractorJob` which can be used to retrieve the results later -`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") +`CQCExtractor.run_async_ext2(ext2_seed, ext2_seed_num_bits, ext2_wsr_multiplier, ext2_wsr_generator=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractor.py "view source code") Run the second extractor asynchronously. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.md index 1641499d8ce..f578a084e2c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.CQCExtractorJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob -`CQCExtractorJob(job_id, client, parameters=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob(job_id, client, parameters=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ CQCExtractorJob constructor. -`CQCExtractorJob.block_until_ready(timeout=None, wait=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.block_until_ready(timeout=None, wait=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Wait for the job to finish and return the result. @@ -70,7 +70,7 @@ Extractor output. -`CQCExtractorJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") +`CQCExtractorJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/cqcextractorjob.py "view source code") Query the server for the latest job status. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.md index abc92c11bae..4a3f981d3bd 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.random.IBMQRandomService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.random.IBMQRandomService -`IBMQRandomService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ IBMQRandomService constructor. -`IBMQRandomService.get_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.get_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return the random number service with the given name. @@ -60,7 +60,7 @@ Service with the given name. -`IBMQRandomService.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") +`IBMQRandomService.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/random/ibmqrandomservice.py "view source code") Return all random number services available to this account. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 0cb641d0679..e39ed872192 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.md index f7097ba33fc..a20d4c57991 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.md index 5a29db09af8..b298f71d3ef 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9cdaa136c33..efa85d6c02c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a2dd9a65d86..e889c6db58a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index baee1780106..08990c0507e 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.md index 98706a664ff..3a6a6148fc8 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 373af1cfb82..68152ef5044 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.md index 9b54f2fc279..5f60edd2c6f 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.seconds_to_duration.md index 8d21231dabf..c1f60744b78 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.to_python_identifier.md index 44ab31ee0c5..9fa8bc0baa4 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.update_qobj_config.md index c126d25f613..ff1f78e53d3 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.utc_to_local.md index 2ad496aa570..da6c598463d 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.validate_job_tags.md index b96de6d5ac2..a8f10ceb6a0 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.35/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.md index 2e882ec52c8..5edb33673da 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.md index f383607f56d..19cf4a87864 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.md index 836211f0158..535eb1ccaed 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.Command.md b/docs/api/qiskit/0.35/qiskit.providers.models.Command.md index 9fff6e93f43..c1dba1464a7 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.md index f11a7e89ce2..fd50ca8850a 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.md index 6713a1e4e36..871eadba82c 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.md index c85a6697c25..e2a463ea650 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.md index 81cf50a0929..dd8f24609fc 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.md index bdbfaf2a08f..d3935144566 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.md index 478ed61e10b..aa2d1186604 100644 --- a/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.35/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.md index eab182f9c9c..0842f1cc2c9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -159,7 +159,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -182,7 +182,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -204,7 +204,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -228,7 +228,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.35/qiskit.pulse.Schedule.md index 53b0c5bfcb8..6b93b443103 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.md index 4d4ccadd252..f6268735b7b 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -172,7 +172,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -205,7 +205,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -236,7 +236,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -258,7 +258,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -283,7 +283,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -295,7 +295,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -307,7 +307,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire.md index d1242c6ce73..c4805cef358 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire_channel.md index ce14e982c35..4e0885d4cf0 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.active_backend.md index abb4c0fbb50..4bd9ea4f9ba 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 3354d2d954d..1ba77612031 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.active_transpiler_settings.md index 7beff7bf866..0ec34745408 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_equispaced.md index 6a8ac7e5893..2e2d1c2e316 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_func.md index 73cdfcf3354..563fda7b766 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_left.md index 7c2634f9a7f..b6ab1c16977 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_right.md index f7b81010ef7..1deb4187ad9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_sequential.md index b8fb038329b..5c0e088898b 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.barrier.md index ec3a3e01509..e47ee360afe 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.build.md index f2306164cee..9aa1581ad19 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.call.md index 53da7d1410f..10520b707c9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.circuit_scheduler_settings.md index 4e66f31a9ca..35721d2548d 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.control_channels.md index b93f52f2a8a..9c44e15c1e4 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.cx.md index 98e45af7626..8705e3dd282 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.delay.md index d30b2a7c5f5..3dd545490c3 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.delay_qubits.md index 00db7636f65..f5f31f70f70 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.drive_channel.md index e09bb0d98cf..a5ae38f7a88 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.frequency_offset.md index 82243f1d40b..100dab400b0 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.inline.md index 5c9f0ece200..6a07993e97f 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.measure.md index 39c413b92ad..ec452f6429c 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_all.md index 0593933a940..9ae939c44c3 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_channel.md index a647950b6d6..40c2d6d0729 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.num_qubits.md index ba317700bce..205f78e3b14 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.pad.md index d7bc6474a8e..b1cff65509f 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.phase_offset.md index 5ab7b24936d..45535496657 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.play.md index 71481fc663c..428592a501a 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.qubit_channels.md index 5cc79c8b6ec..bb994753dc1 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.samples_to_seconds.md index 24b22c95263..26cbc393521 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.seconds_to_samples.md index 323c200626a..e1b633f26bb 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.set_frequency.md index 790aeb3778f..600f59a6f5b 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.set_phase.md index 3356de2d586..6bf03d65108 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_frequency.md index 463185fa16b..72263b56d1f 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_phase.md index 5c4a7811dd0..93e43229df9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.snapshot.md index 114a1ea0431..2cf63be72f4 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.transpiler_settings.md index faf2d8bb473..3cc5f0bc44c 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.u1.md index ec94d5d431f..5af2cc49c6e 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.u2.md index b54ecdb8538..1ed0f2ae1b4 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.u3.md index f974b1a1331..b55fddacc81 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.35/qiskit.pulse.builder.x.md index 9bdb6c5521c..b629d61f18d 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.md index f54ccb38bf0..262efbe455d 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.md index e409060dc02..0193fc63d82 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.md index 92b7eb150a7..94d0938f6b6 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.md index 7f135a974e8..5951fea20ac 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.md index 7a689c3e57e..d2e182f2217 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.md index 7e603f715b5..2b41764bb9e 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.md index d279736a2b2..c299d9b6355 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.md index 8fab418b298..0798b148701 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.md index 282095c74cb..de0fb2b4521 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -182,7 +182,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.md index 122b7403b00..44fd8543bff 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.md index 0f31e7171c9..69af2ff3140 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -158,7 +158,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.md index 61c961b49fb..cbf4d509736 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.md index f4a19b5fd13..bf6b0b2ffcc 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.md index fe13e79e157..ed3195d8fed 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.md index 4f13a452cb1..e049ee55e45 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.md index f1509bc5b4d..e8d343a3b0b 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -156,7 +156,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.md index efa24787b24..eaae5a227fc 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -74,7 +74,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -98,7 +98,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.md index ccec7dae295..8cc976325af 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -90,7 +90,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -114,7 +114,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.md index 71891b1e1c5..503517f0a37 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -79,7 +79,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -103,7 +103,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.md index 28235a7cc2b..c1b037506d5 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -100,7 +100,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -124,7 +124,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.md index c88d2ad2ee8..c3727e2db2f 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.md index 092fd331074..95a15126a0f 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.md index f92b49a3b28..bcd25976bb5 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -40,7 +40,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -62,7 +62,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.md index a4ec79ffe46..523e605c02c 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.md index fec0b17a0d1..63d1709083e 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.md index bfb87982809..ebfa94974e9 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.add_implicit_acquires.md index 84d86e4e5ce..a85c2b8ea9c 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.align_measures.md index b5c0ddccadc..f7a964675b6 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_dag.md index ab538bfba45..d8a5f9f1984 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_schedule.md index 280beccb66d..dadb0739eb0 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.compress_pulses.md index 49a6afe3a6f..36c8cc58c63 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.flatten.md index 354ebae4494..ca7f50f8ddc 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.inline_subroutines.md index 671870a6921..fbb0d1b670f 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.pad.md index 908d9720833..e19cd141a6b 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_directives.md index 96d4300d742..bedc1f0adb5 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_trivial_barriers.md index 0c432ca8327..5a24f4ce9e8 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.35/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.35/qiskit.pulse.transforms.target_qobj_transform.md index 116aa3591fc..df9d8e5d391 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.md index 3bfb5dbc4a5..5f7ad88749b 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.35/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.35/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.35/qiskit.qasm.Qasm.md index bf1c657b9ed..f641bac6cc9 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.35/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.35/qiskit.qasm.QasmError.md index 7cf5ea64990..75ed0133960 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.35/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.md index e4b71b68864..3cab110918d 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.35/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.md index 1636b919c06..41e0a2b84c8 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.35/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.md b/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.md index d3e15696846..6b45938f666 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.md +++ b/docs/api/qiskit/0.35/qiskit.qasm3.Exporter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.Exporter -`Exporter(includes=('stdgates.inc'), basis_gates=('U'), disable_constants=False, alias_classical_registers=False, indent=' ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc'), basis_gates=('U'), disable_constants=False, alias_classical_registers=False, indent=' ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ QASM3 expoter main class. -`Exporter.dump(circuit, stream)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") +`Exporter.dump(circuit, stream)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, dumping the result to a file or text stream. @@ -38,7 +38,7 @@ Convert the circuit to QASM 3, dumping the result to a file or text stream. -`Exporter.dumps(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") +`Exporter.dumps(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, returning the result as a string. diff --git a/docs/api/qiskit/0.35/qiskit.qasm3.dump.md b/docs/api/qiskit/0.35/qiskit.qasm3.dump.md index 106af24c5af..c57416a0fb4 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm3.dump.md +++ b/docs/api/qiskit/0.35/qiskit.qasm3.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dump -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. diff --git a/docs/api/qiskit/0.35/qiskit.qasm3.dumps.md b/docs/api/qiskit/0.35/qiskit.qasm3.dumps.md index ae9babda8fb..12a77f3a97a 100644 --- a/docs/api/qiskit/0.35/qiskit.qasm3.dumps.md +++ b/docs/api/qiskit/0.35/qiskit.qasm3.dumps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dumps -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.md index 66c94664568..c96e3315016 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.md index 959da95f30c..e403149ff85 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.md index 83271dddaad..ee3760cc166 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.md index f94142dcaa4..9319838522f 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.md index a4b79ebcb21..f80166ebdc6 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.md index ecdbee859d5..ceb39f813e4 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.md index d51b752badb..947ec78baf8 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.md index a64ace23b28..8faf5129afe 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.md index 00b96eaf98d..79ee7127c61 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.md index d0db1ec0e56..af4e2acdc64 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.md index 57453d78ee4..25a239a39a9 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.md index 8344aa4bb10..6c222b1b2cd 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.md index b762ea626f8..e9c6cf4fe89 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.35/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.35/qiskit.qobj.Qobj.md index b222d8df347..a66a40bb9df 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.md index c1feee6bf68..3861acdf1fe 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.md index 9f0afefc340..6def63cc9a4 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.md index 91872f2e84a..a74bde804a2 100644 --- a/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.35/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.35/qiskit.qpy.dump.md b/docs/api/qiskit/0.35/qiskit.qpy.dump.md index 2f5234ba0d0..8eb0e331e71 100644 --- a/docs/api/qiskit/0.35/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.35/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(circuits, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") +`dump(circuits, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.35/qiskit.qpy.load.md b/docs/api/qiskit/0.35/qiskit.qpy.load.md index c200937c2bb..6ebc6eb2852 100644 --- a/docs/api/qiskit/0.35/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.35/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.md index 31d34e2d1a5..58f666bf093 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.md index df40b285eed..385f69375e1 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.md index 2e6f3f0ffbb..4b7b7cc49cf 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.md index ad0d17612f7..022a9d3e51b 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.md index a266f060e99..bb8ee4738ce 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.md index 66483628c72..ae2d77071d4 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.md index e6885700d60..e7d23bdeb56 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.md index 4716125ae90..4fb9d73cc7b 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a :class\`.QuantumCircuit\` @@ -197,7 +197,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -233,7 +233,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -249,7 +249,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -299,7 +299,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -317,7 +317,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -343,7 +343,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -351,7 +351,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -359,7 +359,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.md index 1ac34bab986..c7101c6a327 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.md index 47b71583fa1..2b61bc4aac7 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -347,7 +347,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -369,7 +369,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -404,7 +404,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -429,7 +429,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -463,7 +463,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -471,7 +471,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -503,7 +503,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -549,7 +549,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -598,7 +598,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -614,7 +614,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -639,7 +639,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -665,7 +665,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -673,7 +673,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -693,7 +693,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -713,7 +713,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -731,7 +731,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -739,7 +739,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -766,7 +766,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.md index 005e5dc80c6..aa7d7c9faff 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -445,7 +445,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -473,7 +473,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -481,7 +481,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -499,7 +499,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -579,7 +579,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -642,7 +642,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -666,7 +666,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -695,7 +695,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -725,7 +725,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -733,7 +733,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.md index f26b35d24dc..7b8d0fa1534 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.md index 573b490902e..dc04d001ba0 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.md index 56103f28f92..7fe5a82e404 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.md index ca340631cd5..75a95a2ea5b 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -50,7 +50,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -82,7 +82,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -114,7 +114,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -151,7 +151,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -171,7 +171,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -193,7 +193,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -230,7 +230,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -258,7 +258,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -310,7 +310,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -331,7 +331,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -349,7 +349,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -429,7 +429,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -450,7 +450,7 @@ the simplified SparsePauliOp operator. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -478,7 +478,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -504,7 +504,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -526,7 +526,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -546,7 +546,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -554,7 +554,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.md index b845e19e728..f3e3e272352 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.md index bb99d39c082..7ea8603f9f4 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.md index cd3479489fa..0f818c1c094 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ $$ -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.md index 772f0ccd1b0..9600c56ef4e 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.md index 3c93434e13c..3286293e1a7 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.md index f237b703ad1..4959639e60a 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.md index 18ad9e29f9e..d90f6833c71 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.35/qiskit.quantum_info.average_gate_fidelity.md index 743e56295f5..6451c0c7acb 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.35/qiskit.quantum_info.concurrence.md index 29db8f79c68..4e6d6c31f3c 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.35/qiskit.quantum_info.decompose_clifford.md index 0977b2af9af..f39e4af5a53 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.35/qiskit.quantum_info.diamond_norm.md index cc78e8799a7..7fbf9407043 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.35/qiskit.quantum_info.entanglement_of_formation.md index a2de55c7530..b6843c760f0 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.35/qiskit.quantum_info.entropy.md index 1b2fa0bbfcb..fdbc923b866 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.35/qiskit.quantum_info.gate_error.md index f46ff5e927c..b83792c2652 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_distance.md index 3275e7abd45..e173ce3398f 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_fidelity.md index 67c29897b45..42b6a8c6b24 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.35/qiskit.quantum_info.mutual_information.md index 5fd548fd56c..de3d983f801 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.35/qiskit.quantum_info.partial_trace.md index 2f122e68f68..47e818f0e16 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_basis.md index f454f161bae..6f93279cc5e 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_group.md index ec2e36713f9..ce8f3bfb931 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.35/qiskit.quantum_info.process_fidelity.md index 53261f5d34c..afeb05cd471 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.35/qiskit.quantum_info.purity.md index 6cb55a03680..b32cb1222a0 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_clifford.md index 68637c8285e..a47985f2545 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_cnotdihedral.md index 4e3c02091df..588f376c9a0 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_density_matrix.md index 536c4f7262e..fe8f537855f 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_hermitian.md index fdce5351522..78882f0faca 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli.md index 63221c8dc51..b767750dbfe 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_list.md index 1784056c15c..af0e32a6bb0 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_table.md index b7d7da6acf0..0859b0588a3 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_quantum_channel.md index df8079f5c1e..3e77e5781d8 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_stabilizer_table.md index 73b883918d9..35127b648ef 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_statevector.md index 60937878564..391daa31dfd 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.35/qiskit.quantum_info.random_unitary.md index 0f1d88370af..f1d163a029e 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.35/qiskit.quantum_info.shannon_entropy.md index 9b062321bba..45d32f196aa 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.35/qiskit.quantum_info.state_fidelity.md index ec0aa4301fd..a564457ae3a 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.md index e391e77a691..d74d84c37cf 100644 --- a/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.35/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.md index c1889a2e744..91218d440f9 100644 --- a/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.35/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.35/qiskit.result.Counts.md b/docs/api/qiskit/0.35/qiskit.result.Counts.md index fc4e7866616..33c59e99530 100644 --- a/docs/api/qiskit/0.35/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.35/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.md index 3e827ea8614..34d704c558a 100644 --- a/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.35/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.md index 6e6886cbd7c..5fe8f7929ce 100644 --- a/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.35/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.md index 7d41423a523..e1063a0a99c 100644 --- a/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.35/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.35/qiskit.result.Result.md b/docs/api/qiskit/0.35/qiskit.result.Result.md index 19c1b7f74f6..f03c65acce7 100644 --- a/docs/api/qiskit/0.35/qiskit.result.Result.md +++ b/docs/api/qiskit/0.35/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.35/qiskit.result.ResultError.md b/docs/api/qiskit/0.35/qiskit.result.ResultError.md index 1efd25bf48f..dc06796d815 100644 --- a/docs/api/qiskit/0.35/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.35/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.35/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.35/qiskit.result.marginal_counts.md index 05ec33193a3..3b4be4c8a38 100644 --- a/docs/api/qiskit/0.35/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.35/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.md index 4315f042b2e..1494be0bfa9 100644 --- a/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.md index bdd4f17b1a0..e20450dd744 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.35/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.md index 6a92b6585a6..de7b7eeb472 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.35/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.md index d1e0b23aa82..cbd54998e37 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.35/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.md index 7ec13da4e80..6b39f743318 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.35/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` diff --git a/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.md index c9fd4038d82..861cfd32275 100644 --- a/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.35/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.35/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.35/qiskit.tools.backend_monitor.md index c5b36d2a0df..6895fb6a6ce 100644 --- a/docs/api/qiskit/0.35/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.35/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.35/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.35/qiskit.tools.backend_overview.md index 75bc0fce12e..6ea5e1bf948 100644 --- a/docs/api/qiskit/0.35/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.35/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.35/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.35/qiskit.tools.job_monitor.md index 8ed6c5299b4..e34c9c6bc0c 100644 --- a/docs/api/qiskit/0.35/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.35/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.35/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.35/qiskit.tools.parallel_map.md index e891170e10f..83ebb9b365e 100644 --- a/docs/api/qiskit/0.35/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.35/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.md index 81030dd67a3..5ea154e3309 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.md index 427fda69abb..fdf1491bb70 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `qiskit.transpiler.runningpassmanager.FlowController` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.md index 12943ef9200..eb82ac13e35 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -112,7 +112,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -124,7 +124,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -136,7 +136,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -161,7 +161,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -186,7 +186,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -208,7 +208,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -220,7 +220,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -232,7 +232,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -248,7 +248,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -258,7 +258,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -266,7 +266,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -274,7 +274,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -284,7 +284,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -308,7 +308,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -333,7 +333,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -341,7 +341,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.md index b4fb26ec3c0..00bd523209c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `qiskit.transpiler.runningpassmanager.FlowController` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.md index 2830ad0c600..4363c3799b9 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.md index 1a856121153..61a86290495 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.md index a5c2c89abf4..d126ec68c55 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.md index 9b553bd16f6..9ae1b7a6e94 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.md index 89b3bf44857..d5bb7feab11 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.35/qiskit.transpiler.Layout.md index 6a34db78289..5ba710d9a46 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.md index 92a274256eb..abc7940d58f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.md index d04411ea8fd..f3f4bfb591c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.md index c8cc48fa125..c7671214b16 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.Target.md b/docs/api/qiskit/0.35/qiskit.transpiler.Target.md index 976e90bc72e..1e151f56255 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -135,7 +135,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -162,7 +162,7 @@ for this target. -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -186,7 +186,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -208,7 +208,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -248,7 +248,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -264,7 +264,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -285,19 +285,19 @@ bool -`Target.items() → a set-like object providing a view on D’s items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D’s items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D’s keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D’s keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -317,7 +317,7 @@ The Instruction instance corresponding to the name -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -341,7 +341,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -365,7 +365,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -385,7 +385,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -401,7 +401,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -440,7 +440,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -458,7 +458,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D’s values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D’s values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.md index aec954902f2..25b45797158 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.md index addd02ebe09..c6b79a5d11b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.md index c3d28733064..d12ba1f95ec 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.md index d903f5efeb6..aa197323f0f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index dbbaab3644b..8cc505a3ebe 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.md index 1082ca56591..1b3e1c08ff1 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 189c9690bc3..56d559aec04 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.md index ec17d69d288..16f2126a4a2 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.md index 11d8232d0dc..f418bf6420b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.md index 285dea8ab05..cfcd3a5e1dc 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 7c7175a1fe3..36547080e34 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.md index ff653b61b62..ead76584e3e 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.md index a0cb9ae5069..5f938f3a8fe 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.md index 354711e5923..c0e24fcac39 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.md index 4e0e607f617..289e8123be6 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.md index 4d8d3f516e1..b935118e4e1 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.md index 075d2a510f8..018594a81d5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.md index 7859d8e2587..2699143983f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.md index 5c36fd7ab95..68a0d2166cc 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.md index f19265a3260..7c49ad395c5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.md index fe01b0339aa..4cb56c79b25 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.md index 00f9264a5d3..ce50aee72e2 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CollectLinearFunctions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Run the CollectLinearFunctions pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.md index a0f0b79a702..0d10ddef4aa 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.md index 9ac57f76fe5..8b23bb43eb1 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.md index 429640aefca..c7ef174c586 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.md index c799780945a..0e5b49ca2bf 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.md index 83aec8cef71..bea6c9ba68d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.md index 168657fdcd0..c2dc24314e6 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.md index f00cf4b1455..cb3e52ece3d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.md index 3c0f002e94b..8a472975afb 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index a4a70875de4..7fe5ca8b5ba 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.md index 20f94119d12..6777dbfac44 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.md index 1bde1c9dca0..23afd2ad006 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.md index f4ffe378e21..0d2a268a964 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None, gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None, gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.md index 471a653d254..971607ac8a9 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.md index eaeca2edce5..ecf226cb9d0 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.md index 128c60552c9..b17a6115c3c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 3874d403c99..ac189798e53 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.md index 0e8711c059a..f25ac71d650 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.md index 45978564b0f..4751054217f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.md index a635a3ae6b1..fa210844281 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.md index 7e1a76e296c..4f180fdf0d3 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.md index fb0d98b615e..5901ba8cc3f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.md index 096100f9e37..c63bb5a9ccf 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.md index 2023d671ac0..b277d8f84cc 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.md index 13eca66fb3b..eff13a3fea5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.md index 1f3afec1d03..1856eadc3d3 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index 7ea56e7da0c..1207e6811ee 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsSynthesis pass on dag. :type dag: `DAGCircuit` :param dag: input dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 26a48c85e2d..24d1258851b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: `DAGCircuit` :param dag: input dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.md index 4e218a53eb0..7d9ed484de4 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 4698fd82b34..ebad648872f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 62f9cf785c5..95b542004e7 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.md index fdb3e5c01e1..2700abb1199 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.md index e94ef5e85c7..31ca29f6cab 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 128e2a28f48..e6efc773084 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 02e96419fc2..0e15fcc43b2 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.md index 7330c1f857a..531b41e559c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 0c88b5481c4..1c13800bf74 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.md index 18ce08448a8..058caff9e5d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 5716bccf7ab..2158551e79a 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -67,7 +67,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") **Parameters** @@ -113,7 +113,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 3a6ede86791..7d82a0230dc 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder` @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.md index 5554cfa6ae8..e95ce0d4690 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index b83c8752df7..92970067a0f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.md index a0fc03592b6..93cbbeab423 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.md index 733ef8a224e..dcbbbed684b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.md index 4c90aaa04ca..81d4ce640ab 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.md index 1640da95a35..9ba101454ec 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.md index b8b9b7f9cf7..d58045cc19b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.md index 4952966c44b..de03a4b3540 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.md index 41450465317..b74b23ef0df 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.md index 464e249438a..a34e2a372b5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.md index 3d4907b77a3..3a7b7e241d5 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.md index 29d7dad5414..cbbbd3558b3 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.md index a72ef2e9acd..cbf39fbc01b 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.md index bc9eaba714c..369c4a9cb74 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.md index 134bdd21427..bef218496b8 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 14404b1eb1e..7fff3a5b37d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.md index 3ef97601681..e82fa917c6f 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.md index 6fc15eb9c95..fde883f98d4 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.md index da01f56783e..2f2d99ba352 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.md index 4fd55a9b2d2..b22bbbf6ead 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 021db1f1f4e..5b11fd143be 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index fb972de2417..431e9572979 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 74f5558bd59..175ef4e0dda 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index 00841d05770..441c2da8f35 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index ccc9820880a..54eeb71b857 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 169339ef01b..a9e21800cce 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index beb2e5129b9..0ac038c2e46 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.md index 4de5db61789..ab689348848 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 47d942bed95..9c5c40bef2d 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index fab24a87872..911733981ab 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`, `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 72a4bc1dc1a..5949c561bda 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 12556606650..9460784219c 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit` @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 9438fab61d5..88b032331e9 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`, `abc.ABC` diff --git a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 12b3a2f0b89..dff32b1d0bc 100644 --- a/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.35/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective` @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.md index 211feb94b05..81a6ab8d26f 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.35/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.35/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.35/qiskit.utils.apply_prefix.md index 77530e0e067..d65bab50be1 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.35/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.35/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.35/qiskit.utils.deprecate_arguments.md index 41ecce7f7a5..51b8668854e 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.35/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.35/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.35/qiskit.utils.deprecate_function.md index ed1afa5272a..a66303bb98d 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.35/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.35/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.35/qiskit.utils.detach_prefix.md index 2ac440f6afb..9792d18f8c6 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.35/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.35/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.35/qiskit.utils.get_entangler_map.md index 991d8200c5b..a61e3779aa4 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.35/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.35/qiskit.utils.has_aer.md b/docs/api/qiskit/0.35/qiskit.utils.has_aer.md index fedc8c0f522..ef03b3dcfba 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.35/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.35/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.35/qiskit.utils.has_ibmq.md index ae9eeeff789..72753605a9f 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.35/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.35/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.35/qiskit.utils.is_main_process.md index bad9d67a506..4d6a66b2bef 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.35/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.35/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.35/qiskit.utils.local_hardware_info.md index 2e98fd9500c..1da150a8fad 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.35/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.md index af066c9d2df..31fce106478 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.35/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.md index 14368752d0b..a0a41afc656 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.35/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.35/qiskit.utils.name_args.md b/docs/api/qiskit/0.35/qiskit.utils.name_args.md index cf94b53dc53..54477b8bdbc 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.35/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.35/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.35/qiskit.utils.summarize_circuits.md index 9ec49487698..18652050f47 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.35/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.35/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.35/qiskit.utils.validate_entangler_map.md index eb47327be74..0e37a9306af 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.35/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.35/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.35/qiskit.utils.wrap_method.md index fe155fc0aee..1df9c6ec55e 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.35/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.md index 868a580c9e7..4abab6a4691 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.35/qiskit.visualization.array_to_latex.md index d7b6a15931c..0639e2a9628 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.35/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.35/qiskit.visualization.circuit_drawer.md index c18d4bdae2e..94b41cf638c 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.35/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.35/qiskit.visualization.dag_drawer.md index 46a5c8077d3..d7bfc9b3824 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.35/qiskit.visualization.pass_manager_drawer.md index 1a8e611b17b..dbdbc0cef3d 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_multivector.md index 82c3e5b676a..9fe7ea9aa18 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_vector.md index fae5a457aff..c88479dc894 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_circuit_layout.md index e967b9c4f46..4814e127d61 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_coupling_map.md index 9788e0426fb..b902a34c944 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_error_map.md index 330599b0f79..a96e4e074d0 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_gate_map.md index 516f3bbf368..b28e6626737 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_histogram.md index 413760f80d1..655049cd9b7 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_city.md index f6ec0ce9972..749181658fe 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_hinton.md index 077001d4f36..44798464d60 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_paulivec.md index 00788675ba9..2a9b1881e68 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_qsphere.md index 50205f75664..81716c67ba9 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.md index ae20acd7698..d867c6d6b10 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.md index c2e42c8791f..b4abd0409d5 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.md index bf18173abd4..5b8c1afb6ae 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.draw.md index 54fbe3752d6..684f834e32f 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.md index 5acbcf56777..7203a608999 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.35/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.35/qiskit.visualization.timeline.draw.md index a8e26d81712..f99bcc7b4f5 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.35/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.35/qiskit.visualization.visualize_transition.md index c91ccce2c44..da895a98770 100644 --- a/docs/api/qiskit/0.35/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.35/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.35/synthesis_aqc.md b/docs/api/qiskit/0.35/synthesis_aqc.md index 470631311c2..b5f1163d1e5 100644 --- a/docs/api/qiskit/0.35/synthesis_aqc.md +++ b/docs/api/qiskit/0.35/synthesis_aqc.md @@ -127,7 +127,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.35/utils.md b/docs/api/qiskit/0.35/utils.md index eff3abbd73e..0b581e9027c 100644 --- a/docs/api/qiskit/0.35/utils.md +++ b/docs/api/qiskit/0.35/utils.md @@ -107,7 +107,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -228,7 +228,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -242,7 +242,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From 0fccc6db3aa84f1939e2778c7d8c2eab0933d4f3 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:39:59 +0100 Subject: [PATCH 16/41] Regenerate qiskit 0.36.0 --- docs/api/qiskit/0.36/execute.md | 2 +- docs/api/qiskit/0.36/logging.md | 2 +- docs/api/qiskit/0.36/pulse.md | 8 +- .../0.36/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.36/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.36/qiskit.algorithms.Grover.md | 8 +- .../0.36/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.36/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.36/qiskit.algorithms.QAOA.md | 2 +- .../api/qiskit/0.36/qiskit.algorithms.Shor.md | 8 +- .../0.36/qiskit.algorithms.ShorResult.md | 2 +- docs/api/qiskit/0.36/qiskit.algorithms.VQE.md | 14 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 8 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- .../0.36/qiskit.algorithms.optimizers.ADAM.md | 12 +- .../0.36/qiskit.algorithms.optimizers.AQGD.md | 8 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 8 +- .../0.36/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.36/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.36/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.36/qiskit.algorithms.optimizers.GSLS.md | 16 +- ...t.algorithms.optimizers.GradientDescent.md | 8 +- .../qiskit.algorithms.optimizers.IMFIL.md | 8 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.36/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 18 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 6 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 8 +- .../0.36/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 8 +- .../0.36/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit/0.36/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.36/qiskit.assembler.disassemble.md | 2 +- .../0.36/qiskit.circuit.AncillaQubit.md | 2 +- .../0.36/qiskit.circuit.AncillaRegister.md | 2 +- .../api/qiskit/0.36/qiskit.circuit.Barrier.md | 8 +- .../qiskit/0.36/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.36/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.36/qiskit.circuit.Clbit.md | 2 +- .../0.36/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.36/qiskit.circuit.ControlFlowOp.md | 2 +- .../0.36/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.36/qiskit.circuit.Delay.md | 12 +- .../0.36/qiskit.circuit.EquivalenceLibrary.md | 12 +- .../qiskit/0.36/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/0.36/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.36/qiskit.circuit.IfElseOp.md | 4 +- .../qiskit/0.36/qiskit.circuit.Instruction.md | 26 +- .../0.36/qiskit.circuit.InstructionSet.md | 8 +- .../api/qiskit/0.36/qiskit.circuit.Measure.md | 4 +- .../qiskit/0.36/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.36/qiskit.circuit.ParameterVector.md | 6 +- .../0.36/qiskit.circuit.QuantumCircuit.md | 224 +++++++++--------- .../0.36/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.36/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/0.36/qiskit.circuit.Reset.md | 4 +- .../qiskit/0.36/qiskit.circuit.WhileLoopOp.md | 4 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.AND.md | 2 +- .../0.36/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.36/qiskit.circuit.library.C3XGate.md | 6 +- .../0.36/qiskit.circuit.library.C4XGate.md | 6 +- .../0.36/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.36/qiskit.circuit.library.CHGate.md | 4 +- .../0.36/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.36/qiskit.circuit.library.CRXGate.md | 4 +- .../0.36/qiskit.circuit.library.CRYGate.md | 4 +- .../0.36/qiskit.circuit.library.CRZGate.md | 4 +- .../0.36/qiskit.circuit.library.CSXGate.md | 2 +- .../0.36/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.36/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.36/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.36/qiskit.circuit.library.CUGate.md | 4 +- .../0.36/qiskit.circuit.library.CXGate.md | 6 +- .../0.36/qiskit.circuit.library.CYGate.md | 4 +- .../0.36/qiskit.circuit.library.CZGate.md | 4 +- .../0.36/qiskit.circuit.library.DCXGate.md | 2 +- .../0.36/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.36/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.GRZ.md | 2 +- .../0.36/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.36/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.36/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.36/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.36/qiskit.circuit.library.MCMT.md | 6 +- .../0.36/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.36/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.36/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.36/qiskit.circuit.library.MSGate.md | 2 +- .../0.36/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.36/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.36/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.36/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.36/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.36/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.36/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.36/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.36/qiskit.circuit.library.RGate.md | 4 +- .../0.36/qiskit.circuit.library.RVGate.md | 6 +- .../0.36/qiskit.circuit.library.RXGate.md | 6 +- .../0.36/qiskit.circuit.library.RXXGate.md | 4 +- .../0.36/qiskit.circuit.library.RYGate.md | 6 +- .../0.36/qiskit.circuit.library.RYYGate.md | 4 +- .../0.36/qiskit.circuit.library.RZGate.md | 6 +- .../0.36/qiskit.circuit.library.RZXGate.md | 4 +- .../0.36/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.36/qiskit.circuit.library.SGate.md | 4 +- .../0.36/qiskit.circuit.library.SXGate.md | 6 +- .../0.36/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.36/qiskit.circuit.library.SdgGate.md | 4 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.36/qiskit.circuit.library.SwapGate.md | 6 +- .../0.36/qiskit.circuit.library.TGate.md | 4 +- .../0.36/qiskit.circuit.library.TdgGate.md | 4 +- .../0.36/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.36/qiskit.circuit.library.U1Gate.md | 6 +- .../0.36/qiskit.circuit.library.U2Gate.md | 4 +- .../0.36/qiskit.circuit.library.U3Gate.md | 6 +- .../0.36/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.36/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.36/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 4 +- .../qiskit.circuit.library.XXPlusYYGate.md | 4 +- .../0.36/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.36/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.36/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.36/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.36/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.36/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.36/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.36/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.36/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.36/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.36/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.36/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.36/qiskit.compiler.transpile.md | 2 +- .../0.36/qiskit.converters.ast_to_dag.md | 2 +- .../0.36/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.36/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.36/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.36/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.36/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.36/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.36/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.36/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.36/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.36/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.36/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.36/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.36/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.36/qiskit.extensions.Snapshot.md | 8 +- .../0.36/qiskit.extensions.UnitaryGate.md | 16 +- ...t.ignis.characterization.AmpCalCXFitter.md | 6 +- ...kit.ignis.characterization.AmpCalFitter.md | 8 +- ...ignis.characterization.AngleCalCXFitter.md | 6 +- ...t.ignis.characterization.AngleCalFitter.md | 6 +- ...is.characterization.BaseCoherenceFitter.md | 8 +- ...t.ignis.characterization.BaseGateFitter.md | 4 +- ...iskit.ignis.characterization.DragFitter.md | 8 +- ...iskit.ignis.characterization.RabiFitter.md | 10 +- .../qiskit.ignis.characterization.T1Fitter.md | 4 +- .../qiskit.ignis.characterization.T2Fitter.md | 4 +- ...kit.ignis.characterization.T2StarFitter.md | 6 +- .../qiskit.ignis.characterization.ZZFitter.md | 6 +- ...nis.characterization.ampcal_1Q_circuits.md | 2 +- ...nis.characterization.ampcal_cx_circuits.md | 2 +- ...s.characterization.anglecal_1Q_circuits.md | 2 +- ...s.characterization.anglecal_cx_circuits.md | 2 +- ...t.ignis.characterization.drag_schedules.md | 2 +- ...nis.characterization.get_single_q_pulse.md | 2 +- ...t.ignis.characterization.rabi_schedules.md | 2 +- ...skit.ignis.characterization.t1_circuits.md | 2 +- ...skit.ignis.characterization.t2_circuits.md | 2 +- ....ignis.characterization.t2star_circuits.md | 2 +- ...t.ignis.characterization.update_u_gates.md | 2 +- ...skit.ignis.characterization.zz_circuits.md | 2 +- .../qiskit.ignis.logging.IgnisLogReader.md | 6 +- .../0.36/qiskit.ignis.logging.IgnisLogger.md | 10 +- .../0.36/qiskit.ignis.logging.IgnisLogging.md | 10 +- ....ignis.measurement.DiscriminationFilter.md | 8 +- ...gnis.measurement.IQDiscriminationFitter.md | 16 +- ...ignis.measurement.LinearIQDiscriminator.md | 6 +- ...is.measurement.QuadraticIQDiscriminator.md | 6 +- ...gnis.measurement.SklearnIQDiscriminator.md | 6 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 14 +- ....mitigation.CompleteExpvalMeasMitigator.md | 8 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 10 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 4 +- ...skit.ignis.mitigation.MeasurementFilter.md | 4 +- ....mitigation.TensoredExpvalMeasMitigator.md | 10 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 8 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 8 +- ...skit.ignis.mitigation.complete_meas_cal.md | 2 +- ...skit.ignis.mitigation.expectation_value.md | 2 +- ...tigation.expval_meas_mitigator_circuits.md | 2 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 2 +- ...gnis.verification.AccreditationCircuits.md | 6 +- ....ignis.verification.AccreditationFitter.md | 16 +- .../0.36/qiskit.ignis.verification.BConfig.md | 18 +- ...ignis.verification.CNOTDihedralRBFitter.md | 14 +- ...is.verification.GatesetTomographyFitter.md | 6 +- .../qiskit.ignis.verification.GraphDecoder.md | 12 +- ....ignis.verification.InterleavedRBFitter.md | 14 +- .../0.36/qiskit.ignis.verification.Plotter.md | 8 +- ...is.verification.ProcessTomographyFitter.md | 4 +- ...iskit.ignis.verification.PurityRBFitter.md | 18 +- .../0.36/qiskit.ignis.verification.QOTP.md | 2 +- ...it.ignis.verification.QOTPCorrectCounts.md | 2 +- ...it.ignis.verification.QOTPCorrectString.md | 2 +- .../qiskit.ignis.verification.QVFitter.md | 24 +- .../qiskit.ignis.verification.RBFitter.md | 14 +- ...iskit.ignis.verification.RepetitionCode.md | 12 +- ...gnis.verification.StateTomographyFitter.md | 4 +- ...kit.ignis.verification.TomographyFitter.md | 10 +- ...kit.ignis.verification.calculate_1q_epc.md | 2 +- ...kit.ignis.verification.calculate_1q_epg.md | 2 +- ...kit.ignis.verification.calculate_2q_epc.md | 2 +- ...kit.ignis.verification.calculate_2q_epg.md | 2 +- ...skit.ignis.verification.coherence_limit.md | 2 +- ...iskit.ignis.verification.combine_counts.md | 2 +- ...it.ignis.verification.composite_pauli_z.md | 2 +- ...verification.composite_pauli_z_expvalue.md | 2 +- .../qiskit.ignis.verification.count_gates.md | 2 +- .../qiskit.ignis.verification.count_keys.md | 2 +- ...t.ignis.verification.expectation_counts.md | 2 +- ...t.ignis.verification.gates_per_clifford.md | 2 +- ...erification.gateset_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 2 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 2 +- .../qiskit.ignis.verification.get_ghz_po.md | 2 +- ...skit.ignis.verification.get_ghz_po_para.md | 2 +- ...iskit.ignis.verification.get_ghz_simple.md | 2 +- ...ignis.verification.lookuptable_decoding.md | 2 +- ...skit.ignis.verification.marginal_counts.md | 2 +- ...nis.verification.ordered_list_generator.md | 2 +- ...nis.verification.postselection_decoding.md | 2 +- ...erification.process_tomography_circuits.md | 2 +- .../qiskit.ignis.verification.qv_circuits.md | 2 +- ...erification.randomized_benchmarking_seq.md | 2 +- ...skit.ignis.verification.rho_to_fidelity.md | 2 +- ....verification.state_tomography_circuits.md | 2 +- ....ignis.verification.twoQ_clifford_error.md | 2 +- .../qiskit/0.36/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.36/qiskit.opflow.OpflowError.md | 2 +- .../0.36/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.36/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.36/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.36/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.36/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.36/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.36/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.36/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.36/qiskit.opflow.gradients.QFI.md | 4 +- .../0.36/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.36/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.36/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.36/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.36/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.36/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../0.36/qiskit.primitives.BaseEstimator.md | 4 +- .../0.36/qiskit.primitives.BaseSampler.md | 4 +- .../0.36/qiskit.primitives.Estimator.md | 4 +- .../0.36/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.36/qiskit.primitives.Sampler.md | 4 +- .../0.36/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.36/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.36/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.36/qiskit.providers.BackendV2.md | 16 +- .../0.36/qiskit.providers.BaseBackend.md | 16 +- .../qiskit/0.36/qiskit.providers.BaseJob.md | 24 +- .../0.36/qiskit.providers.BaseProvider.md | 6 +- docs/api/qiskit/0.36/qiskit.providers.Job.md | 2 +- .../qiskit/0.36/qiskit.providers.JobError.md | 2 +- .../qiskit/0.36/qiskit.providers.JobStatus.md | 2 +- .../0.36/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.36/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.36/qiskit.providers.Options.md | 8 +- .../qiskit/0.36/qiskit.providers.Provider.md | 2 +- .../0.36/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.36/qiskit.providers.QubitProperties.md | 2 +- .../0.36/qiskit.providers.aer.AerError.md | 2 +- .../0.36/qiskit.providers.aer.AerProvider.md | 6 +- .../0.36/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.36/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...skit.providers.aer.library.SaveClifford.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...kit.providers.aer.library.save_clifford.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_superop.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- ...skit.providers.aer.noise.LocalNoisePass.md | 4 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 24 +- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...providers.aer.noise.RelaxationNoisePass.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...oviders.aer.utils.transform_noise_model.md | 2 +- ...oviders.aer.utils.transpile_noise_model.md | 2 +- ...iders.aer.utils.transpile_quantum_error.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.36/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.36/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.36/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.36/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.36/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.36/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.36/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.36/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.36/qiskit.pulse.ScheduleBlock.md | 22 +- .../0.36/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.36/qiskit.pulse.builder.align_func.md | 2 +- .../0.36/qiskit.pulse.builder.align_left.md | 2 +- .../0.36/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.36/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.delay.md | 2 +- .../0.36/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.36/qiskit.pulse.builder.inline.md | 2 +- .../0.36/qiskit.pulse.builder.measure.md | 2 +- .../0.36/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.36/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.pad.md | 2 +- .../0.36/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.36/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.36/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.36/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.36/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.36/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.36/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.36/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.36/qiskit.pulse.instructions.Call.md | 6 +- .../0.36/qiskit.pulse.instructions.Delay.md | 4 +- .../0.36/qiskit.pulse.instructions.Play.md | 4 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.36/qiskit.pulse.library.Constant.md | 6 +- .../qiskit/0.36/qiskit.pulse.library.Drag.md | 6 +- .../0.36/qiskit.pulse.library.Gaussian.md | 6 +- .../qiskit.pulse.library.GaussianSquare.md | 6 +- .../0.36/qiskit.pulse.library.Waveform.md | 4 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.36/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.36/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.36/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.36/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.36/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.36/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.36/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.36/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.36/qiskit.qasm.QasmTerminalStyle.md | 2 +- docs/api/qiskit/0.36/qiskit.qasm3.Exporter.md | 6 +- docs/api/qiskit/0.36/qiskit.qasm3.dump.md | 2 +- docs/api/qiskit/0.36/qiskit.qasm3.dumps.md | 2 +- .../0.36/qiskit.qobj.GateCalibration.md | 6 +- .../0.36/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.md | 6 +- .../0.36/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.36/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.36/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.36/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.36/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.36/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.36/qiskit.qobj.Qobj.md | 2 +- .../0.36/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.36/qiskit.qobj.QobjHeader.md | 2 +- .../0.36/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.36/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.36/qiskit.qpy.load.md | 2 +- .../0.36/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.36/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.36/qiskit.quantum_info.Choi.md | 12 +- .../0.36/qiskit.quantum_info.Clifford.md | 32 +-- .../0.36/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.36/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.36/qiskit.quantum_info.Operator.md | 28 +-- .../qiskit/0.36/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.36/qiskit.quantum_info.Pauli.md | 60 ++--- .../0.36/qiskit.quantum_info.PauliList.md | 52 ++-- .../0.36/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.36/qiskit.quantum_info.Quaternion.md | 14 +- .../0.36/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.36/qiskit.quantum_info.SparsePauliOp.md | 40 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.36/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.36/qiskit.quantum_info.Stinespring.md | 14 +- .../0.36/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.36/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.36/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.36/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.36/qiskit.quantum_info.entropy.md | 2 +- .../0.36/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.36/qiskit.quantum_info.partial_trace.md | 2 +- .../0.36/qiskit.quantum_info.pauli_basis.md | 2 +- .../0.36/qiskit.quantum_info.pauli_group.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.36/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.36/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.36/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.36/qiskit.result.ProbDistribution.md | 6 +- .../0.36/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.36/qiskit.result.Result.md | 16 +- .../qiskit/0.36/qiskit.result.ResultError.md | 2 +- .../0.36/qiskit.result.marginal_counts.md | 2 +- .../0.36/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.36/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.36/qiskit.synthesis.ProductFormula.md | 2 +- .../0.36/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../0.36/qiskit.tools.backend_monitor.md | 2 +- .../0.36/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.36/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.36/qiskit.tools.parallel_map.md | 2 +- .../0.36/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.36/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.36/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.36/qiskit.transpiler.Layout.md | 30 +-- .../0.36/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.36/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit/0.36/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.36/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.36/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...ranspiler.passes.CollectLinearFunctions.md | 4 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- .../0.36/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.36/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 4 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- .../0.36/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.36/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.36/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.36/qiskit.transpiler.passes.Width.md | 4 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- .../0.36/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.36/qiskit.utils.apply_prefix.md | 2 +- .../0.36/qiskit.utils.deprecate_arguments.md | 2 +- .../0.36/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.36/qiskit.utils.detach_prefix.md | 2 +- .../0.36/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.36/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.36/qiskit.utils.has_ibmq.md | 2 +- .../0.36/qiskit.utils.is_main_process.md | 2 +- .../0.36/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 6 +- .../api/qiskit/0.36/qiskit.utils.name_args.md | 2 +- .../0.36/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.36/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.36/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.36/synthesis_aqc.md | 2 +- docs/api/qiskit/0.36/utils.md | 6 +- 975 files changed, 2863 insertions(+), 2863 deletions(-) diff --git a/docs/api/qiskit/0.36/execute.md b/docs/api/qiskit/0.36/execute.md index 73117459428..74a97a08f1c 100644 --- a/docs/api/qiskit/0.36/execute.md +++ b/docs/api/qiskit/0.36/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.36/logging.md b/docs/api/qiskit/0.36/logging.md index 8dc3b98896c..e6256887f99 100644 --- a/docs/api/qiskit/0.36/logging.md +++ b/docs/api/qiskit/0.36/logging.md @@ -22,7 +22,7 @@ python_api_name: qiskit.ignis.logging | [`IgnisLogging`](qiskit.ignis.logging.IgnisLogging "qiskit.ignis.logging.IgnisLogging")(\[log\_config\_path]) | Singleton class to configure file logging via IgnisLogger | | [`IgnisLogReader`](qiskit.ignis.logging.IgnisLogReader "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") A logger class for Ignis diff --git a/docs/api/qiskit/0.36/pulse.md b/docs/api/qiskit/0.36/pulse.md index 6cff3f333f0..96a0b7a2de3 100644 --- a/docs/api/qiskit/0.36/pulse.md +++ b/docs/api/qiskit/0.36/pulse.md @@ -66,7 +66,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -141,7 +141,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -192,7 +192,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -634,7 +634,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.md index 5aa00b3fd7f..731ff50ce09 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.md index 4b245a063cd..84104e244d1 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.md index bc7e4128bb5..e16b6cd2c19 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.md index edf3b326474..cac07cc62d4 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.md index 86b95964f3c..71e929c7e9c 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.md index 7e33de156fc..abb53c279a3 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.md index 9ec83633a4e..ac7927c8c11 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.md index 5d51fbe5bce..8c824e3a29c 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.md index 769b3c730a8..ef6415cf733 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.md index c140a6a50cf..820662cf059 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.md index 134e8638efa..1aac747e4e8 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.md index b46bbbf41fe..1b6f71b2da8 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.36/qiskit.algorithms.Grover.md index 625e7d29fa3..ac912684a8d 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier` @@ -89,7 +89,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -114,7 +114,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -140,7 +140,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.md index 3b3812d2e17..786ab89506b 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.md index 0bdfb5d28f4..d324b6bc3ff 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 46c046e6813..90916b20ac3 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.md index 8d8f0145d20..04299e5d417 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 771ca018cf3..587eb011c9f 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.md index ee415d34488..1927f447990 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index e60240044a1..4bce00b4d12 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator` @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 94abd2666b7..a52679f2d23 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.md index a1ed88cca05..a7169e96a80 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.md index 00a241bfbea..b0c1e139d8e 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.md index 3b7153b1331..f87cae67c31 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: `qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver` @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.md index 39e6543d93c..d0051b90cf4 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.md index 285aaac04e2..1d6c9c7908a 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.md index 3ed287b63c7..019ee0f4e46 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.md index c1ede4b535c..d2a9cf46ebb 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.md index ebc8a90b82d..6ad1f7318bf 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.36/qiskit.algorithms.Shor.md index adb40f91c1d..cac1d4dead7 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.md index c15b285bd25..e9884d486f5 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.36/qiskit.algorithms.VQE.md index 09e12b64082..22c0f13c27e 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver` @@ -50,7 +50,7 @@ The above signature also allows to directly pass any SciPy minimizer, for instan -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -71,7 +71,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -92,7 +92,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -119,7 +119,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -146,7 +146,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -162,7 +162,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.36/qiskit.algorithms.eval_observables.md index 4e43207be55..a471cbd0847 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/aux_ops_evaluator.py "view source code") Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 59365a4079e..88d24370362 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -54,7 +54,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -74,7 +74,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -94,7 +94,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -114,7 +114,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.md index d970b1bbf4d..4c841d88969 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -62,7 +62,7 @@ approx_result = solution.observable -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -90,7 +90,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.md index 2f6d33ea2a8..cc55e63e03a 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.md index 1aea3df4c75..81c8626c904 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index 2a7cdfeaf1b..95db25ea8d5 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -488,7 +488,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1116,7 +1116,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2151,7 +2151,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index de0565ebf46..53c1d400f38 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 0635b4a6f32..0621127543f 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: `qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable` @@ -69,7 +69,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -89,7 +89,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -109,7 +109,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -129,7 +129,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index c2058bf5b79..2b56f7f9f32 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.md index 478a6c7fc68..4854b69c0ac 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` @@ -511,7 +511,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1139,7 +1139,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1660,7 +1660,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2174,7 +2174,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index e943ee8c443..d96edae2571 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: `qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix` @@ -524,7 +524,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1152,7 +1152,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1673,7 +1673,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2187,7 +2187,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.md index 44eac04155d..6315c797596 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -125,7 +125,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Perform optimization. @@ -163,7 +163,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.md index 3db2468aa91..be6360aa261 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. @@ -108,7 +108,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/aqgd.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.md index de0f482c22c..f157ff0f670 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. @@ -88,7 +88,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/bobyqa.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.md index 00591e12938..b2db0e0f0c7 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.md index 03fcc1db7f9..736bcd18008 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.md index 4a2d2a9b64f..bd026810599 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.md index 1d9b6ccd59c..0246f311c82 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 7b2df7edde3..85db15e64dd 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.md index 3a9cfcfd3ab..bdd48c8f5ff 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.md index 05cd316d90e..973a0dd487d 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -157,7 +157,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Perform optimization. @@ -195,7 +195,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -219,7 +219,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.md index 2df4e72489c..515e5a258f1 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -47,7 +47,7 @@ An example where the learning rate is an iterator and we supply the analytic gra -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -78,7 +78,7 @@ grad -`GradientDescent.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Minimize the scalar function. @@ -101,7 +101,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.md index 7812f3e24fc..3edc32385f3 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. @@ -88,7 +88,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/imfil.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.md index bf5c8fd0d12..3e86e294fb6 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.md index 74448209582..8af1ef6f500 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.md index 429caf256a2..2134d440692 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.md index a4bf6569eec..9cc90cf271f 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.md index 0bedafb363b..c254c580dfd 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Perform optimization. @@ -104,7 +104,7 @@ point: is a 1D numpy.ndarray\[float] containing the solution value: is a float w -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -112,7 +112,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -120,7 +120,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -134,7 +134,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.md index cefc228ca8b..b75ee8391c2 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 628b3e516f9..ed6514afe25 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.md index d576b488bc4..c8764ceef42 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.md index 9295dc89682..7831570cf15 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -68,7 +68,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. @@ -91,7 +91,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.md index 0083135fd10..da4cf243b96 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: `qiskit.algorithms.optimizers.spsa.SPSA` @@ -125,7 +125,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.md index a28853e2dc8..43a9511d2d6 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.md index 206f5aa3c84..79194561568 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. @@ -91,7 +91,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/snobfit.py "view source code") Runs the optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.md index 9ca3df93fff..667311458d3 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -104,7 +104,7 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -140,7 +140,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -152,7 +152,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -183,7 +183,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -206,7 +206,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.md index 021bba76262..072c5833fd6 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. @@ -85,7 +85,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.md index 2a5aca217ab..589356cbb2d 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` diff --git a/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.md index 92263461817..7cd9214e828 100644 --- a/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.36/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.36/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.36/qiskit.assembler.assemble_circuits.md index 662a2b1a99f..c6e57cd0aa2 100644 --- a/docs/api/qiskit/0.36/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.36/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.36/qiskit.assembler.assemble_schedules.md index fd361ce969b..32065c25e91 100644 --- a/docs/api/qiskit/0.36/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.36/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.36/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.36/qiskit.assembler.disassemble.md index ffc93d96c1f..da32755af53 100644 --- a/docs/api/qiskit/0.36/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.36/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.md index ee9555067a0..46acc3daa0e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.Qubit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.md index 954020bfece..bcabdc75f79 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.quantumregister.QuantumRegister` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Barrier.md b/docs/api/qiskit/0.36/qiskit.circuit.Barrier.md index b38bbaeec2b..8d6e4383fc7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Barrier.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.md index 7b223a0e1ab..4d8bf5fcaf9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.md index fcdf55ea7e1..bffdc3b607c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.36/qiskit.circuit.Clbit.md index e1e765e854b..803fa5ed2f7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.md index 300feca79b0..159994a70c2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.md index c280f216030..0d2f7ecd33b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: `qiskit.circuit.instruction.Instruction`, `abc.ABC` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.md index 09b6c3fdaa4..dd8dbaba6ad 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -224,7 +224,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Delay.md b/docs/api/qiskit/0.36/qiskit.circuit.Delay.md index 779072e9210..8b27a1603d8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.md index e9c215000dc..38d28518ffc 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.md index 791fbc37451..aa8bd56325b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Gate.md b/docs/api/qiskit/0.36/qiskit.circuit.Gate.md index 1b5e8881748..b010a65c98d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.md index 400479155cf..609eabdaab3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` @@ -100,7 +100,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.36/qiskit.circuit.Instruction.md index df47b0013f1..9e90a2ec7c5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -46,7 +46,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -54,7 +54,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -75,7 +75,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -87,7 +87,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -109,7 +109,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -133,7 +133,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -141,7 +141,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -151,7 +151,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -175,7 +175,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -195,7 +195,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -215,7 +215,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.md index 9456fe42347..bf0d00e9c19 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(gate, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(gate, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -85,7 +85,7 @@ This same instance of [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.c -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Measure.md b/docs/api/qiskit/0.36/qiskit.circuit.Measure.md index e1aba951f5c..83dd030a876 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.36/qiskit.circuit.Parameter.md index a2e31e2b989..0afa792cc41 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -206,7 +206,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.md index f407603fe2a..0adbab5ec90 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -218,7 +218,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.md index 637c8b3f693..7d0f14bac0e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.md index 91e72be13bf..9c3e2834930 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -139,7 +139,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -162,7 +162,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -174,7 +174,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. @@ -201,7 +201,7 @@ a handle to the instruction that was just added -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -301,7 +301,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Barrier`](qiskit.circuit.Barrier "qiskit.circuit.Barrier"). If qargs is empty, applies to all qubits in the circuit. @@ -317,7 +317,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -344,7 +344,7 @@ copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -368,7 +368,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -380,7 +380,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -400,7 +400,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -425,7 +425,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -450,7 +450,7 @@ A handle to the instructions created. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -462,7 +462,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -474,7 +474,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -503,7 +503,7 @@ A handle to the instructions created. -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -531,7 +531,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -586,7 +586,7 @@ lhs.compose(rhs, qubits=[3, 2], inplace=True) -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -610,7 +610,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -636,7 +636,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -656,7 +656,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -672,7 +672,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -698,7 +698,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -724,7 +724,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -750,7 +750,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -776,7 +776,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -802,7 +802,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -827,7 +827,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -856,7 +856,7 @@ A handle to the instructions created. -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -882,7 +882,7 @@ A handle to the instructions created. -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -910,7 +910,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -935,7 +935,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -960,7 +960,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -985,7 +985,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1008,7 +1008,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1028,7 +1028,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1054,7 +1054,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1105,7 +1105,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1179,7 +1179,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1202,7 +1202,7 @@ A handle to the instructions created. -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -1230,7 +1230,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1261,7 +1261,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1316,7 +1316,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1344,7 +1344,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1364,7 +1364,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1384,7 +1384,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1404,7 +1404,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1434,7 +1434,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1454,7 +1454,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1476,7 +1476,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1502,7 +1502,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1548,7 +1548,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1715,7 +1715,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1817,7 +1817,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1840,7 +1840,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1926,7 +1926,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1967,7 +1967,7 @@ A handle to the instructions created. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -1991,7 +1991,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2028,7 +2028,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2053,7 +2053,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2075,7 +2075,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2104,7 +2104,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply `MSGate`. @@ -2127,7 +2127,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2147,7 +2147,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2161,7 +2161,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2177,7 +2177,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2189,7 +2189,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2212,7 +2212,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2233,7 +2233,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2372,7 +2372,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2399,7 +2399,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2419,7 +2419,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2439,7 +2439,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2466,7 +2466,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2493,7 +2493,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2517,7 +2517,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2542,7 +2542,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2566,7 +2566,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2588,7 +2588,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2608,7 +2608,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2628,7 +2628,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2670,7 +2670,7 @@ q_1: ┤ H ├─────■────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2710,7 +2710,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2737,7 +2737,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2761,7 +2761,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2785,7 +2785,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2809,7 +2809,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2833,7 +2833,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2856,7 +2856,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2880,7 +2880,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2904,7 +2904,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3316,7 +3316,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3484,7 +3484,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3708,7 +3708,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3731,7 +3731,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3753,7 +3753,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3775,7 +3775,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3797,7 +3797,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3819,7 +3819,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3872,7 +3872,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3893,7 +3893,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3914,7 +3914,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3942,7 +3942,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3967,7 +3967,7 @@ A handle to the instructions created. -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -3990,7 +3990,7 @@ A handle to the instructions created. -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -4014,7 +4014,7 @@ A handle to the instructions created. -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -4160,7 +4160,7 @@ Apply unitary gate to q. -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -4205,7 +4205,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -4221,7 +4221,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4244,7 +4244,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4266,7 +4266,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.md index 76faba86ff8..30dff914eb0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.36/qiskit.circuit.Qubit.md index 7e45f239de5..b4d27b939c2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.Reset.md b/docs/api/qiskit/0.36/qiskit.circuit.Reset.md index cb61a1000e1..74880ecad35 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.md index 5c95bbfd679..2502a278980 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: `qiskit.circuit.controlflow.control_flow.ControlFlowOp` @@ -97,7 +97,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.md index 6f6182a4e59..af3803bee63 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.md index a0bfcf8e486..3585dba6201 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index d932c7552b3..049e8ee3d88 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 0875249c124..e4f0b9261c0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.36/qiskit.circuit.library.AND.md index 9380db59d4e..19593951195 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.md index d10f5b2e295..ef2b72c8939 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.md index 92763a4064d..d8ff3f54815 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.md index ac389fa28ac..5ffd031bec7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.md index 2e4b827a87f..98c42907fb8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -80,7 +80,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -102,7 +102,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.md index 138c096fa2d..c7ff3fccdd1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.md index f9426a6dab5..ffde750bc98 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -70,7 +70,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.md index 5bcc86bd430..226d324f62d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.md index 73d04ddce83..3ce67b449d7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.md index dc80ad5dd04..9953b48db46 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.md index 7122a244eae..ef12b9ff3bd 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.md index 54b4737d469..64a85382c18 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.md index 810682d92ef..a228fc9d9dc 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -87,7 +87,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.md index 66a4f579b3a..98bfc91da4d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.md index 58cbf2a0f6b..e02356fc0b9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.md index 7fb1960fbbe..7cf95d906a7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -72,7 +72,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.md index 9fe8d13f4d6..2f1a2447001 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -74,7 +74,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -96,7 +96,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.md index b2b2861b62c..52d28e60672 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -68,7 +68,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.md index 2294b8de312..f16fcea3565 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -49,7 +49,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.md index 4aa31364b67..54e1d98fad9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.md index 100a5d63c31..f98ac67c3a2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.md index e24a495ec01..fb5c22dd6f7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.md index 6c0948ac1f1..7f860b8ac5c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.md index 4dfd85789dc..60ca8a522cf 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 105d10c117d..035af95b0c9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.md index 89c4b43332d..932c895935f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.md index fc8645ea901..05d99512812 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.md index 51c319db270..db4ae7535a0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/fourier_checking.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.md index a7b669c076e..5cc175b3db5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.md index 6bb464d2c1a..f627ad7a21a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GR.md index d33b3be0538..26895a016e4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.md index 00f895033bd..5e8f2b3327c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.md index ac1ff2b3c74..ec1beecd0c3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.gr.GR` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.md index 3522ef9db85..45efc52ed01 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.md index 0dc9a3b4e82..0dba4e5c8b4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/graph_state.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.md index afdfb6844b5..5facab71017 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.md index 9282112d503..e6fc8abc86a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -44,7 +44,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -68,7 +68,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.md index aee57c3d57e..e715dd574d8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.md index 62fdfdf514f..278b004b476 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.md index 616a2c714fd..3df6befc282 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.md index 93a82acbe66..f5207b53bc9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/iqp.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.md index 972cd5f988c..181a7012723 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.md index c5a22dbd9fe..422a207468b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.md index d4100fe1e0a..d4dbd866f49 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.md index 97fe92917df..ac2280a118f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.md index 5e8e7997780..6a2293e02a1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.md index 4637c02155b..5d89c60c5e8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.md index bec8a6f77a8..17a3ce038f7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: `qiskit.circuit.library.generalized_gates.mcmt.MCMT` @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.md index f3f429efc46..3955bb002e8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -43,7 +43,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -65,7 +65,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.md index 52484758be2..35646f6fc7f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -46,7 +46,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -60,7 +60,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.md index 0fbabd7c2b9..caf09f70354 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.md index b152469912d..48d969bb03c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.md index 54fe2e098c4..a07cac1de51 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.library.standard_gates.x.MCXGate` @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.md index ef8e1c26ef8..376cef5e857 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.md index 7ad15c39ac7..8324af51a47 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.36/qiskit.circuit.library.OR.md index 3914d47f7c2..ee04dd94453 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.md index 049612a8d0d..7684f94aa2c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.md index 60222f6f49f..5d6e76d46da 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.md index 19d826d05a2..f5bd226ef72 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -35,7 +35,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -43,7 +43,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.md index 11fba8f0eeb..ef6342cf07c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.md index 0cfc8128989..0d39332701b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.md index d86acb47f31..2c7bf1280e4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.md index 6b25e4aff7d..e89553ffce4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -90,7 +90,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.md index 6e773c8dfbc..659ab01290a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.md index 10de5544c81..34558b58e6b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index a7cd558fb7a..7a6c69b5d9b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index f4115298819..4acca5f7943 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.md index 6b228788a6a..97b23c62992 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.md index 5fd538ca0ec..0eaa41639ec 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.md index 7da037563fb..3257eedaa8e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.md index 10bbf802e14..e7aa12e1036 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.md index 95e6062f4ff..02b6b7d954e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.md index f7a74f2d50e..9680708057d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.md index edd07feea8a..f039abdec9c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.md index ac076c87dd9..e83fe6de919 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.md index f3d8539bd66..bedfdd71384 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.md index 8c85b514838..f8f1df08ce8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -51,7 +51,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -59,7 +59,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.md index 4208bd57f8f..3b1d336dae0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.md index 51e18d6dd21..03b7d7b23a2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.md index 3e80f505c74..d8fee8b1a92 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -64,7 +64,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.md index 9a835a644f3..398315fa435 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -68,7 +68,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.md index 50343d33a29..999a0da2a68 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -54,7 +54,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.md index 44d5aa65583..7d5e94d0a39 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -106,7 +106,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.md index ee8ae0bf5a0..6c57e7bc5b7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -80,7 +80,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.md index 9dfc536f4f5..03fc76eee53 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.md index 4e876cee6b4..73277975106 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.md index 01022d58465..ee420060cf4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -53,7 +53,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.md index 47a0c5d56bc..96550614667 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -43,7 +43,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.md index afcd4877ea9..f67024403ac 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.md index 10f2e9b6ad4..6e154275d68 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.md index 7f90dfb380d..d9828d764d6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -52,7 +52,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -76,7 +76,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.md index 92234d903cc..8e2328c4c5f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.md index f4b0f48ce66..84db056ce73 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -47,7 +47,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.md index 077b47a1102..ee07b5d6fe9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.md index 0e4e03ef0a4..f82ea096c06 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.md index b995e5a8be3..18da5e4cc99 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.md index 137bce1c25c..a2832722e07 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -59,7 +59,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -81,7 +81,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.md index 8ecbd836d12..c86ee1937f3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -66,7 +66,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.md index bd27bb50948..780eda81939 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.md index 09080817fd2..6539077603b 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.md index c210977aab9..1e60daec56c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.md index 7beb9acd278..176a722a057 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.md index 95a29912d7d..6fb57575cab 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.md index 5fbdbc15507..64a42f89910 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.md index b7e670f16db..465fb673ad3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.md index 639ae39e61c..9622bac0fc2 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.md index ee75c57ee96..89206e97eda 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -62,7 +62,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -86,7 +86,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.md index 8ed5928736e..bc2cb1bae38 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_1.md index bcc82a63945..59c35275ce9 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_2.md index f1f4f5fbfa4..19d2085c0ca 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_3.md index 6eee6991972..cb6026daa30 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_4.md index 6d33d58ab64..b5810059613 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_3_1.md index fb0708216da..0c7fa2f0427 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_1.md index 277456a146d..2aa7f4894a0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_2.md index e4f49e1cd09..601ea4d8dec 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_3.md index dad866829e9..24f28a2fce3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_4.md index 0b7369cb5d3..d4f94149bb4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_5_1.md index ea700db72b3..511ec3f4e42 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_1.md index 72d2456f07d..0d2d5955be1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_2.md index bbb3efc9005..8ee01874364 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_3.md index 9544dfb72be..08a1e405106 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_4.md index e090e774dfc..9c4d96e37d0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_5.md index a284b26388f..c41ed6024ec 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_1.md index 06043da3409..04797a2b7ed 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_2.md index 01fa253c1eb..35cc8665f87 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_3.md index f5c964f2b8a..26816cfe94c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.md index 28e132629fb..d7b2dd591b3 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: `qiskit.circuit.gate.Gate` diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_cy.md index f2ab84e233b..b90ba9284b8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_xz.md index 058f0ebd101..530cdf14348 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_yz.md index 321ed7f3cd0..31254221116 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz1.md index 6cad7107a32..bd4f3d1e56a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz2.md index 2627333299f..aab2307ac85 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz3.md index 909bce1250a..14ddf39dabd 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index a3f65e5d5aa..b36319ceffc 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 9a70608e99c..13a301a385a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index e48d626d193..081b9013956 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index c439b1304f6..8a9f6715110 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 3b487c1836b..29ca3d3e58a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 5b8b59faf09..9be9987a63c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 438547a49dc..f2e511cb494 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 22ea27a8f45..6f27f3105c1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index a0c9ca908b1..0c2c3e92968 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 88a2c8ddaa3..0e4fafb6a0e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index c904b9bf622..c68407ffa08 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index dfc8e1bd8cd..b7799c9d9a6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 7d1dffd36ab..25a398bad3a 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 47675114d64..b72d4acec69 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index e4fde4a2c58..e6ec62ea040 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 8c97adfe0ad..8225e160de6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 3d61fd6ff5b..e4b6cc8af7c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index 12b04889a4c..17e1c9364fa 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index a6b29cea2dc..3f217d9b58c 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 99a21406ebe..4ad6655d0ef 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 832911d619b..f6b94d6d1d4 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index c26cabd9acf..1b6e0341317 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 5b60d4e8ae9..b505c5683cf 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index f4f9a429d73..6aaf7f948e8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 5bfe20770e3..c1728d9633f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index c63e734ad30..416485425b7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 3b83acf7d38..5064779010d 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 62334ef1429..2d28f5be1a8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 8d2bb9a22d6..86371dff0db 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 52b2f7ef64f..f2401c73fd8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 317900d6909..da30c3d7d1f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 819b6c141f9..5716fd111b8 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 2b686ec0cfa..98a74263a9f 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 665a2bf1871..8a8e69d4ae1 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 2065bbc7a8e..d5cb4d2a537 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index e1789169c9d..20727f68f59 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index c70339c3e31..e82a9d4550e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 27a335562dd..1ab51ba27e7 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 7b19f004a9f..3e0022bbf59 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index ad82ad86851..5c6dd562aa6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index f25906e4f98..547d95157f0 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index abd306d0225..30292420fcc 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 777de9cd5a8..5dd92103749 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 6ea8c0e6e13..5a59971c967 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index 53075d43ef9..e1a05dd150e 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 8c21d9890c8..c4df94dd3aa 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index c4fcdbc9b4b..7bdf7d92af5 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.36/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.36/qiskit.circuit.random.random_circuit.md index 6e60d53382b..bb9c86f74e6 100644 --- a/docs/api/qiskit/0.36/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.36/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.36/qiskit.compiler.assemble.md b/docs/api/qiskit/0.36/qiskit.compiler.assemble.md index 2d6333af84f..5cd6330d146 100644 --- a/docs/api/qiskit/0.36/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.36/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=, meas_return=, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.36/qiskit.compiler.schedule.md b/docs/api/qiskit/0.36/qiskit.compiler.schedule.md index 10d21eba0f9..67d337929bf 100644 --- a/docs/api/qiskit/0.36/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.36/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.36/qiskit.compiler.sequence.md b/docs/api/qiskit/0.36/qiskit.compiler.sequence.md index 8ec599f5219..d5840c72ea4 100644 --- a/docs/api/qiskit/0.36/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.36/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.36/qiskit.compiler.transpile.md b/docs/api/qiskit/0.36/qiskit.compiler.transpile.md index 1f8a56ef20c..3d4ba4d9010 100644 --- a/docs/api/qiskit/0.36/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.36/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.36/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.36/qiskit.converters.ast_to_dag.md index dd430ef724b..f0f8d950077 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.36/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dag.md index 75f80aa84d0..204b68ed346 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dagdependency.md index 421cc841eb6..1ada1399f79 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_gate.md index 84c31da1899..c3fbb70f669 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_instruction.md index a3bc93c89ed..513d502ebf1 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.36/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.36/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.36/qiskit.converters.dag_to_circuit.md index 9c42256fffc..ad00d160a42 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.36/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.36/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.36/qiskit.converters.dag_to_dagdependency.md index daa815af045..1e01418fa01 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.36/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_circuit.md index 4a9abfaec4b..babbac72185 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_dag.md index 546ec988c6f..7b5330ed340 100644 --- a/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.36/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.md index 3becfb9cbb1..ebab06cae23 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -238,7 +238,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -248,7 +248,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -260,7 +260,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -268,7 +268,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -292,7 +292,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -314,7 +314,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -341,7 +341,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -349,7 +349,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -365,7 +365,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -373,7 +373,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -393,7 +393,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -401,7 +401,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -409,7 +409,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -423,7 +423,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -431,7 +431,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -439,7 +439,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -447,7 +447,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -455,7 +455,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -475,7 +475,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -487,7 +487,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -508,7 +508,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -516,7 +516,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -524,7 +524,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -532,7 +532,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -553,7 +553,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -569,7 +569,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -577,7 +577,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -585,7 +585,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -593,7 +593,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -617,7 +617,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -630,7 +630,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -638,7 +638,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -646,7 +646,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -654,7 +654,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -664,7 +664,7 @@ Add edges from predecessors to successors. -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single. @@ -685,7 +685,7 @@ This is used to consolidate a block of DAGOpNodes into a single operation. A typ -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -701,7 +701,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -711,7 +711,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -719,7 +719,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -746,7 +746,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -772,7 +772,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -780,7 +780,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -788,7 +788,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -808,7 +808,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -830,7 +830,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -838,7 +838,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.md index a8b959a47cb..87eeb8548fe 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.md index 0f3b98266af..72e2f0cc67f 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=None, cargs=None, condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.md index c75b21f4dc2..b5f0b2f0f80 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.md index 8287b64f573..1f3f04d50b2 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.md index b910aac4083..8b1875c31b6 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.md index 53d3bcbcb83..0de38b8ada8 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.md index e4884205fe7..2c3ed36bb20 100644 --- a/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.36/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/dagcircuit/dagnode.py "view source code") Bases: `qiskit.dagcircuit.dagnode.DAGNode` diff --git a/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.md index 49abc338e9d..28671fcf742 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.36/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.36/qiskit.extensions.Initialize.md index be3463aaac7..b2412ce9b9b 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.36/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.md index 1b91c247d73..fa7dd8a1697 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.36/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.md index ef6ccfd9949..fd95e14759e 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.36/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.md index c9be376388c..799315d9b27 100644 --- a/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.36/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -41,7 +41,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -124,7 +124,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -132,7 +132,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -181,7 +181,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -313,7 +313,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -321,7 +321,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.md index b6a065421b3..f7bcabbf999 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.md index 445940b2453..cb4c05d6690 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AmpCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AmpCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AmpCalFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Guess fit parameters for the amp cal @@ -95,7 +95,7 @@ list -`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AmpCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.md index 72390a7400f..f1dd548a089 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalCXFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalCXFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.md index 8e34b105743..34bb022876f 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.AngleCalFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseGateFitter` @@ -38,7 +38,7 @@ Add new execution results to previous execution results -`AngleCalFitter.angle_err(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.angle_err(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Return the gate angle error @@ -75,7 +75,7 @@ Compute self.\_params and self.\_params\_err -`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") +`AngleCalFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.md index 6d992298e71..0fb7f2385e9 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter -`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0', time_index=0, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -68,7 +68,7 @@ Compute self.\_params and self.\_params\_err -`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.plot(qind, series, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Plot coherence data. @@ -95,7 +95,7 @@ Axes -`BaseCoherenceFitter.time(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Return the characteristic time for the given qubit and series @@ -116,7 +116,7 @@ The characteristic time of the qubit, or all qubits -`BaseCoherenceFitter.time_err(qid=- 1, series='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseCoherenceFitter.time_err(qid=- 1, series='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Return the error of characteristic time for the given qubit and series diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.md index 34fb34bbd65..f249e3e7a7c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.BaseGateFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseFitter` @@ -55,7 +55,7 @@ Compute self.\_params and self.\_params\_err -`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") +`BaseGateFitter.plot(qind, series='0', ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/fitters.py "view source code") Plot err data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.md index d6a0edbb6ec..973f43032e3 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.DragFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -40,7 +40,7 @@ Add new execution results to previous execution results -`DragFitter.drag_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.drag_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the drag amplitude from the fit @@ -77,7 +77,7 @@ Compute self.\_params and self.\_params\_err -`DragFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess parameters for the drag fit @@ -99,7 +99,7 @@ list -`DragFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`DragFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.md index 372f017addd..28a066d8ce8 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.RabiFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.IQFitter` @@ -57,7 +57,7 @@ Compute self.\_params and self.\_params\_err -`RabiFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Guess fit parameters for rabi oscillation data @@ -79,7 +79,7 @@ list -`RabiFitter.pi2_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi2_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi/2 amplitude from the fit @@ -99,7 +99,7 @@ float -`RabiFitter.pi_amplitude(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.pi_amplitude(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Return the pi amplitude from the fit @@ -119,7 +119,7 @@ float -`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") +`RabiFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/fitters.py "view source code") Plot the data and fit diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.md index c0278abfc7e..207580331a4 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T1Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T1Fitter -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T1Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.md index f6032306e0e..0d5de5146a4 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2Fitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2Fitter -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -73,7 +73,7 @@ Compute self.\_params and self.\_params\_err -`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2Fitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.md index ca32ce2a39a..391277c14a8 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.T2StarFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.T2StarFitter -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -72,7 +72,7 @@ Compute self.\_params and self.\_params\_err -`T2StarFitter.guess_params(qind=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.guess_params(qind=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Guess fit parameters for oscillation data @@ -92,7 +92,7 @@ Fit guessed parameters -`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") +`T2StarFitter.plot(qind, series='0', ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/fitters.py "view source code") Plot coherence data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.md index d5ef72ada1e..15ccd84be1c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ZZFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Bases: `qiskit.ignis.characterization.fitters.BaseCoherenceFitter` @@ -22,7 +22,7 @@ ZZ fitter -`ZZFitter.ZZ_rate(qind=- 1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.ZZ_rate(qind=- 1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Return the ZZ rate from the fit of the two curves @@ -100,7 +100,7 @@ Axes -`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") +`ZZFitter.plot_ZZ(qind, ax=None, show_plot=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/fitters.py "view source code") Plot ZZ data. Will plot both traces on the plot. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_1Q_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_1Q_circuits.md index 403817016d4..53d9fc2448d 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_1Q_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits -`ampcal_1Q_circuits(max_reps, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_1Q_circuits(max_reps, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the single qubit gates diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_cx_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_cx_circuits.md index 09dc059db30..23052c4321f 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_cx_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.ampcal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits -`ampcal_cx_circuits(max_reps, qubits, control_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`ampcal_cx_circuits(max_reps, qubits, control_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the amplitude error of the cx gate diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_1Q_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_1Q_circuits.md index bea081fef35..7457a6a8d7b 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_1Q_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_1Q_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the single qubit gate diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_cx_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_cx_circuits.md index fff2b94403d..26d2f78212f 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_cx_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.anglecal_cx_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") +`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/gates/circuits.py "view source code") Generates circuit for measuring the angle error of the cx gate diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.drag_schedules.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.drag_schedules.md index 0af961d3c2f..7352fe740d7 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.drag_schedules.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.drag_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.drag_schedules -`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`drag_schedules(beta_list, qubits, pulse_amp, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a drag experiment doing a pulse then the - pulse diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.get_single_q_pulse.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.get_single_q_pulse.md index dc53d3a0226..4f6fbde2321 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.get_single_q_pulse.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.get_single_q_pulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.get_single_q_pulse -`get_single_q_pulse(inst_map, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`get_single_q_pulse(inst_map, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Get the DRAG parameters for the single qubit pulse diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.rabi_schedules.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.rabi_schedules.md index 42ea4ca52bd..aa0bbcbf677 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.rabi_schedules.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.rabi_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.rabi_schedules -`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") +`rabi_schedules(amp_list, qubits, pulse_width, pulse_sigma=None, width_sigma_ratio=4, drives=None, inst_map=None, meas_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/pulse_schedules.py "view source code") Generates schedules for a rabi experiment using a Gaussian pulse diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.t1_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.t1_circuits.md index 508ad9af4d6..e4a3cc2e03c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.t1_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.t1_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t1_circuits -`t1_circuits(num_of_gates, gate_time, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t1_circuits(num_of_gates, gate_time, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T1 measurement. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2_circuits.md index 04c20edb55f..b9f20d4cbd3 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2_circuits -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2 (echo) measurement, by a CPMG sequence. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2star_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2star_circuits.md index fd7a3a9313e..0fae4900b05 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2star_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.t2star_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.t2star_circuits -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") +`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/coherence/circuits.py "view source code") Generate circuits for T2\* measurement. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.update_u_gates.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.update_u_gates.md index 5d9b1fa3315..d72811bf256 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.update_u_gates.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.update_u_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.update_u_gates -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") +`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/calibrations/ibmq_utils.py "view source code") Update the cmd\_def with new single qubit gate values diff --git a/docs/api/qiskit/0.36/qiskit.ignis.characterization.zz_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.characterization.zz_circuits.md index 1188ca79ac3..02ca087303c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.characterization.zz_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.characterization.zz_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.characterization.zz_circuits -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") +`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/characterization/hamiltonian/circuits.py "view source code") Generates circuit for measuring ZZ. Two Ramsey experiments, the first with the spectator in the ground state, the second with the spectator in the excited state diff --git a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.md b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.md index ad2fef2c8f5..60d8b19a375 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogReader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogReader -`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Reads and constructs tabular representation of logged data based on date/time an -`IgnisLogReader.get_log_files()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.get_log_files()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time. @@ -40,7 +40,7 @@ list -`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Retrieve log lines using key and date/time filtering criteria diff --git a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.md b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.md index 2755cdcb815..91335aa8873 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogger -`IgnisLogger(name, level=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger(name, level=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `logging.Logger` @@ -59,7 +59,7 @@ Loop through all handlers for this logger and its parents in the logger hierarch -`IgnisLogger.configure(sh, conf_file_exists)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.configure(sh, conf_file_exists)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Internal configuration method of IgnisLogger. Should only be called by IgnisLogger @@ -96,7 +96,7 @@ logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) -`IgnisLogger.disable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.disable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Disable file logging for this logger object (note there is a single object for a given logger name @@ -104,7 +104,7 @@ Disable file logging for this logger object (note there is a single object for a -`IgnisLogger.enable_file_logging()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.enable_file_logging()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Enable file logging for this logger object (note there is a single object for a given logger name @@ -244,7 +244,7 @@ logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) -`IgnisLogger.log_to_file(**kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogger.log_to_file(**kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Log key:value pairs to a log file. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.md b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.md index 0b95a9f7a46..ab74a5b494f 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.logging.IgnisLogging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.logging.IgnisLogging -`IgnisLogging(log_config_path=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging(log_config_path=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is -`IgnisLogging.default_datetime_fmt()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.default_datetime_fmt()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get the default date time format used for writing log entries @@ -52,7 +52,7 @@ Default date time format -`IgnisLogging.get_file_handler()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_file_handler()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Configure and retrieve the RotatingFileHandler object. Called on demand the first time IgnisLoggers needs to write to a file @@ -68,7 +68,7 @@ RotatingFileHandler -`IgnisLogging.get_log_file()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_log_file()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Get the name of the log file @@ -84,7 +84,7 @@ Name of the log file -`IgnisLogging.get_logger(name)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") +`IgnisLogging.get_logger(name)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py "view source code") Return an IgnisLogger object diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.md b/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.md index 0866faeff43..86c1b8d75a0 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.DiscriminationFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.DiscriminationFilter -`DiscriminationFilter(discriminator, base=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter(discriminator, base=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( -`DiscriminationFilter.apply(raw_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.apply(raw_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Create a new result from the raw\_data by converting level 1 data to level 2 data. @@ -51,7 +51,7 @@ A list of qiskit.Result or qiskit.Result. -`DiscriminationFilter.count(y_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`DiscriminationFilter.count(y_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Converts discriminated results into raw counts. @@ -71,7 +71,7 @@ A dict of raw counts. -`static DiscriminationFilter.get_base(expected_states)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") +`static DiscriminationFilter.get_base(expected_states)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/filters.py "view source code") Returns the base inferred from expected\_states. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.md index 877a0613248..6b0aa21b2f1 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.discriminators.BaseDiscriminationFitter` @@ -43,7 +43,7 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. -`abstract IQDiscriminationFitter.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -63,7 +63,7 @@ The discriminated x\_data as a list of labels. -`abstract IQDiscriminationFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`abstract IQDiscriminationFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. @@ -71,7 +71,7 @@ Fits the discriminator using self.\_xdata and self.\_ydata. -`IQDiscriminationFitter.format_iq_data(iq_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.format_iq_data(iq_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. Each sub list is IQ data where the first half of the list is the I data and the second half of the list is the Q data. @@ -95,7 +95,7 @@ A list of shots where each entry is a list of IQ points. -`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_xdata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves feature data (xdata) for the discriminator. @@ -121,7 +121,7 @@ data as a list of features. Each feature is a list. -`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.get_ydata(results, schedule_type_to_get, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Retrieves the expected states (ydata) for the discriminator. @@ -167,7 +167,7 @@ bool -`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Creates a plot of the data used to fit the discriminator. @@ -198,7 +198,7 @@ tuple -`IQDiscriminationFitter.plot_xdata(axs, results, color=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`IQDiscriminationFitter.plot_xdata(axs, results, color=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.md b/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.md index ef7794ad9f7..3df5b0cd935 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Linear discriminant analysis discriminator for IQ data. -`LinearIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`LinearIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`LinearIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.md b/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.md index 10b24aab347..5e3982fea64 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -48,7 +48,7 @@ Quadratic discriminant analysis discriminator for IQ data. -`QuadraticIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -68,7 +68,7 @@ The discriminated x\_data as a list of labels. -`QuadraticIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`QuadraticIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.md b/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.md index baa69f9e0b9..54bb0a1ba3c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Bases: `qiskit.ignis.measurement.discriminator.iq_discriminators.IQDiscriminationFitter` @@ -44,7 +44,7 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn -`SklearnIQDiscriminator.discriminate(x_data)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.discriminate(x_data)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Applies the discriminator to x\_data. @@ -64,7 +64,7 @@ the discriminated x\_data as a list of labels. -`SklearnIQDiscriminator.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") +`SklearnIQDiscriminator.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/measurement/discriminator/iq_discriminators.py "view source code") Fits the discriminator using self.\_xdata and self.\_ydata. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md index 1f75d6df980..46a867616d4 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -50,7 +50,7 @@ float -`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -72,7 +72,7 @@ np.ndarray -`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -103,7 +103,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.generator_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the generator matrix on the specified qubits. @@ -125,7 +125,7 @@ sps.coo\_matrix -`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -169,7 +169,7 @@ int -`CTMPExpvalMeasMitigator.noise_strength(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.noise_strength(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Return the noise strength $gamma$ on the specified qubits @@ -254,7 +254,7 @@ int -`CTMPExpvalMeasMitigator.seed(value=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") +`CTMPExpvalMeasMitigator.seed(value=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/ctmp_mitigator.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md index 0d3f8eb3543..78443ccf05a 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator -`CompleteExpvalMeasMitigator(amat)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator(amat)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -54,7 +54,7 @@ float -`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -111,7 +111,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") +`CompleteExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/complete_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.md index f8ee6953663..0edea69dc53 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -46,7 +46,7 @@ Add measurement calibration data -`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.plot_calibration(ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot the calibration matrix (2D color grid plot) @@ -59,7 +59,7 @@ Plot the calibration matrix (2D color grid plot) -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -83,7 +83,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md index f56948c221f..a0afa4a5ebd 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter -`ExpvalMeasMitigatorFitter(result, metadata)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter(result, metadata)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Fit a measurement error mitigator object from experiment data. -`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") +`ExpvalMeasMitigatorFitter.fit(method=None, generators=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/fitter.py "view source code") Fit and return the Mitigator object from the calibration data. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.md index 083559659f0..c9ed1e0fe59 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.MeasurementFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.MeasurementFilter -`MeasurementFilter(cal_matrix, state_labels)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter(cal_matrix, state_labels)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me -`MeasurementFilter.apply(raw_data, method='least_squares')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`MeasurementFilter.apply(raw_data, method='least_squares')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrix to results. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md index 15ee8da8a10..fa11407f7b0 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator -`TensoredExpvalMeasMitigator(amats)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator(amats)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Bases: `qiskit.ignis.mitigation.expval.base_meas_mitigator.BaseExpvalMeasMitigator` @@ -32,7 +32,7 @@ Initialize a TensorMeasurementMitigator -`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_fidelity(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment fidelity on the specified qubits. @@ -54,7 +54,7 @@ float -`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -76,7 +76,7 @@ np.ndarray -`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.expectation_value(counts, diagonal=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -107,7 +107,7 @@ The `clbits` kwarg is used to marginalize the input counts dictionary over the s -`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") +`TensoredExpvalMeasMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/tensored_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.md index bfa7ac5af6d..afe433ce0ec 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredFilter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredFilter -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice -`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.apply(raw_data, method='least_squares', meas_layout=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Apply the calibration matrices to results. @@ -87,7 +87,7 @@ dict or [Result](qiskit.result.Result "qiskit.result.Result") -`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.compute_index_of_cal_mat(state, pos_qubits, indices)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Return the index of (pseudo inverse) calibration matrix for the input quantum state @@ -99,7 +99,7 @@ Return the index of (pseudo inverse) calibration matrix for the input quantum st -`TensoredFilter.flip_state(state, mat_index, flip_poses)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") +`TensoredFilter.flip_state(state, mat_index, flip_poses)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/filters.py "view source code") Flip the state according to the chosen qubit positions diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.md index e8f9921e866..a9dae640d04 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Add measurement calibration data @@ -48,7 +48,7 @@ Add measurement calibration data -`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.plot_calibration(cal_index=0, ax=None, show_plot=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Plot one of the calibration matrices (2D color grid plot). @@ -67,7 +67,7 @@ Plot one of the calibration matrices (2D color grid plot). -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.complete_meas_cal.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.complete_meas_cal.md index d8e9218ffdd..5108e210fec 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.complete_meas_cal.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.complete_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.complete_meas_cal -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of measurement calibration circuits for the full Hilbert space. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expectation_value.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expectation_value.md index a235ad984f0..4709cbce409 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expectation_value.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expectation_value -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/utils.py "view source code") +`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/utils.py "view source code") Compute the expectation value of a diagonal operator from counts. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md index 8d7e8a27e47..0a5143a701b 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.expval_meas_mitigator_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/circuits.py "view source code") +`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/expval/circuits.py "view source code") Generate measurement error mitigator circuits and metadata. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.tensored_meas_cal.md b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.tensored_meas_cal.md index 2c0591998d6..c09b4736d27 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.mitigation.tensored_meas_cal.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.mitigation.tensored_meas_cal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.mitigation.tensored_meas_cal -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") +`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/mitigation/measurement/circuits.py "view source code") Return a list of calibration circuits diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.md index 0a5224159fe..cb2f7b29eb2 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationCircuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationCircuits -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize the circuit generation class parse into layers -`AccreditationCircuits.generate_circuits(num_trap)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.generate_circuits(num_trap)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Generate quantum circuits for accreditation @@ -59,7 +59,7 @@ tuple -`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") +`AccreditationCircuits.target_circuit(target_circ, two_qubit_gate='cx', coupling_map=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/circuits.py "view source code") Load target circuit in to class, and parse into layers diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.md index e99c8d57b07..9e28ade246a 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.AccreditationFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter -`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Data can be input either as qiskit result objects, or as lists of bitstrings (th -`AccreditationFitter.AppendResults(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.AppendResults(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single run of accreditation protocol, data input as qiskit result object assumed to be single shot @@ -49,7 +49,7 @@ Single run of accreditation protocol, data input as qiskit result object assumed -`AccreditationFitter.AppendStrings(strings, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.AppendStrings(strings, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Single run of accreditation protocol, data input as a list of output strings @@ -63,7 +63,7 @@ Single run of accreditation protocol, data input as a list of output strings -`AccreditationFitter.FullAccreditation(confidence)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.FullAccreditation(confidence)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence interval desired. This protocol is from \[1] and fully treats non-Markovian errors @@ -87,7 +87,7 @@ dict -`AccreditationFitter.MeanAccreditation(confidence)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.MeanAccreditation(confidence)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") This function computes the bound on variation distance based and the confidence interval desired. This protocol is from \[2] and assumes Markovianity but gives an improved bound @@ -107,7 +107,7 @@ dict -`AccreditationFitter.Reset()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.Reset()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") Reset the accreditation class object @@ -115,7 +115,7 @@ Reset the accreditation class object -`AccreditationFitter.bound_variation_distance(theta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.bound_variation_distance(theta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") DEPRECATED-This function computes the bound on variation distance based and the confidence :param theta: number between 0 and 1 :type theta: float @@ -127,7 +127,7 @@ DEPRECATED-This function computes the bound on variation distance based and the -`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") +`AccreditationFitter.single_protocol_run(results, postp_list, v_zero)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/fitters.py "view source code") DEPRECATED-Single protocol run of accreditation protocol :param results: results of the quantum job :type results: Result :param postp\_list: list of strings used to post-process outputs :type postp\_list: list :param v\_zero: position of target :type v\_zero: int diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.md index 4fc927ea9fa..7173a7fad94 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.BConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.BConfig -`BConfig(backend, indicator=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig(backend, indicator=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr -`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_layout(n, transpiled=True, barriered=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Feeds the Tier Dict of the backend to create a basic qiskit GHZ circuit with no measurement; :type n: `int` :param n: number of qubits :type transpiled: `bool` :param transpiled: toggle on/off transpilation - useful for tomography :type barriered: `bool` :param barriered: yes/no whether to barrier each step of CNOT gates @@ -38,7 +38,7 @@ A GHZ Circuit and its initial GHZ layout -`BConfig.get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta @@ -60,7 +60,7 @@ The MQC circuit and the initial GHZ layout -`BConfig.get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized MQC circuit. Remember that get\_counts() method accepts an index now, not a circuit @@ -81,7 +81,7 @@ The MQC circuit, its delta parameter, and the initial GHZ layout -`BConfig.get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta @@ -102,7 +102,7 @@ The Parity Oscillation circuit and the initial GHZ layout -`BConfig.get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get a parametrized PO circuit. Remember that get\_counts() method accepts an index now, not a circuit. The two phase parameters are a quirk of the Parameter module @@ -124,7 +124,7 @@ and the initial ghz layout -`BConfig.get_ghz_simple(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_ghz_simple(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Get simple GHZ circuit with measurement @@ -145,7 +145,7 @@ A GHZ Circuit, its measurement circle quantum register and the initial GHZ layou -`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_measurement_circ(n, qregname, cregname, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. The default is measurement of all qubits. @@ -168,7 +168,7 @@ The measurement circuit -`BConfig.get_tier_dict()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") +`BConfig.get_tier_dict()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/parallelize.py "view source code") Take the nodes of the BConfig to create a Tier Dictionary, where keys are the steps in the process, and the values are the connections following pattern of: \[controlled qubit, NOT qubit]. Thus the backend’s GHZ state is parallelized. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.md index f916cb66faf..d0557c6955a 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. Contains two RBFitter objects. -`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.add_data(new_cnotdihedral_Z_result, new_cnotdihedral_X_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`CNOTDihedralRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. Outputs results into an internal variable: \_raw\_data . @@ -57,7 +57,7 @@ Retrieve probabilities of success from execution results. Outputs results into a -`CNOTDihedralRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. Outputs results into an internal variable: \_ydata . @@ -65,7 +65,7 @@ Extract averages and std dev. Outputs results into an internal variable: \_ydata -`CNOTDihedralRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the non-Clifford cnot-dihedral RB results. @@ -90,7 +90,7 @@ list -`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -104,7 +104,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`CNOTDihedralRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.md index 583deb9126f..c60cbebb3a7 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GatesetTomographyFitter -`GatesetTomographyFitter(result, circuits, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter(result, circuits, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ result_gate = result_gates[gate.name] -`GatesetTomographyFitter.fit()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.fit()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using optimization. @@ -75,7 +75,7 @@ The gateset optimization process con/.sists of three phases: 1) Use linear inver -`GatesetTomographyFitter.linear_inversion()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") +`GatesetTomographyFitter.linear_inversion()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/gateset_fitter.py "view source code") Reconstruct a gate set from measurement data using linear inversion. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.md index 304851b8e69..5cd02b0fd01 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.GraphDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.GraphDecoder -`GraphDecoder(code, S=None, brute=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder(code, S=None, brute=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr -`GraphDecoder.get_error_probs(results, logical='0')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_error_probs(results, logical='0')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate probabilities of single error events from result counts. :param results: A results dictionary, as produced by the :type results: dict :param process\_results method of the code.: :param logical: Logical value whose results are used. :type logical: string @@ -52,7 +52,7 @@ Uses results to estimate the probability of the errors that create the pairs of -`GraphDecoder.get_logical_prob(results, algorithm='matching')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.get_logical_prob(results, algorithm='matching')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -72,7 +72,7 @@ dict -`GraphDecoder.make_error_graph(string, subgraphs=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.make_error_graph(string, subgraphs=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -92,7 +92,7 @@ E -`GraphDecoder.matching(string)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.matching(string)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") **Parameters** @@ -116,7 +116,7 @@ This function can be run directly, or used indirectly to calculate a logical err -`GraphDecoder.weight_syndrome_graph(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`GraphDecoder.weight_syndrome_graph(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Generate weighted syndrome graph from result counts. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.md index 904bf41bcce..2e320a8d621 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.InterleavedRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.InterleavedRBFitter -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte -`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.add_data(new_original_result, new_interleaved_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -49,7 +49,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`InterleavedRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Outputs results into an internal variables: \_raw\_original\_data and \_raw\_int -`InterleavedRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev. @@ -69,7 +69,7 @@ Output \[ydata\_original, ydata\_interleaved] -`InterleavedRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the interleaved RB results. Fit each of the patterns. @@ -87,7 +87,7 @@ Puts the results into a list of fit dictionaries: where each dictionary correspo -`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.fit_data_pattern(patt_ind, fit_guess, fit_index=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -101,7 +101,7 @@ Fit the RB results of a particular pattern to an exponential curve. -`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`InterleavedRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot interleaved randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.md index 546ec4b3d0a..d17997d3f38 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.Plotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.Plotter -`Plotter(label)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter(label)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Various plots of the ground state in MQC and PO experiments -`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.get_fourier_info(qn, x, y, y_m, p_dict)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fourier trans. data/plot of both mqc and po exps. :type qn: `int` :param qn: Number of qubits :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `array` :param y\_m: Mitigated counts series :type p\_dict: `Dict` :param p\_dict: probabilities dictionary @@ -43,7 +43,7 @@ The fourier transform data -`Plotter.sin_plotter(x, y, y_m=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.sin_plotter(x, y, y_m=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phase series :type y: `array` :param y: Counts series :type y\_m: `Optional`\[`array`] :param y\_m: Mitigated counts series @@ -55,7 +55,7 @@ Make sin plot of counts in both mqc and po exps. :type x: `array` :param x: Phas -`Plotter.title_maker()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`Plotter.title_maker()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Make title depending on type of exp. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.md index ac47c456f8d..32fd28d2bc6 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ProcessTomographyFitter -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") +`ProcessTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/process_fitter.py "view source code") Reconstruct a quantum channel using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.md index d5895121282..2a93804ae9b 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.PurityRBFitter -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -31,7 +31,7 @@ Derived from RBFitterBase class. -`static PurityRBFitter.F234(n, a, b)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`static PurityRBFitter.F234(n, a, b)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n @@ -39,7 +39,7 @@ Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b -`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_data(new_purity_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. @@ -56,7 +56,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.add_zdict_ops()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.add_zdict_ops()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Creating all Z-correlators in order to compute the expectation values. @@ -64,7 +64,7 @@ Creating all Z-correlators in order to compute the expectation values. -`PurityRBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -78,7 +78,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`PurityRBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -93,7 +93,7 @@ Dictionary ydata\[i]: -`PurityRBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the Purity RB results to an exponential curve. @@ -110,7 +110,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -128,7 +128,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`PurityRBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot purity RB data of a single pattern. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTP.md index 73b24b6b443..94055214d79 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTP -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Performs a QOTP (or random compilation) on a generic circuit. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectCounts.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectCounts.md index a01de06d5bf..c65ef987a54 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectCounts -`QOTPCorrectCounts(qotp_counts, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectCounts(qotp_counts, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a dictionary of results, shifting the qotp diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectString.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectString.md index e17c285b023..bcda1ea7fb5 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectString.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.QOTPCorrectString.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QOTPCorrectString -`QOTPCorrectString(qotp_string, qotp_postp)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") +`QOTPCorrectString(qotp_string, qotp_postp)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/accreditation/qotp.py "view source code") Corrects a measurement string, shifting the qotp diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.md index d727c76d29c..ffda35caa18 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.QVFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.QVFitter -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for fitters for quantum volume. -`QVFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add a new result. Re calculate fit @@ -49,7 +49,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.add_statevectors(new_statevector_result)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.add_statevectors(new_statevector_result)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Add the ideal results and convert to the heavy outputs. @@ -67,7 +67,7 @@ Assume the result is from ‘statevector\_simulator’ -`QVFitter.calc_confidence_level(z_value)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_confidence_level(z_value)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate confidence level using z value. @@ -89,7 +89,7 @@ float -`QVFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Make a count dictionary for each unique circuit from all the results. @@ -103,7 +103,7 @@ Assumes that ‘result’ was executed is the output of circuits generated by qv -`QVFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Convert the heavy outputs in the different trials into mean and error for plotting. @@ -113,7 +113,7 @@ Here we assume the error is due to a binomial distribution. Error (standard devi -`QVFitter.calc_z_value(mean, sigma)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.calc_z_value(mean, sigma)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Calculate z value using mean and sigma. @@ -134,7 +134,7 @@ float -`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_hop_accumulative(depth, ax=None, figsize=(7, 5))` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. @@ -160,7 +160,7 @@ matplotlib.Figure -`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_data(ax=None, show_plt=True, figsize=(7, 5), set_title=True, title=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot the qv data as a function of depth @@ -188,7 +188,7 @@ matplotlib.Figure -`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.plot_qv_trial(depth, trial_index, figsize=(7, 5), ax=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Plot individual trial. :param depth: circuit depth :type depth: int :param trial\_index: trial index :type trial\_index: int :param figsize: Figure size in inches. :type figsize: tuple :param ax: plot axis (if passed in). :type ax: Axes or None @@ -204,7 +204,7 @@ matplotlib.Figure -`QVFitter.quantum_volume()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.quantum_volume()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return the volume for each depth. @@ -220,7 +220,7 @@ list -`QVFitter.qv_success()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") +`QVFitter.qv_success()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/fitters.py "view source code") Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.md index 88a92ae06e8..7aeb89808e7 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.RBFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RBFitter -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Bases: `qiskit.ignis.verification.randomized_benchmarking.fitters.RBFitterBase` @@ -28,7 +28,7 @@ Class for fitters for randomized benchmarking. -`RBFitter.add_data(new_backend_result, rerun_fit=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.add_data(new_backend_result, rerun_fit=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Add a new result. Re calculate the raw data, means and fit. @@ -45,7 +45,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Retrieve probabilities of success from execution results. @@ -59,7 +59,7 @@ Assumes that the executed ‘result’ is the output of circuits generated by ra -`RBFitter.calc_statistics()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.calc_statistics()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Extract averages and std dev from the raw data (self.\_raw\_data). @@ -72,7 +72,7 @@ Assumes that self.\_calc\_data has been run. Output into internal \_ydata variab -`RBFitter.fit_data()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results to an exponential curve. @@ -88,7 +88,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.fit_data_pattern(patt_ind, fit_guess)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.fit_data_pattern(patt_ind, fit_guess)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Fit the RB results of a particular pattern to an exponential curve. @@ -107,7 +107,7 @@ Puts the results into a list of fit dictionaries where each dictionary correspon -`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") +`RBFitter.plot_rb_data(pattern_index=0, ax=None, add_label=True, show_plt=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/fitters.py "view source code") Plot randomized benchmarking data of a single pattern. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.md index 46b369b81ad..cf96f6d2bdb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.RepetitionCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.RepetitionCode -`RepetitionCode(d, T=0, xbasis=False, resets=False, delay=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode(d, T=0, xbasis=False, resets=False, delay=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f -`RepetitionCode.get_circuit_list()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.get_circuit_list()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Returns** @@ -50,7 +50,7 @@ circuit\_list -`RepetitionCode.process_results(raw_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.process_results(raw_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") **Parameters** @@ -74,7 +74,7 @@ The circuits must be executed outside of this class, so that their is full freed -`RepetitionCode.readout()`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.readout()` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. @@ -82,7 +82,7 @@ Readout of all code qubits, which corresponds to a logical measurement as well a -`RepetitionCode.syndrome_measurement(final=False, barrier=False, delay=0)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.syndrome_measurement(final=False, barrier=False, delay=0)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Application of a syndrome measurement round. @@ -96,7 +96,7 @@ Application of a syndrome measurement round. -`RepetitionCode.x(logs=('0', '1'), barrier=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") +`RepetitionCode.x(logs=('0', '1'), barrier=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/circuits.py "view source code") Applies a logical x to the circuits for the given logical values. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.md index 943b23e550a..6d75bf220ce 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.StateTomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.StateTomographyFitter -`StateTomographyFitter(result, circuits, meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter(result, circuits, meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Bases: `qiskit.ignis.verification.tomography.fitters.base_fitter.TomographyFitter` @@ -47,7 +47,7 @@ Add tomography data from a Qiskit Result object. -`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") +`StateTomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/state_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.md index 508c52aef7b..1d6f0728a6d 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.TomographyFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.TomographyFitter -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize tomography fitter with experimental data. -`TomographyFitter.add_data(results, circuits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.add_data(results, circuits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Add tomography data from a Qiskit Result object. @@ -48,7 +48,7 @@ Add tomography data from a Qiskit Result object. -`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.fit(method='auto', standard_weights=True, beta=0.5, psd=True, trace=None, trace_preserving=False, **kwargs)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Reconstruct a quantum state using CVXPY convex optimization. @@ -115,7 +115,7 @@ The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - -`TomographyFitter.set_measure_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_measure_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the measurement basis @@ -131,7 +131,7 @@ Set the measurement basis -`TomographyFitter.set_preparation_basis(basis)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") +`TomographyFitter.set_preparation_basis(basis)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/fitters/base_fitter.py "view source code") Set the preparation basis function diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epc.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epc.md index c438e74ea51..6a21000a800 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epc.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epc -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epg.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epg.md index d5722d92327..a3233d6c5f8 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epg.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_1q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_1q_epg -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epc.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epc.md index 72dfdb86c02..d31054f275f 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epc.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epc -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epg.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epg.md index 8144d7203da..67a3f8aaf54 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epg.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.calculate_2q_epg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.calculate_2q_epg -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.coherence_limit.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.coherence_limit.md index 03981397ec3..80526b35de2 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.coherence_limit.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.coherence_limit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.coherence_limit -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.combine_counts.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.combine_counts.md index 2ebdbacad89..9e8adbdd4c9 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.combine_counts.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.combine_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.combine_counts -`combine_counts(counts1, counts2)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`combine_counts(counts1, counts2)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Combine two counts dictionaries. :type counts1: `Dict`\[`str`, `int`] :param counts1: One of the count dictionaries to combine. :type counts2: `Dict`\[`str`, `int`] :param counts2: One of the count dictionaries to combine. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z.md index 80e7bf056b5..28715965b77 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z -`composite_pauli_z(qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z(qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates n tensored pauli z matrix upon input of qubit number diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z_expvalue.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z_expvalue.md index a7ae10b833c..c04f146899b 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z_expvalue.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.composite_pauli_z_expvalue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue -`composite_pauli_z_expvalue(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`composite_pauli_z_expvalue(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.count_gates.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.count_gates.md index 44b548665be..850c6feec6b 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.count_gates.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.count_gates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_gates -`count_gates(qobj, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`count_gates(qobj, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a compiled qobj and output the number of gates in each circuit. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.count_keys.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.count_keys.md index 6f44c215679..bb417e61fed 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.count_keys.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.count_keys.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.count_keys -`count_keys(num_qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`count_keys(num_qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Return ordered count keys. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.expectation_counts.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.expectation_counts.md index 975c0154436..1f2256aeb5c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.expectation_counts.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.expectation_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.expectation_counts -`expectation_counts(counts)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`expectation_counts(counts)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Converts count dict to an expectation counts dict. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.gates_per_clifford.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.gates_per_clifford.md index eeec90f6fb1..8601d64c811 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.gates_per_clifford.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.gates_per_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gates_per_clifford -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. Each `QuantumCircuit` should be transpiled into given `basis` set. The result can be used to convert a value of error per Clifford into error per basis gate under appropriate assumption. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.gateset_tomography_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.gateset_tomography_circuits.md index db01bf2a76f..27026f4adea 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.gateset_tomography_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.gateset_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.gateset_tomography_circuits -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum gate set tomography (GST) circuits. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc.md index 5b5131afc30..4f255fd9f2d 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc -`get_ghz_mqc(n, delta, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc(n, delta, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc_para.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc_para.md index f4dd3e599c9..3358ebb30cb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc_para.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_mqc_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_mqc_para -`get_ghz_mqc_para(n, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_mqc_para(n, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po.md index c3804f6fb55..e70e4458ea4 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po -`get_ghz_po(n, delta)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po(n, delta)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po_para.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po_para.md index 3000fbba603..97b6773cbdb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po_para.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_po_para.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_po_para -`get_ghz_po_para(n)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_po_para(n)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_simple.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_simple.md index 034766ed548..3f5471787bb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_simple.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.get_ghz_simple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.get_ghz_simple -`get_ghz_simple(n, measure=True, full_measurement=True)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") +`get_ghz_simple(n, measure=True, full_measurement=True)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/linear.py "view source code") Creates a linear GHZ state with the option of measurement diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.lookuptable_decoding.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.lookuptable_decoding.md index f0dd6c9571b..44e5019912a 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.lookuptable_decoding.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.lookuptable_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.lookuptable_decoding -`lookuptable_decoding(training_results, real_results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`lookuptable_decoding(training_results, real_results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. This postselects all results with trivial syndrome. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.marginal_counts.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.marginal_counts.md index 5389acadc83..7ee9f59cc18 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.marginal_counts.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.marginal_counts -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") +`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/data.py "view source code") Compute marginal counts from a counts dictionary. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.ordered_list_generator.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.ordered_list_generator.md index c1e174d8460..baa787e47d6 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.ordered_list_generator.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.ordered_list_generator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.ordered_list_generator -`ordered_list_generator(counts_dictionary, qn)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`ordered_list_generator(counts_dictionary, qn)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.postselection_decoding.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.postselection_decoding.md index 60df02a7ab6..50215c213dc 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.postselection_decoding.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.postselection_decoding.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.postselection_decoding -`postselection_decoding(results)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") +`postselection_decoding(results)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/topological_codes/fitters.py "view source code") Calculates the logical error probability using postselection decoding. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.process_tomography_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.process_tomography_circuits.md index 468696a3fb2..ba1ef665a33 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.process_tomography_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.process_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.process_tomography_circuits -`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`process_tomography_circuits(circuit, measured_qubits, prepared_qubits=None, meas_labels='Pauli', meas_basis='Pauli', prep_labels='Pauli', prep_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum process tomography circuits. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.qv_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.qv_circuits.md index 471a2aadfc2..cb96d7e931c 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.qv_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.qv_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.qv_circuits -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") +`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/quantum_volume/circuits.py "view source code") Return a list of square quantum volume circuits (depth=width) diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.randomized_benchmarking_seq.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.randomized_benchmarking_seq.md index d0db986adbc..d0d740ecefb 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.randomized_benchmarking_seq.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.randomized_benchmarking_seq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq -`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") +`randomized_benchmarking_seq(nseeds=1, length_vector=None, rb_pattern=None, length_multiplier=1, seed_offset=0, align_cliffs=False, interleaved_gates=None, interleaved_elem=None, keep_original_interleaved_elem=True, is_purity=False, group_gates=None, rand_seed=None)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/circuits.py "view source code") Generate generic randomized benchmarking (RB) sequences. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.rho_to_fidelity.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.rho_to_fidelity.md index 882eb7fb26c..1576597133e 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.rho_to_fidelity.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.rho_to_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.rho_to_fidelity -`rho_to_fidelity(rho)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") +`rho_to_fidelity(rho)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/entanglement/analysis.py "view source code") Get fidelity given rho :type rho: `float` :param rho: The density matrix diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.state_tomography_circuits.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.state_tomography_circuits.md index 8ebd16870cb..6e232437363 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.state_tomography_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.state_tomography_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.state_tomography_circuits -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") +`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/tomography/basis/circuits.py "view source code") Return a list of quantum state tomography circuits. diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.twoQ_clifford_error.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.twoQ_clifford_error.md index 20364819a15..36eb1281be7 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.twoQ_clifford_error.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.twoQ_clifford_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.ignis.verification.twoQ_clifford_error -`twoQ_clifford_error(ngates, gate_qubit, gate_err)`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") +`twoQ_clifford_error(ngates, gate_qubit, gate_err)` [GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/verification/randomized_benchmarking/rb_utils.py "view source code") The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). Assumes the error in the underlying gates is depolarizing. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.md index 7b1f73f7f16..fde3b7e1299 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.md index 5a206826e93..dbdea0dc70d 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.36/qiskit.opflow.anti_commutator.md index 14c6786f03a..ea8d838548e 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.commutator.md b/docs/api/qiskit/0.36/qiskit.opflow.commutator.md index e6e237e6c18..d4b058854b3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.md index 42416e19455..9faf73b4408 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.md index cfd6569b3a5..f0288197837 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.md index 96a064d3308..64a6a9d2884 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.md index 79a94a6d9b5..d55e8dd0267 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.md index ce76fcb233c..cb2ae0b0983 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.md index eebf48b0298..c3e73b60451 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.36/qiskit.opflow.double_commutator.md index dad7f9dd505..8ef58dabf09 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.md index a14ceef2475..1c1cedd223b 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase`, `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.md index a67b4b41b51..749cbb7bac4 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.md index f7249508271..2137c21b745 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.md index 8cfa87748fb..9eda01c6a08 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.md index e80673df1d1..e6c32bd7926 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.md index 82b0edb14f2..96bb536a215 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.md index 3445ecd128f..31f71deceb7 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase` @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.md index c993504d0f4..be86b40e5b3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: `qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki` diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.md index 3a0803b5920..addc1408ea8 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: `qiskit.opflow.evolutions.evolution_base.EvolutionBase` @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.md index 1aa43b3b813..1217f3d7e24 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.md index 3c38314cc47..f2e819654d1 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.md index 0eeb44d03c4..81d72aeb683 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: `OperatorBase` :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.md index 209dffbe780..30438ae4008 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.md index 53dc264dc24..09559af937d 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.md index 957af810215..d34b9a4123a 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.md index 4daf8c8034b..628f20685c4 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: `qiskit.opflow.expectations.expectation_base.ExpectationBase` @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.md index 6afc7bb0eed..e6c3b682609 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.md index bf8881960e7..e00258ba1cf 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.md index a82fd6c459b..6f13a66c77e 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.md index a79bf38be5d..81477d9eb45 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.md index 9766688f647..6751f67d920 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.md index 3b3d81f8527..2399432d7e5 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") Bases: `qiskit.opflow.gradients.hessian_base.HessianBase` @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.md index d47366ec179..bef62d87dd5 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.md index dc1f576aaa6..9f1ba55f4b3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.md index 082cb47c934..f56a7959b70 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") Bases: `qiskit.opflow.gradients.qfi_base.QFIBase` @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.md index 9460866c4f2..5e32f4a7ae4 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: `qiskit.opflow.gradients.derivative_base.DerivativeBase` diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.md index a95aaf7c82f..b139706e5ca 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.md index c3bce0deda8..56201cfc751 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.md index bb9057d009e..2e25b6470ab 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.md index 7482f9f2c42..7f1e0029f60 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: `qiskit.opflow.list_ops.list_op.ListOp` @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.md index 75fdd5416db..87948a4dbb1 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.md index ab2f0479e08..0676f775188 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.md index 3f2c221d970..44bbc60c27f 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.md index 8c7a3630923..f16c1d823f7 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -181,7 +181,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -193,7 +193,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -215,7 +215,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -235,7 +235,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -259,7 +259,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -275,7 +275,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -296,7 +296,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.md index 8860500d6b7..9654316c3cd 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index f4a8ad71339..12908688c83 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp` @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.md index fcc16288fdf..0143ccb3e62 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: `Z2Symmetries` :returns: copy @@ -66,7 +66,7 @@ Get a copy of self. :rtype: `Z2Symmetries` :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -82,7 +82,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -90,7 +90,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.md index 42640937a93..055753c7588 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.md index e564d3595b0..c3a513401b1 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.md index 4bb3ed2ed86..985256b364b 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.md index 23d0f6d7d53..16f2e3c22d3 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.md index 513e1cdc15e..6b2bcb3a59c 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.md index 75e020c6c22..f4ffc46948e 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.md index 5b631f7adb2..a7648461b44 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.md index 958e26ce2cb..e9bd4a21ee8 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.36/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits, observables, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") +`BaseEstimator(circuits, observables, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") Bases: `abc.ABC` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`abstract BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") +`abstract BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.md index 5a513c47f85..f2a905f0f6d 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.36/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") +`BaseSampler(circuits, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") Bases: `abc.ABC` @@ -33,7 +33,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`abstract BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") +`abstract BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/base_sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.36/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.36/qiskit.primitives.Estimator.md index ffe8f8f1ccc..d0425443cca 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.36/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits, observables, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits, observables, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") Bases: `qiskit.primitives.base_estimator.BaseEstimator` @@ -35,7 +35,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.md index 283a28acc53..93c00d5d831 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.36/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/estimator_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.36/qiskit.primitives.Sampler.md index d0fa46368b3..230e4021e18 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.36/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") Bases: `qiskit.primitives.base_sampler.BaseSampler` @@ -30,7 +30,7 @@ Sampler class -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.md index 922ae049a2f..ece4ccfda60 100644 --- a/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.36/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/primitives/sampler_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.providers.Backend.md b/docs/api/qiskit/0.36/qiskit.providers.Backend.md index 66843ac6699..beae1b515d3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.36/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.md index 0b0a32177d5..9ca4b967328 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.36/qiskit.providers.BackendV1.md index b104b2049f7..c6efab63d2f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.36/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.36/qiskit.providers.BackendV2.md index eb70e8352a8..006b637234c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.36/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `qiskit.providers.backend.Backend`, `abc.ABC` @@ -43,7 +43,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -65,7 +65,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -93,7 +93,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -115,7 +115,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -137,7 +137,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -163,7 +163,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Run on the backend. @@ -186,7 +186,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.md index 9a21f288dd2..cc3824df29f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.36/qiskit.providers.BaseBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseBackend -`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend(configuration, provider=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -35,7 +35,7 @@ This method should initialize the module and its configuration, and raise an exc -`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend configuration. @@ -51,7 +51,7 @@ the configuration for the backend. -`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend name. @@ -67,7 +67,7 @@ str -`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend properties. @@ -83,7 +83,7 @@ the configuration for the backend. If the backend does not support properties, i -`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend Provider. @@ -99,7 +99,7 @@ the Provider responsible for the backend. -`abstract BaseBackend.run(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`abstract BaseBackend.run(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Run a Qobj on the the backend. @@ -111,7 +111,7 @@ Run a Qobj on the the backend. -`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend status. @@ -127,7 +127,7 @@ the status of the backend. -`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") +`BaseBackend.version()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basebackend.py "view source code") Return the backend version. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.36/qiskit.providers.BaseJob.md index 7d89ef2f73f..9ae813e8997 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.36/qiskit.providers.BaseJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseJob -`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob(backend, job_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -29,7 +29,7 @@ Initializes the asynchronous job. -`BaseJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return the backend where this job was executed. @@ -41,7 +41,7 @@ Return the backend where this job was executed. -`abstract BaseJob.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Attempt to cancel the job. @@ -49,7 +49,7 @@ Attempt to cancel the job. -`BaseJob.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job has been cancelled. @@ -61,7 +61,7 @@ Return whether the job has been cancelled. -`BaseJob.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job has successfully run. @@ -73,7 +73,7 @@ Return whether the job has successfully run. -`BaseJob.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job is in a final job state. @@ -85,7 +85,7 @@ Return whether the job is in a final job state. -`BaseJob.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return a unique id identifying the job. @@ -97,7 +97,7 @@ Return a unique id identifying the job. -`abstract BaseJob.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return the results of the job. @@ -105,7 +105,7 @@ Return the results of the job. -`BaseJob.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return whether the job is actively running. @@ -117,7 +117,7 @@ Return whether the job is actively running. -`abstract BaseJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -125,7 +125,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract BaseJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`abstract BaseJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Submit the job to the backend for execution. @@ -133,7 +133,7 @@ Submit the job to the backend for execution. -`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") +`BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basejob.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.md index 900c488347f..06875420712 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.36/qiskit.providers.BaseProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BaseProvider -`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") +`BaseProvider(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract BaseProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") +`abstract BaseProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") -`BaseProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") +`BaseProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/baseprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.36/qiskit.providers.Job.md b/docs/api/qiskit/0.36/qiskit.providers.Job.md index fbe9fa5c3de..b384f9a17f1 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.36/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobError.md b/docs/api/qiskit/0.36/qiskit.providers.JobError.md index e33482e9c92..84527fb1dcb 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.36/qiskit.providers.JobStatus.md index 0d5d4d6cfdb..507d1adab7d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.36/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.md index 68590082dba..959344f5dee 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.36/qiskit.providers.JobV1.md b/docs/api/qiskit/0.36/qiskit.providers.JobV1.md index 1e6ac2ffe9e..9b712b5241e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.36/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Bases: `qiskit.providers.job.Job`, `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.36/qiskit.providers.Options.md b/docs/api/qiskit/0.36/qiskit.providers.Options.md index d3b52e9320b..29e4a2c7850 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.36/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.36/qiskit.providers.Provider.md b/docs/api/qiskit/0.36/qiskit.providers.Provider.md index 3d2b6efc9ba..7c6faf3e82c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.36/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.md index c76217bea8b..32f4c78a6be 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Bases: `qiskit.providers.provider.Provider`, `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.md index 4486b31c895..52695155607 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.md index 3b8775fb669..aa05de6ae71 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.36/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.md index c9d0d668a98..03f100aa884 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.md index 7df0e876c34..6a631f16582 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.md index 0c07b8a06bb..159dbb1bece 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -185,7 +185,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -193,7 +193,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -209,7 +209,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -243,7 +243,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -251,7 +251,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -339,7 +339,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.md index e9f6b725254..cfb27ed06ea 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.md index 2faf456b13d..5f5fea54d4b 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.md index f84f6ceec55..d170055da16 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.md index 6d7f8665b69..90aaf4fe5bd 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.md index 94b6522592e..b22daa40acb 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -111,7 +111,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -119,7 +119,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index 0effff46a9a..56c29f35d49 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 743c9408ff8..84120db53fa 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.md index c8497e60b44..fbb528874c4 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.md index d8d2ae01540..dadfc41ebbd 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.md index f8ca5b63d6b..b337f8c3c3a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: `qiskit.providers.aer.extensions.snapshot.Snapshot` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.md index a1b096ece7a..e1e3aeefb39 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.md index ed165a97cc0..f5dad3cc8a6 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.md index 6cd0ccbbda0..ecf7551eaba 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.md index 3bb5a22d24d..f08248e8cd1 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.md index 2876e2ff7bd..4eb1cae5a01 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.md index dcc719376c5..e0c50f4fe13 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.md index e9494d58227..7daa7f03ef3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 56e913d9a4d..4e7f01b87aa 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.md index 7358d9a8a17..2dae85d2dd8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.md index 1fdfbb7a05f..7b3ad852ad6 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.md index edbb5c8c6a2..7c2e4185223 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.md index d577c32fe20..b6d300f74f6 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.md index d7c7bfb82d4..0449c2a77e5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.md index b99cb90d53f..ea16c1cff47 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.md index 219f710cdbb..34e834a4ae5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.md index 375e743630f..b4ab370a921 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.md index 0917e55c6b3..02a2cffc041 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.md index 43d30bb001d..8d4bebbc69e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.md index 0ad05f62172..3364dc61d71 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.md index 3cf8ca8847e..34beb03bb0f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.md index 131b898643f..d6d56e3e96c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.md index b2b771c82ea..3be0f145103 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.md index cae997d02f4..8c64b1953b8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes.md index 6a13d926a38..a4a203a3491 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes_squared.md index 062a1c91353..eea7d4cf9e0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_clifford.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_clifford.md index 4f14f97b138..000ca032692 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_clifford.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_density_matrix.md index 291686fe2db..282a10cb17d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value.md index 7103d8722b2..e75393f0cff 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value_variance.md index a24adf5e5a1..4e195786ad8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_matrix_product_state.md index c670bea271c..6d69aa8667c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities.md index 7ca5a88ff97..2dacdffc24c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities_dict.md index f073b756427..dd06f62df2c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_stabilizer.md index 1a4f726abb7..35ab80e59f5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_state.md index 7b05f633ceb..855e187fc51 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector.md index 81e559b9687..a7b4154840a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector_dict.md index 5dcfd30ee90..ec01caea11d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_superop.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_superop.md index 0ecef858f02..b154bb253d3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_superop.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_unitary.md index 8db27bbcb5b..7b0c94f151b 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_density_matrix.md index 5b553a67c48..8bb80af7d7e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_matrix_product_state.md index d98c5a76865..15e771861e8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_stabilizer.md index ce7e9a509b5..9912834fdf6 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_statevector.md index e7581c0bcd6..cebb8fb0124 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_superop.md index 3dbebceb8fd..c93a433e30f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_unitary.md index d911d25a185..f9c8bccee08 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.md index 2f3f882ede1..c93f8e6d13c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: `DAGCircuit` :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.md index 1247e52f123..75abc490d96 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.md index b2eb61cf304..6c1162fb3fd 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -125,7 +125,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -150,7 +150,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -172,7 +172,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -246,7 +246,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -254,7 +254,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -262,7 +262,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -288,7 +288,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -296,7 +296,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -304,7 +304,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.md index 2fb79644c87..8eacb9c4d32 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.md index 8d2875d2d8f..322e3e6116c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: `qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass` diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.amplitude_damping_error.md index 2bc7de3d3e7..afef934915d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.coherent_unitary_error.md index 1c9a2a9f64d..f8097665bd6 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.depolarizing_error.md index bbbe4d0f7b7..07c710fea35 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ce7e7abaeba..c7f87eba5fa 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index fb277fd28dd..a577cfc022a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_error_values.md index 0ce4115bd93..c1f21a62240 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_length_values.md index 3c2c5f23334..f7992b91e97 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_param_values.md index 86a287d0afc..ce5427292f5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.readout_error_values.md index 88cd0f9ad0e..ab6e01038d7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index ec6e650fa60..6721ae46ec3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.kraus_error.md index f0fb3742112..56e560125f2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.mixed_unitary_error.md index dd7f9434768..a6afa4cc627 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.pauli_error.md index ae03836579e..012f973c05c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index ffa103d1939..e23dc9a7b4a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_damping_error.md index 26d234433ce..c258bb0356e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.reset_error.md index 0de3a334da5..587100de267 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.thermal_relaxation_error.md index 2ae3454801c..fad6d2a0c8a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.md index 9a5c7da246e..faef97589c8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.duffing_system_model.md index a5e56ada57e..cc6b846aa7f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.md index a73fc8a3c38..bbcee90f47f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_noise_model.md index bc76519e380..721c78a3ee0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_quantum_error.md index 7375eab0182..079e1acaff4 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.insert_noise.md index 745f84bfd4e..5d930938583 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.remap_noise_model.md index 4afa3125223..bbae7213024 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transform_noise_model.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transform_noise_model.md index 306e20e828f..c58b82a7b30 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_noise_model.md index 2a11b7f650b..c170a903bde 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_quantum_error.md index 6fd2be1adf3..15f5f62f783 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.36/qiskit.providers.aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.md index 1e38e511223..938d08cd1b8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.md index 37482d08983..c55ddd3d3d9 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.md index 82447ca161a..952b5d9fc14 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.md index 826a7ae4303..addf46fe85f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 80605af28c2..26935607642 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: `qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy` diff --git a/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.md index 63c12964f53..d56f604a560 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.36/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.md index 372c69b50a7..b2395cda1ff 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.md index 9e2f72144f4..5696933d4a8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index d3d7859b636..d986df37b1e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 5645c4c24bd..7040b5ff883 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 2b79453f6ba..f4ce04dc5bb 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index ea748b6719a..09a93e6b81f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.md index 3fab47b9099..82186cac087 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 4ffadf8c93c..4a17d4d7b0a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.md index 142a1210f57..d5119a30701 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: `qiskit.providers.backend.BackendV1` @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -477,7 +477,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.md index 8f76680a706..1b44a08e8a0 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index d2954ec6fb0..fd69b6ed1dc 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.md index f68ab861049..68cc2afa143 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.md index 7086afcac99..dae77c237b2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -140,7 +140,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -209,7 +209,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -225,7 +225,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.md index a38a76dfdee..b3a3cd933dc 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.md index 362fb52745c..0b711755a2f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.md index 425f60dce78..df6ad67c778 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.md index b52b29d66b0..de434cd2de8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.md index 483514f86ba..d548c5b761e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.md index fde38e8edaf..0d0b5413ec2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.md index 211e69d3a91..3703893d197 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 856cff72d1e..6235546f8ec 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 869e3725218..b3a235e13fc 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.md index bebdde0ac5f..9091dcf1e63 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 7f6e3e60997..35d375720a5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c753b9b03fd..0a5ff1c030d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.md index 0e16c129460..4119853fe38 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 71ac58216a9..54a3b30406e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.md index 0e98ceffabb..3890486708b 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.md index b191cdbb354..b8fa43c8b8f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.md index c7d560a66e7..d3bfa9ccd14 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.md index 0626db0120a..3fd71c70852 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 8ea40cf804d..74ebff3e9fa 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 57a7fc6c085..5d38a428320 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 0481fda1214..2fd9874cefb 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.md index 45b63ccd381..ab9a3314315 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.job_monitor.md index cc4cc99cad0..9100226736b 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.least_busy.md index 080e23a2dd9..b315766d8e3 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.md index 511561fcc74..98665f420b5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index a6b662fe102..64cce88e50c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 4006a3d0d4e..11e52eaec09 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 4e299221dae..57f826b9283 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index b19ab743224..02872ed993e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index be41ee3b213..4e0a432bb6d 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 8f1556fcdd5..36bcff386f5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.md index b07a52d8e98..f815f3ead5c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.md index 5722af77b6a..195ff84d834 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.md index 261d5e63d48..ebe922640b7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 612e5d25248..5cb1a700448 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 045bf20ddc8..892a734ebd4 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.md index cc95f2130ca..cd225ff724c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: `qiskit.providers.backend.BackendV1`, `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9188f764070..dd32329888f 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a0885b06940..d5400ad6165 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index b9a1da51d6b..69290448ca5 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.md index b49719e52ff..cbfaee37f2b 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 942dc83ad8f..03707eaa300 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 9295abec57c..912f2a08c4e 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.md index f95d6bd4118..0dea489a2d1 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.seconds_to_duration.md index 1f138559be6..f005d414fbe 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.to_python_identifier.md index ad186c83b90..fe8ecb9ffe9 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.update_qobj_config.md index 5de3304b243..661ab0d9da2 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.utc_to_local.md index 161e29c2551..8cfe310b9f8 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.validate_job_tags.md index 6ef795cb48d..4c562c2a072 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.36/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.md index 2e882ec52c8..5edb33673da 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.md index f383607f56d..19cf4a87864 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.md index 836211f0158..535eb1ccaed 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.Command.md b/docs/api/qiskit/0.36/qiskit.providers.models.Command.md index 9fff6e93f43..c1dba1464a7 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.md index f11a7e89ce2..fd50ca8850a 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.md index 6713a1e4e36..871eadba82c 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.md index c85a6697c25..e2a463ea650 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.md index 81cf50a0929..dd8f24609fc 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.md index bdbfaf2a08f..d3935144566 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.md index 478ed61e10b..aa2d1186604 100644 --- a/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.36/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.md index eab182f9c9c..0842f1cc2c9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -159,7 +159,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -182,7 +182,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -204,7 +204,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -228,7 +228,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.36/qiskit.pulse.Schedule.md index 53b0c5bfcb8..6b93b443103 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.md index 4d4ccadd252..f6268735b7b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -172,7 +172,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -205,7 +205,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -236,7 +236,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -258,7 +258,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -283,7 +283,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -295,7 +295,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -307,7 +307,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire.md index d1242c6ce73..c4805cef358 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire_channel.md index ce14e982c35..4e0885d4cf0 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.active_backend.md index abb4c0fbb50..4bd9ea4f9ba 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 3354d2d954d..1ba77612031 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.active_transpiler_settings.md index 7beff7bf866..0ec34745408 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_equispaced.md index ba1e7d8b986..5b900c11bd2 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_func.md index b5be5caba3e..2c43793f98b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_left.md index 7c2634f9a7f..b6ab1c16977 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_right.md index f7b81010ef7..1deb4187ad9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_sequential.md index b8fb038329b..5c0e088898b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.barrier.md index ec3a3e01509..e47ee360afe 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.build.md index f2306164cee..9aa1581ad19 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.call.md index 53da7d1410f..10520b707c9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.circuit_scheduler_settings.md index 4e66f31a9ca..35721d2548d 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.control_channels.md index b93f52f2a8a..9c44e15c1e4 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.cx.md index 98e45af7626..8705e3dd282 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.delay.md index d30b2a7c5f5..3dd545490c3 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.delay_qubits.md index 00db7636f65..f5f31f70f70 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.drive_channel.md index e09bb0d98cf..a5ae38f7a88 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.frequency_offset.md index 82243f1d40b..100dab400b0 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.inline.md index 5c9f0ece200..6a07993e97f 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.measure.md index 39c413b92ad..ec452f6429c 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_all.md index 0593933a940..9ae939c44c3 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_channel.md index a647950b6d6..40c2d6d0729 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.num_qubits.md index ba317700bce..205f78e3b14 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.pad.md index d7bc6474a8e..b1cff65509f 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.phase_offset.md index 5ab7b24936d..45535496657 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.play.md index 71481fc663c..428592a501a 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.qubit_channels.md index b6edd4122d6..1e0272c1974 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.samples_to_seconds.md index 24b22c95263..26cbc393521 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.seconds_to_samples.md index 323c200626a..e1b633f26bb 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.set_frequency.md index 790aeb3778f..600f59a6f5b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.set_phase.md index 3356de2d586..6bf03d65108 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_frequency.md index 463185fa16b..72263b56d1f 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_phase.md index 5c4a7811dd0..93e43229df9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.snapshot.md index 114a1ea0431..2cf63be72f4 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.transpiler_settings.md index faf2d8bb473..3cc5f0bc44c 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.u1.md index ec94d5d431f..5af2cc49c6e 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.u2.md index b54ecdb8538..1ed0f2ae1b4 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.u3.md index f974b1a1331..b55fddacc81 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.36/qiskit.pulse.builder.x.md index 9bdb6c5521c..b629d61f18d 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.md index f54ccb38bf0..262efbe455d 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.md index e409060dc02..0193fc63d82 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.md index 92b7eb150a7..94d0938f6b6 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.md index 7f135a974e8..5951fea20ac 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.md index 7a689c3e57e..d2e182f2217 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.md index 7e603f715b5..2b41764bb9e 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.md index d279736a2b2..c299d9b6355 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.md index 8fab418b298..0798b148701 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.md index 282095c74cb..de0fb2b4521 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -182,7 +182,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.md index 122b7403b00..44fd8543bff 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.md index 0f31e7171c9..69af2ff3140 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -158,7 +158,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.md index 61c961b49fb..cbf4d509736 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.md index f4a19b5fd13..bf6b0b2ffcc 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.md index fe13e79e157..ed3195d8fed 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.md index 4f13a452cb1..e049ee55e45 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.md index f1509bc5b4d..e8d343a3b0b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -156,7 +156,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.md index efa24787b24..eaae5a227fc 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant(duration, amp, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -74,7 +74,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Constant.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -98,7 +98,7 @@ Return True iff the instruction is parameterized. -`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Constant.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.md index ccec7dae295..8cc976325af 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -90,7 +90,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Drag.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -114,7 +114,7 @@ Return True iff the instruction is parameterized. -`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Drag.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.md index 71891b1e1c5..503517f0a37 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -79,7 +79,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Gaussian.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -103,7 +103,7 @@ Return True iff the instruction is parameterized. -`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`Gaussian.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.md index 28235a7cc2b..c1b037506d5 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse` @@ -100,7 +100,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`GaussianSquare.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -124,7 +124,7 @@ Return True iff the instruction is parameterized. -`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") +`GaussianSquare.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.md index c88d2ad2ee8..c3727e2db2f 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.md index 092fd331074..95a15126a0f 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.md index f92b49a3b28..bcd25976bb5 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -40,7 +40,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -62,7 +62,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.md index a4ec79ffe46..523e605c02c 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.md index fec0b17a0d1..63d1709083e 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.md index bfb87982809..ebfa94974e9 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Bases: `qiskit.pulse.transforms.alignments.AlignmentKind` @@ -26,7 +26,7 @@ Create new context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.add_implicit_acquires.md index 84d86e4e5ce..a85c2b8ea9c 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.align_measures.md index b5c0ddccadc..f7a964675b6 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_dag.md index ab538bfba45..d8a5f9f1984 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_schedule.md index 280beccb66d..dadb0739eb0 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.compress_pulses.md index 49a6afe3a6f..36c8cc58c63 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.flatten.md index 354ebae4494..ca7f50f8ddc 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.inline_subroutines.md index 671870a6921..fbb0d1b670f 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.pad.md index 908d9720833..e19cd141a6b 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_directives.md index 96d4300d742..bedc1f0adb5 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_trivial_barriers.md index 0c432ca8327..5a24f4ce9e8 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.36/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.36/qiskit.pulse.transforms.target_qobj_transform.md index 116aa3591fc..df9d8e5d391 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.md index 3bfb5dbc4a5..5f7ad88749b 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.36/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.36/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.36/qiskit.qasm.Qasm.md index bf1c657b9ed..f641bac6cc9 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.36/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.36/qiskit.qasm.QasmError.md index 7cf5ea64990..75ed0133960 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.36/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.md index e4b71b68864..3cab110918d 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.36/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.md index 1636b919c06..41e0a2b84c8 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.36/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.md b/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.md index d3e15696846..6b45938f666 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.md +++ b/docs/api/qiskit/0.36/qiskit.qasm3.Exporter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.Exporter -`Exporter(includes=('stdgates.inc'), basis_gates=('U'), disable_constants=False, alias_classical_registers=False, indent=' ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc'), basis_gates=('U'), disable_constants=False, alias_classical_registers=False, indent=' ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ QASM3 expoter main class. -`Exporter.dump(circuit, stream)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") +`Exporter.dump(circuit, stream)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, dumping the result to a file or text stream. @@ -38,7 +38,7 @@ Convert the circuit to QASM 3, dumping the result to a file or text stream. -`Exporter.dumps(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") +`Exporter.dumps(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, returning the result as a string. diff --git a/docs/api/qiskit/0.36/qiskit.qasm3.dump.md b/docs/api/qiskit/0.36/qiskit.qasm3.dump.md index 106af24c5af..c57416a0fb4 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm3.dump.md +++ b/docs/api/qiskit/0.36/qiskit.qasm3.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dump -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. diff --git a/docs/api/qiskit/0.36/qiskit.qasm3.dumps.md b/docs/api/qiskit/0.36/qiskit.qasm3.dumps.md index ae9babda8fb..12a77f3a97a 100644 --- a/docs/api/qiskit/0.36/qiskit.qasm3.dumps.md +++ b/docs/api/qiskit/0.36/qiskit.qasm3.dumps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dumps -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.md index 66c94664568..c96e3315016 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.md index 959da95f30c..e403149ff85 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.md index 83271dddaad..ee3760cc166 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.md index f94142dcaa4..9319838522f 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.md index a4b79ebcb21..f80166ebdc6 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.md index ecdbee859d5..ceb39f813e4 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.md index d51b752badb..947ec78baf8 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.md index a64ace23b28..8faf5129afe 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.md index 00b96eaf98d..79ee7127c61 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.md index d0db1ec0e56..af4e2acdc64 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.md index 57453d78ee4..25a239a39a9 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.md index 8344aa4bb10..6c222b1b2cd 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.md index b762ea626f8..e9c6cf4fe89 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.36/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.36/qiskit.qobj.Qobj.md index b222d8df347..a66a40bb9df 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.md index c1feee6bf68..3861acdf1fe 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.md index 9f0afefc340..6def63cc9a4 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.md index 91872f2e84a..a74bde804a2 100644 --- a/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.36/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.36/qiskit.qpy.dump.md b/docs/api/qiskit/0.36/qiskit.qpy.dump.md index 2f5234ba0d0..8eb0e331e71 100644 --- a/docs/api/qiskit/0.36/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.36/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(circuits, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") +`dump(circuits, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.36/qiskit.qpy.load.md b/docs/api/qiskit/0.36/qiskit.qpy.load.md index c200937c2bb..6ebc6eb2852 100644 --- a/docs/api/qiskit/0.36/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.36/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.md index 31d34e2d1a5..58f666bf093 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -244,7 +244,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -291,7 +291,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -299,7 +299,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -307,7 +307,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -315,7 +315,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.md index df40b285eed..385f69375e1 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -261,7 +261,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.md index 2e6f3f0ffbb..4b7b7cc49cf 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -269,7 +269,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.md index ad0d17612f7..022a9d3e51b 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -152,7 +152,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -174,7 +174,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -198,7 +198,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -206,7 +206,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -264,7 +264,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -330,7 +330,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -356,7 +356,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -379,7 +379,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -387,7 +387,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -395,7 +395,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -403,7 +403,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -411,7 +411,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.md index a266f060e99..bb8ee4738ce 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.md index 66483628c72..ae2d77071d4 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -179,7 +179,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -265,7 +265,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.md index e6885700d60..e7d23bdeb56 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.md index 4716125ae90..4fb9d73cc7b 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -127,7 +127,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -149,7 +149,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -171,7 +171,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a :class\`.QuantumCircuit\` @@ -197,7 +197,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -233,7 +233,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -249,7 +249,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -299,7 +299,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -317,7 +317,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -343,7 +343,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -351,7 +351,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -359,7 +359,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.md index 1ac34bab986..c7101c6a327 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -269,7 +269,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.md index 47b71583fa1..2b61bc4aac7 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -109,7 +109,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -117,7 +117,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -138,7 +138,7 @@ bool -`Pauli.append_paulis(paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.append_paulis(paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Append pauli at the end. @@ -159,7 +159,7 @@ self -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -180,7 +180,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -213,7 +213,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -253,7 +253,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.delete_qubits(indices)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete_qubits(indices)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Delete pauli at the indices. @@ -275,7 +275,7 @@ self -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -297,7 +297,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -317,7 +317,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -347,7 +347,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -369,7 +369,7 @@ is the current Pauli, and $b$ is the other Pauli. -`static Pauli.from_label(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.from_label(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Construct a Pauli from a string label. @@ -404,7 +404,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -429,7 +429,7 @@ the resulting Pauli with the entries inserted. -`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert_paulis(indices=None, paulis=None, pauli_labels=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Insert or append pauli to the targeted indices. @@ -463,7 +463,7 @@ self -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -471,7 +471,7 @@ Return the inverse of the Pauli. -`Pauli.kron(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.kron(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Kronecker product of two paulis. @@ -503,7 +503,7 @@ Return tuple of output dimension for specified subsystems. -`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.pauli_single(num_qubits, index, pauli_label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. @@ -549,7 +549,7 @@ the n-times composed operator. -`classmethod Pauli.random(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.random(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Return a random Pauli on number of qubits. @@ -598,7 +598,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -614,7 +614,7 @@ Set the max number of Pauli characters to display before truncation/ -`static Pauli.sgn_prod(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`static Pauli.sgn_prod(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Multiply two Paulis and track the phase. @@ -639,7 +639,7 @@ the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -665,7 +665,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -673,7 +673,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -693,7 +693,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -713,7 +713,7 @@ array -`Pauli.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). @@ -731,7 +731,7 @@ scipy.sparse.csr\_matrix -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. @@ -739,7 +739,7 @@ Return the transpose of each Pauli in the list. -`Pauli.update_x(x, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_x(x, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire x. @@ -766,7 +766,7 @@ self -`Pauli.update_z(z, indices=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.update_z(z, indices=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") DEPRECATED: Update partial or entire z. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.md index 81670f0464e..86f15f10963 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -445,7 +445,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -473,7 +473,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -481,7 +481,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -499,7 +499,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -579,7 +579,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -642,7 +642,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -666,7 +666,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -695,7 +695,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -725,7 +725,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -733,7 +733,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.md index a8d559db92a..5e3d0201e3d 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.md index 573b490902e..dc04d001ba0 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.md index 56103f28f92..7fe5a82e404 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -112,7 +112,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -142,7 +142,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -158,7 +158,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -204,7 +204,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -230,7 +230,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -238,7 +238,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -246,7 +246,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.md index ca340631cd5..75a95a2ea5b 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -50,7 +50,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -82,7 +82,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -114,7 +114,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -151,7 +151,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -171,7 +171,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -193,7 +193,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -230,7 +230,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -258,7 +258,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -310,7 +310,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -331,7 +331,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -349,7 +349,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -429,7 +429,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -450,7 +450,7 @@ the simplified SparsePauliOp operator. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -478,7 +478,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -504,7 +504,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -526,7 +526,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -546,7 +546,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -554,7 +554,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.md index b845e19e728..f3e3e272352 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.md index f8ae3670bc5..eea60b325ce 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.md index cd3479489fa..0f818c1c094 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ $$ -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.md index 772f0ccd1b0..9600c56ef4e 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -143,7 +143,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -181,7 +181,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -267,7 +267,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -323,7 +323,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.md index 3c93434e13c..3286293e1a7 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -137,7 +137,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -261,7 +261,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -317,7 +317,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.md index f237b703ad1..4959639e60a 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.md index 18ad9e29f9e..d90f6833c71 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.36/qiskit.quantum_info.average_gate_fidelity.md index 743e56295f5..6451c0c7acb 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.36/qiskit.quantum_info.concurrence.md index 29db8f79c68..4e6d6c31f3c 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.36/qiskit.quantum_info.decompose_clifford.md index 0977b2af9af..f39e4af5a53 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.36/qiskit.quantum_info.diamond_norm.md index cc78e8799a7..7fbf9407043 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.36/qiskit.quantum_info.entanglement_of_formation.md index a2de55c7530..b6843c760f0 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.36/qiskit.quantum_info.entropy.md index 1b2fa0bbfcb..fdbc923b866 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.36/qiskit.quantum_info.gate_error.md index f46ff5e927c..b83792c2652 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_distance.md index 3275e7abd45..e173ce3398f 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_fidelity.md index 4b0957faede..12604c2e554 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.36/qiskit.quantum_info.mutual_information.md index 5fd548fd56c..de3d983f801 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.36/qiskit.quantum_info.partial_trace.md index 2f122e68f68..47e818f0e16 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_basis.md index f454f161bae..6f93279cc5e 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_group.md b/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_group.md index ec2e36713f9..ce8f3bfb931 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_group.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.pauli_group.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_group -`pauli_group(number_of_qubits, case='weight')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/pauli.py "view source code") +`pauli_group(number_of_qubits, case='weight')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/pauli.py "view source code") DEPRECATED: Return the Pauli group with 4^n elements. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.36/qiskit.quantum_info.process_fidelity.md index 53261f5d34c..afeb05cd471 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.36/qiskit.quantum_info.purity.md index 6cb55a03680..b32cb1222a0 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_clifford.md index 68637c8285e..a47985f2545 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_cnotdihedral.md index 4e3c02091df..588f376c9a0 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_density_matrix.md index 536c4f7262e..fe8f537855f 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_hermitian.md index fdce5351522..78882f0faca 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli.md index 63221c8dc51..b767750dbfe 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_list.md index 1784056c15c..af0e32a6bb0 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_table.md index b7d7da6acf0..0859b0588a3 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_quantum_channel.md index df8079f5c1e..3e77e5781d8 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_stabilizer_table.md index 73b883918d9..35127b648ef 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_statevector.md index 60937878564..391daa31dfd 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.36/qiskit.quantum_info.random_unitary.md index 0f1d88370af..f1d163a029e 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.36/qiskit.quantum_info.shannon_entropy.md index 9b062321bba..45d32f196aa 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.36/qiskit.quantum_info.state_fidelity.md index ec0aa4301fd..a564457ae3a 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.md index e391e77a691..d74d84c37cf 100644 --- a/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.36/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.md index c1889a2e744..91218d440f9 100644 --- a/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.36/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.36/qiskit.result.Counts.md b/docs/api/qiskit/0.36/qiskit.result.Counts.md index fc4e7866616..33c59e99530 100644 --- a/docs/api/qiskit/0.36/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.36/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.md index 3e827ea8614..34d704c558a 100644 --- a/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.36/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: `qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator` @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.md index 6e6886cbd7c..5fe8f7929ce 100644 --- a/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.36/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.md index 7d41423a523..e1063a0a99c 100644 --- a/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.36/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.36/qiskit.result.Result.md b/docs/api/qiskit/0.36/qiskit.result.Result.md index 19c1b7f74f6..f03c65acce7 100644 --- a/docs/api/qiskit/0.36/qiskit.result.Result.md +++ b/docs/api/qiskit/0.36/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.36/qiskit.result.ResultError.md b/docs/api/qiskit/0.36/qiskit.result.ResultError.md index 1efd25bf48f..dc06796d815 100644 --- a/docs/api/qiskit/0.36/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.36/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.36/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.36/qiskit.result.marginal_counts.md index 05ec33193a3..3b4be4c8a38 100644 --- a/docs/api/qiskit/0.36/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.36/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.md index 4315f042b2e..1494be0bfa9 100644 --- a/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.md index bdd4f17b1a0..e20450dd744 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.36/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.md index 6a92b6585a6..de7b7eeb472 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.36/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.md index d1e0b23aa82..cbd54998e37 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.36/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.md index 7ec13da4e80..6b39f743318 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.36/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: `qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis` diff --git a/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.md index c9fd4038d82..861cfd32275 100644 --- a/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.36/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: `qiskit.synthesis.evolution.product_formula.ProductFormula` @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.36/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.36/qiskit.tools.backend_monitor.md index c5b36d2a0df..6895fb6a6ce 100644 --- a/docs/api/qiskit/0.36/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.36/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.36/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.36/qiskit.tools.backend_overview.md index 75bc0fce12e..6ea5e1bf948 100644 --- a/docs/api/qiskit/0.36/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.36/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.36/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.36/qiskit.tools.job_monitor.md index 8ed6c5299b4..e34c9c6bc0c 100644 --- a/docs/api/qiskit/0.36/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.36/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.36/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.36/qiskit.tools.parallel_map.md index e891170e10f..83ebb9b365e 100644 --- a/docs/api/qiskit/0.36/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.36/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.md index 81030dd67a3..5ea154e3309 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.md index 427fda69abb..fdf1491bb70 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `qiskit.transpiler.runningpassmanager.FlowController` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.md index 12943ef9200..eb82ac13e35 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -112,7 +112,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -124,7 +124,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -136,7 +136,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -161,7 +161,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -186,7 +186,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -208,7 +208,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -220,7 +220,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -232,7 +232,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -248,7 +248,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -258,7 +258,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -266,7 +266,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -274,7 +274,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -284,7 +284,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -308,7 +308,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -333,7 +333,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -341,7 +341,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.md index b4fb26ec3c0..00bd523209c 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `qiskit.transpiler.runningpassmanager.FlowController` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.md index 2830ad0c600..4363c3799b9 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.md index 1a856121153..61a86290495 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.md index a5c2c89abf4..d126ec68c55 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.md index 9b553bd16f6..9ae1b7a6e94 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.md index 89b3bf44857..d5bb7feab11 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.36/qiskit.transpiler.Layout.md index 6a34db78289..5ba710d9a46 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.md index 92a274256eb..abc7940d58f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.md index d04411ea8fd..f3f4bfb591c 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.md index c8cc48fa125..c7671214b16 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.Target.md b/docs/api/qiskit/0.36/qiskit.transpiler.Target.md index 976e90bc72e..1e151f56255 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -135,7 +135,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -162,7 +162,7 @@ for this target. -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -186,7 +186,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -208,7 +208,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -248,7 +248,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -264,7 +264,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -285,19 +285,19 @@ bool -`Target.items() → a set-like object providing a view on D’s items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D’s items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D’s keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D’s keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -317,7 +317,7 @@ The Instruction instance corresponding to the name -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -341,7 +341,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -365,7 +365,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -385,7 +385,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -401,7 +401,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -440,7 +440,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -458,7 +458,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D’s values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D’s values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.md index aec954902f2..25b45797158 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.md index addd02ebe09..c6b79a5d11b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.md index c3d28733064..d12ba1f95ec 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.md index d903f5efeb6..aa197323f0f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index dbbaab3644b..8cc505a3ebe 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.md index 1082ca56591..1b3e1c08ff1 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 189c9690bc3..56d559aec04 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.md index ec17d69d288..16f2126a4a2 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.md index 11d8232d0dc..f418bf6420b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.md index 285dea8ab05..cfcd3a5e1dc 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 7c7175a1fe3..36547080e34 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.md index ff653b61b62..ead76584e3e 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.md index a0cb9ae5069..5f938f3a8fe 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.md index 354711e5923..c0e24fcac39 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.md index 4e0e607f617..289e8123be6 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.md index 4d8d3f516e1..b935118e4e1 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.gate_direction.GateDirection` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.md index 075d2a510f8..018594a81d5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: `qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.md index 7859d8e2587..2699143983f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.md index 5c36fd7ab95..68a0d2166cc 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.md index f19265a3260..7c49ad395c5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.md index fe01b0339aa..4cb56c79b25 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.md index 00f9264a5d3..ce50aee72e2 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`CollectLinearFunctions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Run the CollectLinearFunctions pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.md index a0f0b79a702..0d10ddef4aa 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.md index 9ac57f76fe5..8b23bb43eb1 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.md index 429640aefca..c7ef174c586 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.md index c799780945a..0e5b49ca2bf 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.md index 83aec8cef71..bea6c9ba68d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.md index 168657fdcd0..c2dc24314e6 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.md index f00cf4b1455..cb3e52ece3d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.md index 3c0f002e94b..8a472975afb 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index a4a70875de4..7fe5ca8b5ba 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.md index 20f94119d12..6777dbfac44 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.md index 1bde1c9dca0..23afd2ad006 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.md index f4ffe378e21..0d2a268a964 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None, gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None, gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.md index 471a653d254..971607ac8a9 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.md index eaeca2edce5..ecf226cb9d0 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.md index 039580c35dd..7ff50310041 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 3874d403c99..ac189798e53 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.md index 0e8711c059a..f25ac71d650 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.md index 45978564b0f..4751054217f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.md index a635a3ae6b1..fa210844281 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.md index 7e1a76e296c..4f180fdf0d3 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.md index fb0d98b615e..5901ba8cc3f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.md index 096100f9e37..c63bb5a9ccf 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.md index 2023d671ac0..b277d8f84cc 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.md index 13eca66fb3b..eff13a3fea5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.md index 1f3afec1d03..1856eadc3d3 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index 7ea56e7da0c..1207e6811ee 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsSynthesis pass on dag. :type dag: `DAGCircuit` :param dag: input dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 26a48c85e2d..24d1258851b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: `DAGCircuit` :param dag: input dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.md index 4e218a53eb0..7d9ed484de4 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 4698fd82b34..ebad648872f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 62f9cf785c5..95b542004e7 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.md index fdb3e5c01e1..2700abb1199 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.md index e94ef5e85c7..31ca29f6cab 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 128e2a28f48..e6efc773084 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 02e96419fc2..0e15fcc43b2 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.md index 7330c1f857a..531b41e559c 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.md index b94c251a188..299597fb755 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.md index 18ce08448a8..058caff9e5d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 5716bccf7ab..2158551e79a 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -67,7 +67,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") **Parameters** @@ -113,7 +113,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 3a6ede86791..7d82a0230dc 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho(backend=None, instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder` @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.md index 5554cfa6ae8..e95ce0d4690 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index b83c8752df7..92970067a0f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.md index a0fc03592b6..93cbbeab423 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.md index 733ef8a224e..dcbbbed684b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.md index 4c90aaa04ca..81d4ce640ab 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.md index 1640da95a35..9ba101454ec 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.md index b8b9b7f9cf7..d58045cc19b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.md index 4952966c44b..de03a4b3540 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.md index 41450465317..b74b23ef0df 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.md index 464e249438a..a34e2a372b5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.md index 3d4907b77a3..3a7b7e241d5 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.md index 29d7dad5414..cbbbd3558b3 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.md index a72ef2e9acd..cbf39fbc01b 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.md index bc9eaba714c..369c4a9cb74 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.md index 134bdd21427..bef218496b8 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -30,7 +30,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 14404b1eb1e..7fff3a5b37d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.md index 3ef97601681..e82fa917c6f 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: `qiskit.transpiler.basepasses.TransformationPass` @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.md index 6fc15eb9c95..fde883f98d4 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -53,7 +53,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.md index da01f56783e..2f2d99ba352 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.md index 4fd55a9b2d2..b22bbbf6ead 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: `qiskit.transpiler.basepasses.AnalysisPass` @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 021db1f1f4e..5b11fd143be 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index fb972de2417..431e9572979 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 74f5558bd59..175ef4e0dda 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index 00841d05770..441c2da8f35 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index ccc9820880a..54eeb71b857 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 169339ef01b..a9e21800cce 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index beb2e5129b9..0ac038c2e46 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.md index 4de5db61789..ab689348848 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 47d942bed95..9c5c40bef2d 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index fab24a87872..911733981ab 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`, `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 72a4bc1dc1a..5949c561bda 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 12556606650..9460784219c 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit` @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 9438fab61d5..88b032331e9 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`, `abc.ABC` diff --git a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 12b3a2f0b89..dff32b1d0bc 100644 --- a/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.36/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: `qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective` @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.md index 211feb94b05..81a6ab8d26f 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.36/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.36/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.36/qiskit.utils.apply_prefix.md index 77530e0e067..d65bab50be1 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.36/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.36/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.36/qiskit.utils.deprecate_arguments.md index 41ecce7f7a5..51b8668854e 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.36/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.36/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.36/qiskit.utils.deprecate_function.md index ed1afa5272a..a66303bb98d 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.36/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.36/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.36/qiskit.utils.detach_prefix.md index 2ac440f6afb..9792d18f8c6 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.36/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.36/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.36/qiskit.utils.get_entangler_map.md index 991d8200c5b..a61e3779aa4 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.36/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.36/qiskit.utils.has_aer.md b/docs/api/qiskit/0.36/qiskit.utils.has_aer.md index fedc8c0f522..ef03b3dcfba 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.36/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.36/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.36/qiskit.utils.has_ibmq.md index ae9eeeff789..72753605a9f 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.36/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.36/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.36/qiskit.utils.is_main_process.md index bad9d67a506..4d6a66b2bef 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.36/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.36/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.36/qiskit.utils.local_hardware_info.md index 2e98fd9500c..1da150a8fad 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.36/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.md index af066c9d2df..31fce106478 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.36/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.md index 14368752d0b..a0a41afc656 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.36/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.36/qiskit.utils.name_args.md b/docs/api/qiskit/0.36/qiskit.utils.name_args.md index cf94b53dc53..54477b8bdbc 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.36/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.36/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.36/qiskit.utils.summarize_circuits.md index 9ec49487698..18652050f47 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.36/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.36/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.36/qiskit.utils.validate_entangler_map.md index eb47327be74..0e37a9306af 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.36/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.36/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.36/qiskit.utils.wrap_method.md index fe155fc0aee..1df9c6ec55e 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.36/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.md index 868a580c9e7..4abab6a4691 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.36/qiskit.visualization.array_to_latex.md index d7b6a15931c..0639e2a9628 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.36/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.36/qiskit.visualization.circuit_drawer.md index cbbc618410e..28da4cdd280 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.36/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.36/qiskit.visualization.dag_drawer.md index 5f7c842e4fa..e9870e9312b 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.36/qiskit.visualization.pass_manager_drawer.md index 1a8e611b17b..dbdbc0cef3d 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_multivector.md index 7bb1cc92786..1c0bbfcff80 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_vector.md index 9e9eebc6c79..83ad65e18ab 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_circuit_layout.md index a0078076376..49166ce114c 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_coupling_map.md index 0327d849a1b..1134408c3b3 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_error_map.md index 50b9b3373ce..2122bcdc64c 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_gate_map.md index 86c4eaa5022..ff3d2b54d12 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_histogram.md index c2c36e3e79e..aaa3e0f239f 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_city.md index 97abfdb9f9f..e03fce1fc74 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_hinton.md index d614db797ab..fc7f66c003f 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_paulivec.md index 8def4500338..7eb22111ff5 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_qsphere.md index fe5483af7ed..4e7b92c8ade 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.md index ae20acd7698..d867c6d6b10 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.md index c2e42c8791f..b4abd0409d5 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.md index bf18173abd4..5b8c1afb6ae 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.draw.md index 3e5f06bf3a8..0ac994594a7 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.md index 5acbcf56777..7203a608999 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.36/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.36/qiskit.visualization.timeline.draw.md index f8a4e70be31..5c74beb7089 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.36/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.36/qiskit.visualization.visualize_transition.md index c91ccce2c44..da895a98770 100644 --- a/docs/api/qiskit/0.36/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.36/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.36/synthesis_aqc.md b/docs/api/qiskit/0.36/synthesis_aqc.md index 470631311c2..b5f1163d1e5 100644 --- a/docs/api/qiskit/0.36/synthesis_aqc.md +++ b/docs/api/qiskit/0.36/synthesis_aqc.md @@ -127,7 +127,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.36/utils.md b/docs/api/qiskit/0.36/utils.md index eff3abbd73e..0b581e9027c 100644 --- a/docs/api/qiskit/0.36/utils.md +++ b/docs/api/qiskit/0.36/utils.md @@ -107,7 +107,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -228,7 +228,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -242,7 +242,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From ab6b5d8ef6b989e23f9714379127126905e19786 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:42:23 +0100 Subject: [PATCH 17/41] Regenerate qiskit 0.37.2 --- docs/api/qiskit/0.37/execute.md | 2 +- docs/api/qiskit/0.37/pulse.md | 8 +- .../0.37/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.37/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.37/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.37/qiskit.algorithms.Grover.md | 8 +- .../0.37/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.37/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.37/qiskit.algorithms.QAOA.md | 2 +- .../0.37/qiskit.algorithms.RealEvolver.md | 4 +- .../api/qiskit/0.37/qiskit.algorithms.Shor.md | 8 +- .../0.37/qiskit.algorithms.ShorResult.md | 2 +- .../0.37/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.37/qiskit.algorithms.VQD.md | 14 +- docs/api/qiskit/0.37/qiskit.algorithms.VQE.md | 14 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 8 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- .../0.37/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.37/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.37/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.37/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.37/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.37/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 6 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.37/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.37/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- .../0.37/qiskit.algorithms.optimizers.TNC.md | 2 +- .../0.37/qiskit.algorithms.optimizers.UMDA.md | 6 +- .../qiskit/0.37/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.37/qiskit.assembler.disassemble.md | 2 +- .../0.37/qiskit.circuit.AncillaQubit.md | 2 +- .../0.37/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.37/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.37/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.37/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.37/qiskit.circuit.Clbit.md | 2 +- .../0.37/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.37/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.37/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.37/qiskit.circuit.Delay.md | 12 +- .../0.37/qiskit.circuit.EquivalenceLibrary.md | 12 +- .../qiskit/0.37/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.37/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.37/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.37/qiskit.circuit.Instruction.md | 26 +- .../0.37/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.37/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.37/qiskit.circuit.ParameterVector.md | 6 +- .../0.37/qiskit.circuit.QuantumCircuit.md | 230 +++++++++--------- .../0.37/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.37/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.37/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.AND.md | 2 +- .../0.37/qiskit.circuit.library.Barrier.md | 8 +- .../0.37/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.37/qiskit.circuit.library.C3XGate.md | 6 +- .../0.37/qiskit.circuit.library.C4XGate.md | 6 +- .../0.37/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.37/qiskit.circuit.library.CHGate.md | 4 +- .../0.37/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.37/qiskit.circuit.library.CRXGate.md | 4 +- .../0.37/qiskit.circuit.library.CRYGate.md | 4 +- .../0.37/qiskit.circuit.library.CRZGate.md | 4 +- .../0.37/qiskit.circuit.library.CSXGate.md | 2 +- .../0.37/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.37/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.37/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.37/qiskit.circuit.library.CUGate.md | 4 +- .../0.37/qiskit.circuit.library.CXGate.md | 6 +- .../0.37/qiskit.circuit.library.CYGate.md | 4 +- .../0.37/qiskit.circuit.library.CZGate.md | 4 +- .../0.37/qiskit.circuit.library.DCXGate.md | 2 +- .../0.37/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.37/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.GRZ.md | 2 +- .../0.37/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.37/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.37/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.37/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.37/qiskit.circuit.library.MCMT.md | 6 +- .../0.37/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.37/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.37/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.37/qiskit.circuit.library.MSGate.md | 2 +- .../0.37/qiskit.circuit.library.Measure.md | 4 +- .../0.37/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.37/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.37/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.37/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.37/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.37/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.37/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.37/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.37/qiskit.circuit.library.RGate.md | 4 +- .../0.37/qiskit.circuit.library.RVGate.md | 6 +- .../0.37/qiskit.circuit.library.RXGate.md | 6 +- .../0.37/qiskit.circuit.library.RXXGate.md | 4 +- .../0.37/qiskit.circuit.library.RYGate.md | 6 +- .../0.37/qiskit.circuit.library.RYYGate.md | 4 +- .../0.37/qiskit.circuit.library.RZGate.md | 6 +- .../0.37/qiskit.circuit.library.RZXGate.md | 4 +- .../0.37/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.37/qiskit.circuit.library.Reset.md | 4 +- .../0.37/qiskit.circuit.library.SGate.md | 4 +- .../0.37/qiskit.circuit.library.SXGate.md | 6 +- .../0.37/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.37/qiskit.circuit.library.SdgGate.md | 4 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.37/qiskit.circuit.library.SwapGate.md | 6 +- .../0.37/qiskit.circuit.library.TGate.md | 4 +- .../0.37/qiskit.circuit.library.TdgGate.md | 4 +- .../0.37/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.37/qiskit.circuit.library.U1Gate.md | 6 +- .../0.37/qiskit.circuit.library.U2Gate.md | 4 +- .../0.37/qiskit.circuit.library.U3Gate.md | 6 +- .../0.37/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.37/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.37/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 4 +- .../qiskit.circuit.library.XXPlusYYGate.md | 4 +- .../0.37/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.37/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.37/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.37/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.37/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.37/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.37/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.37/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.37/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.37/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.37/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.37/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.37/qiskit.compiler.transpile.md | 2 +- .../0.37/qiskit.converters.ast_to_dag.md | 2 +- .../0.37/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.37/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.37/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.37/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.37/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.37/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.37/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.37/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.37/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.37/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.37/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.37/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.37/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.37/qiskit.extensions.Snapshot.md | 8 +- .../0.37/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.37/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.37/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.37/qiskit.extensions.UCRZGate.md | 2 +- .../0.37/qiskit.extensions.UnitaryGate.md | 16 +- .../qiskit/0.37/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.37/qiskit.opflow.OpflowError.md | 2 +- .../0.37/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.37/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.37/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.37/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.37/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.37/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.37/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.37/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.37/qiskit.opflow.gradients.QFI.md | 4 +- .../0.37/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.37/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.37/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.37/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.37/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 +-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.37/qiskit.opflow.state_fns.StateFn.md | 40 +-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../0.37/qiskit.primitives.BaseEstimator.md | 4 +- .../0.37/qiskit.primitives.BaseSampler.md | 4 +- .../0.37/qiskit.primitives.Estimator.md | 4 +- .../0.37/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.37/qiskit.primitives.Sampler.md | 4 +- .../0.37/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.37/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.37/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.37/qiskit.providers.BackendV2.md | 16 +- docs/api/qiskit/0.37/qiskit.providers.Job.md | 2 +- .../qiskit/0.37/qiskit.providers.JobError.md | 2 +- .../qiskit/0.37/qiskit.providers.JobStatus.md | 2 +- .../0.37/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.37/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.37/qiskit.providers.Options.md | 8 +- .../qiskit/0.37/qiskit.providers.Provider.md | 2 +- .../0.37/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.37/qiskit.providers.QubitProperties.md | 2 +- .../0.37/qiskit.providers.aer.AerError.md | 2 +- .../0.37/qiskit.providers.aer.AerProvider.md | 6 +- .../0.37/qiskit.providers.aer.AerSimulator.md | 14 +- .../qiskit.providers.aer.PulseSimulator.md | 8 +- .../qiskit.providers.aer.QasmSimulator.md | 12 +- ...skit.providers.aer.StatevectorSimulator.md | 8 +- .../qiskit.providers.aer.UnitarySimulator.md | 8 +- ...iskit.providers.aer.extensions.Snapshot.md | 8 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 2 +- ...aer.extensions.SnapshotExpectationValue.md | 4 +- ...rs.aer.extensions.SnapshotProbabilities.md | 2 +- ...iders.aer.extensions.SnapshotStabilizer.md | 2 +- ...ders.aer.extensions.SnapshotStatevector.md | 2 +- .../0.37/qiskit.providers.aer.jobs.AerJob.md | 16 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 20 +- ...it.providers.aer.library.SaveAmplitudes.md | 2 +- ...iders.aer.library.SaveAmplitudesSquared.md | 2 +- ...skit.providers.aer.library.SaveClifford.md | 2 +- ...providers.aer.library.SaveDensityMatrix.md | 2 +- ...viders.aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...ders.aer.library.SaveMatrixProductState.md | 2 +- ...providers.aer.library.SaveProbabilities.md | 2 +- ...iders.aer.library.SaveProbabilitiesDict.md | 2 +- ...it.providers.aer.library.SaveStabilizer.md | 2 +- .../qiskit.providers.aer.library.SaveState.md | 2 +- ...t.providers.aer.library.SaveStatevector.md | 2 +- ...oviders.aer.library.SaveStatevectorDict.md | 2 +- ...iskit.providers.aer.library.SaveSuperOp.md | 2 +- ...iskit.providers.aer.library.SaveUnitary.md | 2 +- ....providers.aer.library.SetDensityMatrix.md | 2 +- ...iders.aer.library.SetMatrixProductState.md | 2 +- ...kit.providers.aer.library.SetStabilizer.md | 2 +- ...it.providers.aer.library.SetStatevector.md | 2 +- ...qiskit.providers.aer.library.SetSuperOp.md | 2 +- ...qiskit.providers.aer.library.SetUnitary.md | 2 +- ...t.providers.aer.library.save_amplitudes.md | 2 +- ...ers.aer.library.save_amplitudes_squared.md | 2 +- ...kit.providers.aer.library.save_clifford.md | 2 +- ...oviders.aer.library.save_density_matrix.md | 2 +- ...ders.aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...s.aer.library.save_matrix_product_state.md | 2 +- ...roviders.aer.library.save_probabilities.md | 2 +- ...ers.aer.library.save_probabilities_dict.md | 2 +- ...t.providers.aer.library.save_stabilizer.md | 2 +- ...qiskit.providers.aer.library.save_state.md | 2 +- ....providers.aer.library.save_statevector.md | 2 +- ...iders.aer.library.save_statevector_dict.md | 2 +- ...skit.providers.aer.library.save_superop.md | 2 +- ...skit.providers.aer.library.save_unitary.md | 2 +- ...roviders.aer.library.set_density_matrix.md | 2 +- ...rs.aer.library.set_matrix_product_state.md | 2 +- ...it.providers.aer.library.set_stabilizer.md | 2 +- ...t.providers.aer.library.set_statevector.md | 2 +- ...iskit.providers.aer.library.set_superop.md | 2 +- ...iskit.providers.aer.library.set_unitary.md | 2 +- ...skit.providers.aer.noise.LocalNoisePass.md | 4 +- .../qiskit.providers.aer.noise.NoiseModel.md | 24 +- ...qiskit.providers.aer.noise.QuantumError.md | 24 +- ...qiskit.providers.aer.noise.ReadoutError.md | 24 +- ...providers.aer.noise.RelaxationNoisePass.md | 2 +- ...iders.aer.noise.amplitude_damping_error.md | 2 +- ...viders.aer.noise.coherent_unitary_error.md | 2 +- ....providers.aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...ders.aer.noise.device.gate_error_values.md | 2 +- ...ers.aer.noise.device.gate_length_values.md | 2 +- ...ders.aer.noise.device.gate_param_values.md | 2 +- ...s.aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../qiskit.providers.aer.noise.kraus_error.md | 2 +- ...providers.aer.noise.mixed_unitary_error.md | 2 +- .../qiskit.providers.aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- ...providers.aer.noise.phase_damping_error.md | 2 +- .../qiskit.providers.aer.noise.reset_error.md | 2 +- ...ders.aer.noise.thermal_relaxation_error.md | 2 +- ...it.providers.aer.pulse.PulseSystemModel.md | 10 +- ...roviders.aer.pulse.duffing_system_model.md | 2 +- ...it.providers.aer.utils.NoiseTransformer.md | 36 +-- ...iders.aer.utils.approximate_noise_model.md | 2 +- ...ers.aer.utils.approximate_quantum_error.md | 2 +- ...qiskit.providers.aer.utils.insert_noise.md | 2 +- ...t.providers.aer.utils.remap_noise_model.md | 2 +- ...oviders.aer.utils.transform_noise_model.md | 2 +- ...oviders.aer.utils.transpile_noise_model.md | 2 +- ...iders.aer.utils.transpile_quantum_error.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.37/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.37/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.37/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.37/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.37/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.37/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.37/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.37/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.37/qiskit.pulse.ScheduleBlock.md | 22 +- .../0.37/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.37/qiskit.pulse.builder.align_func.md | 2 +- .../0.37/qiskit.pulse.builder.align_left.md | 2 +- .../0.37/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.37/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.delay.md | 2 +- .../0.37/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.37/qiskit.pulse.builder.inline.md | 2 +- .../0.37/qiskit.pulse.builder.measure.md | 2 +- .../0.37/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.37/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.pad.md | 2 +- .../0.37/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.37/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.37/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.37/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.37/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.37/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.37/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.37/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.37/qiskit.pulse.instructions.Call.md | 6 +- .../0.37/qiskit.pulse.instructions.Delay.md | 4 +- .../0.37/qiskit.pulse.instructions.Play.md | 4 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.37/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.37/qiskit.pulse.library.Drag.md | 2 +- .../0.37/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- .../0.37/qiskit.pulse.library.Waveform.md | 4 +- .../qiskit/0.37/qiskit.pulse.library.cos.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.37/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.37/qiskit.pulse.library.sech.md | 2 +- .../0.37/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.37/qiskit.pulse.library.sin.md | 2 +- .../0.37/qiskit.pulse.library.square.md | 2 +- .../0.37/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.37/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.37/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.37/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.37/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.37/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.37/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.37/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.37/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.37/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.37/qiskit.qasm.QasmTerminalStyle.md | 2 +- docs/api/qiskit/0.37/qiskit.qasm3.Exporter.md | 6 +- docs/api/qiskit/0.37/qiskit.qasm3.dump.md | 2 +- docs/api/qiskit/0.37/qiskit.qasm3.dumps.md | 2 +- .../0.37/qiskit.qobj.GateCalibration.md | 6 +- .../0.37/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.md | 6 +- .../0.37/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.37/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.37/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.37/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.37/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.37/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.37/qiskit.qobj.Qobj.md | 2 +- .../0.37/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.37/qiskit.qobj.QobjHeader.md | 2 +- .../0.37/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.37/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.37/qiskit.qpy.load.md | 2 +- .../0.37/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.37/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.37/qiskit.quantum_info.Choi.md | 12 +- .../0.37/qiskit.quantum_info.Clifford.md | 32 +-- .../0.37/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.37/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.37/qiskit.quantum_info.Operator.md | 28 +-- .../qiskit/0.37/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.37/qiskit.quantum_info.Pauli.md | 38 +-- .../0.37/qiskit.quantum_info.PauliList.md | 54 ++-- .../0.37/qiskit.quantum_info.PauliTable.md | 40 +-- .../0.37/qiskit.quantum_info.Quaternion.md | 14 +- .../0.37/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.37/qiskit.quantum_info.SparsePauliOp.md | 42 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.37/qiskit.quantum_info.Statevector.md | 40 +-- .../0.37/qiskit.quantum_info.Stinespring.md | 14 +- .../0.37/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.37/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.37/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.37/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.37/qiskit.quantum_info.entropy.md | 2 +- .../0.37/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.37/qiskit.quantum_info.partial_trace.md | 2 +- .../0.37/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.37/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.37/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.37/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.37/qiskit.result.ProbDistribution.md | 6 +- .../0.37/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.37/qiskit.result.Result.md | 16 +- .../qiskit/0.37/qiskit.result.ResultError.md | 2 +- .../0.37/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.37/qiskit.result.marginal_memory.md | 2 +- .../0.37/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.37/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.37/qiskit.synthesis.ProductFormula.md | 2 +- .../0.37/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../0.37/qiskit.tools.backend_monitor.md | 2 +- .../0.37/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.37/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.37/qiskit.tools.parallel_map.md | 2 +- .../0.37/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.37/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.37/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.37/qiskit.transpiler.Layout.md | 30 +-- .../0.37/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.37/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 12 +- .../qiskit/0.37/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.37/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.37/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...ranspiler.passes.CollectLinearFunctions.md | 4 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- .../0.37/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.37/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 4 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- .../0.37/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.37/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.37/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.37/qiskit.transpiler.passes.Width.md | 4 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- .../0.37/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.37/qiskit.utils.apply_prefix.md | 2 +- .../0.37/qiskit.utils.deprecate_arguments.md | 2 +- .../0.37/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.37/qiskit.utils.detach_prefix.md | 2 +- .../0.37/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.37/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.37/qiskit.utils.has_ibmq.md | 2 +- .../0.37/qiskit.utils.is_main_process.md | 2 +- .../0.37/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 6 +- .../api/qiskit/0.37/qiskit.utils.name_args.md | 2 +- .../0.37/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.37/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.37/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.37/synthesis_aqc.md | 2 +- docs/api/qiskit/0.37/utils.md | 6 +- 1004 files changed, 2749 insertions(+), 2749 deletions(-) diff --git a/docs/api/qiskit/0.37/execute.md b/docs/api/qiskit/0.37/execute.md index a17746f7189..b985ccabdba 100644 --- a/docs/api/qiskit/0.37/execute.md +++ b/docs/api/qiskit/0.37/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.37/pulse.md b/docs/api/qiskit/0.37/pulse.md index 9dbeecd1d35..beacdcaa24b 100644 --- a/docs/api/qiskit/0.37/pulse.md +++ b/docs/api/qiskit/0.37/pulse.md @@ -66,7 +66,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -226,7 +226,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -668,7 +668,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.md index b0fed3020bb..a9a7ecc5fa6 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.md index 9df139d438c..8d0e3536038 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.md index b664511d8b1..73182e78add 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.md index 03251e09098..0d3c0c02e88 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.md index 83121015046..ee7fa67d9ea 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.md index 4d81fb54c0c..9bebb360d87 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.md index 509c33d52f0..1b5cf41eb84 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.md index d3ed7f38f61..aa7bcebadbd 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.md index d8ba140394b..f30112d54bd 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.md index 0eafb70f99d..323e7603d22 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.md index 1fc10d8edc4..fbe6103cd3f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state, aux_operators=None, truncation_threshold=1e-12, t_param=None, hamiltonian_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state, aux_operators=None, truncation_threshold=1e-12, t_param=None, hamiltonian_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.md index 1c8ede9bff9..c124fc4f563 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.md index 89f158be231..9e54c94e6a8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.md index adb1f75b096..81ee1ea3c56 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.37/qiskit.algorithms.Grover.md index 556ff14562e..500a97f2ba8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -93,7 +93,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -118,7 +118,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -144,7 +144,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.md index 424fe1346fd..aa788a7cdd9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.md index 7dc61fa73dd..b9d37191884 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 0cc2ae79c54..2ad720e3034 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.md index 3565dac9725..5d4221bc7d6 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.md index 60135699e68..52fb555bfef 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 61b110204fd..3f40c3f11d9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.md index 95a395f7dd1..c03d30ab92f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 76f8483cbe9..673962c144a 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5104226d362..cd72b04f885 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.md index 9152055b8b2..eac4113da04 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.md index 121b3bcc29b..bebfbabfdbd 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.md index 85a3ce17fda..d7ef5fc96c7 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.md index b2cbe61d186..2ba42040301 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.md index ef3376fa89b..9a62f0d81d0 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.md index 07a57d9d773..430d452c695 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.md index 2b5b3901ae5..b534c08d4cf 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.md index 1fb9890da09..330d37eed59 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.md index f2d11107ced..37ec009cf85 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.37/qiskit.algorithms.Shor.md index e3950930788..e9708696437 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.md index 4bfd0a02f77..665b902ca3a 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.md index 5e81a09442c..a39de3334cb 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -76,7 +76,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.37/qiskit.algorithms.VQD.md index 8e17e6f3733..0b0948b0189 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -46,7 +46,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -67,7 +67,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -88,7 +88,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -115,7 +115,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -145,7 +145,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -161,7 +161,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.37/qiskit.algorithms.VQE.md index d1cc29fbcd2..59894959a1f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -74,7 +74,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -95,7 +95,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -116,7 +116,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -143,7 +143,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -170,7 +170,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -186,7 +186,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.37/qiskit.algorithms.eval_observables.md index febfacd4c18..f8799bcf96c 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/aux_ops_evaluator.py "view source code") Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index ed27b9c91ec..3a46507a905 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -54,7 +54,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -74,7 +74,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -94,7 +94,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -114,7 +114,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.md index 5cc09e47bf7..eaff0e34e98 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -66,7 +66,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -94,7 +94,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.md index 14938f15008..0a79d614cee 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.md index dd442832305..c1b10a16091 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index b693948e569..34f557e5032 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -512,7 +512,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1167,7 +1167,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2218,7 +2218,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index 2bae5d34d71..a3675782801 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 3a127b1ed6f..e284fe97bf8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -69,7 +69,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -89,7 +89,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -109,7 +109,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -129,7 +129,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index b933349b139..e2dba6186f4 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.md index 80848725b94..8e24051feb9 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -535,7 +535,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1190,7 +1190,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1727,7 +1727,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2241,7 +2241,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index c60c84ec3fa..619d0ad3415 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -548,7 +548,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1203,7 +1203,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1740,7 +1740,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2254,7 +2254,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.md index 1cb8688928e..894b499136c 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.md index 7544a0d591c..558c4585b08 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.md index a648a1877f4..b614e37a57f 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.md index 5a3c454ee58..4e6b250eeb3 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.md index bc57da09bc2..be44deb46ce 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.md index e4223a487f8..d8a7a046deb 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.md index 391659e822c..3203ca42762 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index b6a3aea03e8..a2c4729a203 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.md index a255d933e97..2d457a019ea 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.md index bdfcaa5b31a..8b67d0f4899 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.md index 99bc8ac4945..715b5a3f2d8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -95,7 +95,7 @@ print(f"Found minimum {x_opt} at a value of {fx_opt} using {nfevs} evaluations." -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -126,7 +126,7 @@ grad -`GradientDescent.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.md index 1324484d666..06e5745cf0e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.md index ad7878ee38b..9cc66a7db55 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.md index abc54192c33..ff5a1f71011 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.md index 9dda785473e..dcdc693575e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.md index 0f67766227d..f104446a4cc 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.md index 06a8e016367..778fdd7491d 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.md index 9448b48f246..237ae14428b 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.md index 0feaf00fe83..7d5af1edf57 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 70c8b675948..80667952f92 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.md index f51710209d9..4f4a5948bb6 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.md index e6d6ee22d92..3e292c95b1b 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.md index 78539300626..da4928e7f47 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -125,7 +125,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.md index 37ecfdb60b7..6b96077fd76 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.md index c72764e743e..b49e6d36348 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.md index 1412a12a915..8e11a1d3e41 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.md index 2e010229187..f845e57f356 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.md index 1d1df375bf0..d857a73840e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.md index ca77b9084a5..9461cbfe252 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.md index e265b689e6c..7a01daab1a0 100644 --- a/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.37/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.37/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.37/qiskit.assembler.assemble_circuits.md index f9e300f0673..f81988a18b2 100644 --- a/docs/api/qiskit/0.37/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.37/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.37/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.37/qiskit.assembler.assemble_schedules.md index 346b1237212..0cc2fa90802 100644 --- a/docs/api/qiskit/0.37/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.37/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.37/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.37/qiskit.assembler.disassemble.md index d768c0b9789..aae6f3b0ade 100644 --- a/docs/api/qiskit/0.37/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.37/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.md index 7764648d58c..ac6f9e5a828 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.md index 31b327569d8..3eedaa24a19 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.md index a949986bddb..0ee88f643e0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.md index 07b8170ee06..a1646efc135 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.md index a4e947082c6..b5d6ba4e3d7 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.37/qiskit.circuit.Clbit.md index d8e609ae094..6a54840e2ef 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.md index 919021aa97a..e6cfabf8f6c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.md index f855010fa63..e8027b1a1bd 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.md index 042424ec55d..5b67cda240b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -224,7 +224,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Delay.md b/docs/api/qiskit/0.37/qiskit.circuit.Delay.md index 535ce9f99cf..5ddc938d076 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.md index 13122fcab8b..8686fcf8d94 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.md index 9e84829e9f0..94b0da1b9cb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Gate.md b/docs/api/qiskit/0.37/qiskit.circuit.Gate.md index a74275d117d..bc58366d323 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.md index 76d9a331625..bd9883d1d24 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.37/qiskit.circuit.Instruction.md index 7defa08fdf8..0e1a7ef0ce6 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.md index 8a2b291381d..5ea20b28d31 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -85,7 +85,7 @@ This same instance of [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.c -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.37/qiskit.circuit.Parameter.md index a3ea550929a..00193b9ccd1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -206,7 +206,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.md index 6273fef38c9..25b9e7ecfd6 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -218,7 +218,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.md index 97bd45ceec5..03e33758ee0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.md index 0ac89350ed7..839b9352c44 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -139,7 +139,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -162,7 +162,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -174,7 +174,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -204,7 +204,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -308,7 +308,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -324,7 +324,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -353,7 +353,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -377,7 +377,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -389,7 +389,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -409,7 +409,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -434,7 +434,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -459,7 +459,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -473,7 +473,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -485,7 +485,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -497,7 +497,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -526,7 +526,7 @@ A handle to the instructions created. -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -554,7 +554,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -610,7 +610,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -634,7 +634,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -660,7 +660,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -680,7 +680,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -706,7 +706,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -722,7 +722,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -748,7 +748,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -774,7 +774,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -800,7 +800,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -826,7 +826,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -852,7 +852,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -877,7 +877,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -906,7 +906,7 @@ A handle to the instructions created. -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -932,7 +932,7 @@ A handle to the instructions created. -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -960,7 +960,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -985,7 +985,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -1010,7 +1010,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -1035,7 +1035,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1058,7 +1058,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1079,7 +1079,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1105,7 +1105,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1156,7 +1156,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1230,7 +1230,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1253,7 +1253,7 @@ A handle to the instructions created. -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -1281,7 +1281,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1312,7 +1312,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1367,7 +1367,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1395,7 +1395,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1415,7 +1415,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1435,7 +1435,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1455,7 +1455,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1485,7 +1485,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1493,7 +1493,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1513,7 +1513,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1535,7 +1535,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1561,7 +1561,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1607,7 +1607,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1782,7 +1782,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1884,7 +1884,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1907,7 +1907,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1993,7 +1993,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2034,7 +2034,7 @@ A handle to the instructions created. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -2058,7 +2058,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2095,7 +2095,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2120,7 +2120,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2142,7 +2142,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2171,7 +2171,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2194,7 +2194,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2214,7 +2214,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2228,7 +2228,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2244,7 +2244,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2256,7 +2256,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2279,7 +2279,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2300,7 +2300,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2439,7 +2439,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2466,7 +2466,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2486,7 +2486,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2506,7 +2506,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2533,7 +2533,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2560,7 +2560,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2584,7 +2584,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2609,7 +2609,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2633,7 +2633,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2655,7 +2655,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2675,7 +2675,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2695,7 +2695,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2749,7 +2749,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2789,7 +2789,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2816,7 +2816,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2840,7 +2840,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2864,7 +2864,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2888,7 +2888,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2912,7 +2912,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2935,7 +2935,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2959,7 +2959,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2983,7 +2983,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3395,7 +3395,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3563,7 +3563,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3787,7 +3787,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3810,7 +3810,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3832,7 +3832,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3854,7 +3854,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3876,7 +3876,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3898,7 +3898,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3951,7 +3951,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3972,7 +3972,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3993,7 +3993,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -4021,7 +4021,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -4046,7 +4046,7 @@ A handle to the instructions created. -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -4069,7 +4069,7 @@ A handle to the instructions created. -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -4093,7 +4093,7 @@ A handle to the instructions created. -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -4253,7 +4253,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -4298,7 +4298,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -4314,7 +4314,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4337,7 +4337,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4359,7 +4359,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.md index 85e9b11e6e3..a046bf78aa9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.37/qiskit.circuit.Qubit.md index 768ad4c74e5..3fc0bcbbba5 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.md index 1c5c997f07f..ebdb15aba67 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.md index c7a369d597b..ab5aca189a8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.md index 4cd83562974..a3d9fe226f5 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 038ae519bdc..aeaba018123 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 71c633bfcca..86bc8d41372 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.37/qiskit.circuit.library.AND.md index 685f55674bb..18e1ce26ecd 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.md index 49d1d038a95..794c393b04d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.md index 535c909d083..adf7f14a007 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.md index d0e46122f22..0b032c6b44c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.md index 20b6f31ce0a..5ba6d862ef2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.md index 529dc6eeb45..52dcae8c322 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.md index 7bcc7b9e23b..fbadf3f8de3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.md index 6d3cf3f6e4c..1f49edc69ae 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.md index 2daeebc27bc..4d86068e71a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.md index a6a030e94a6..18ec5102b4b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.md index 1541b328234..e79fa04d797 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.md index 54cd97d8b99..44bced9e831 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.md index 2cdca4fc66c..7e31ffbba9d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.md index 96d43432174..b5f84d8a274 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.md index 2bfcef043d8..df2f04bd4e1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.md index dd009422f01..dfd5f2af299 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.md index 1d94a2d4193..490d09fdfc0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.md index dd546097b30..da1a791d2bf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.md index 2ed5c8176f2..35422546aa8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.md index 057927e667e..6e57c923d44 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.md index f181c55da90..bb33601a92a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.md index febfdd5c704..721b17473ef 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.md index 2872a099723..808dc79f73c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.md index 43eea9712ad..b5539f23974 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.md index e1642461831..7eb2ad7e091 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.md index db792d75345..80b6dcf0986 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.md index 993c5541a04..ecc8a591ce7 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.md index e6e293ddf05..62db9555f78 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.md index 1e3eae5c1a2..3a7e60eecf0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.md index f7c6b370781..78d02adc9ff 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.md index 6bccaa1d467..9c9e83caa81 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GR.md index aeb8c5a07b5..11eee7e45b0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.md index d32a54ac30a..10068e9af9c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.md index 75835c181ca..f6b5c0a10c3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.md index ec5de13de99..41160f20f03 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.md index 136ff409df6..b04a3db29ea 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.md index 259e2e42630..9365f2ed466 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.md index bb75a69eaa8..2adb25dff77 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.md index 95bee51223f..63a45331bf4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.md index 0cf5a1f247c..a018e2c4778 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.md index 78ab994d032..6b8d8e2c2b0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.md index dd825fbc960..230755e97a8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.md index aa50e8d0f93..007b5f03ef2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.md index 50788824442..6cba4e4c80d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.md index 771e52d08c4..8f1bba81d3e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.md index 0fb5acb7c94..ffeb80dd176 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.md index d166a7286a3..a5c62bd4b64 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.md index 425ddc3f10b..a62d57b59ae 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.md index edb047f31ff..c00d9202001 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.md index acfd6f54e90..40fd9036cc2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.md index 70257d44985..55174bb855e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.md index b648f932644..8c3390f1f1b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.md index b1e625bd023..296829d9896 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.md index 1e6e90b79c0..dc78ba07964 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.md index 6bec51ad49c..02a22ebb3b3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.md index 7a470a1782e..e2d7bddf593 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.md index 9a077b97397..50c37992a6e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.37/qiskit.circuit.library.OR.md index 802d00a75ce..efd2693a663 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.md index 35f88d8b212..4f64b8c5f51 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.md index 31ae9cdcc57..58bd154d923 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.md index c5e72b4045e..794f471cb74 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.md index 238012fc9db..0ed32b4898e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.md index bf86f87716c..30c58c902f7 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.md index bd81f2b1bb2..4593eab21a8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.md index 50c159518fa..2bca7d8f982 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.md index 2bc11334843..f29e67c8c55 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.md index 620aa95d3f6..c352c9f1c10 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 3e7be0f44cc..9317c165efb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index e7bd0cb7662..cecfde3e607 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.md index 8a9d8ec176b..aa8673de18a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.md index cc9732da4d8..5bacf2099cf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.md index 417a55eb0de..6238d621bfc 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.md index b7076cfdb63..fec4136a8ca 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.md index dda2c9b0aa8..333946f5264 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.md index fe3f7caf71f..2f78e167ddf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.md index 8167047768c..aa522abf3da 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.md index da81dfa5bd5..17aec80f634 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.md index 30ba630985a..a9245aad26b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.md index 1f30f3fee7b..db4196a2fb4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.md index 4906c9968b6..66ea33cafbf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.md index 7a0f17dc3d2..bcd36c54eaf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.md index 10715cda5eb..f0e67e77d2c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.md index ea69ae37eb1..b3aecf02ca9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.md index 478ab3cfc4c..f7d8a4a0971 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.md index d74c43b9da1..102fa12c0d6 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.md index c73ad699859..c481da5cb97 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.md index fb2a51bd8d4..7634f475606 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.md index b28ff5a3aeb..941c29347fa 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.md index 112911dcb34..3787b514f50 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.md index 4c222b7115a..7c15ac5a4ec 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.md index 0d243fd47c9..dcdad8c161e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.md index cb5c4d94e24..6f6e401259a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.md index f1b06425e26..913d0a74934 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.md index b825a03aa36..c1916cef904 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.md index b60eba2094d..bd948afd7d4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.md index 4cc11c78e58..0bfc1699556 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.md index c636080ea9d..40d491358d6 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.md index 7448a312c4d..10ee8f1ed20 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.md index 00267efe6df..f90f839d625 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.md index a45cb754397..1d23a1f82d2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.md index 252fbc8884b..323cb2b2f25 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.md index 79734a2db3f..42936e81bd3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.md index 10a7d6d3f9e..73c5c67f03f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.md index 05e41a79ab7..b62e5ca1697 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.md index 1a5cfc79528..09f614a2a39 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.md index dcb54a17fc6..1c4ab41cff2 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.md index 87ffe1a7fd2..db6b4a27f59 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.md index 4824c8c074d..0b40f2ce3cb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.md index 7c3261f0fe9..10ad096c816 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.md index cef16198c87..fefe739d51a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.md index d9669da38d0..7ceb6f0ebd0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_1.md index 68502a28a47..3c4c64baec0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_2.md index 54d15c5e597..eb264738f11 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_3.md index 32d4806b73c..7529929a5c9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_4.md index 10a2f397498..95d525034b5 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_3_1.md index c4f2f9b0cde..a1a4d9bbfc0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_1.md index 4189b09bb7e..78188355c16 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_2.md index a865e0d3f37..00cd32d5707 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_3.md index 2b0c301a0ba..2cdd4a6560f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_4.md index 9752623348b..7c525a8f567 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_5_1.md index a94d26df264..eb5e57bd546 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_1.md index 6a6a05ee095..721b6d74890 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_2.md index 9b1b1b60227..6bb63266684 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_3.md index 41b38a67823..086003cce00 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_4.md index f629ab88800..da501ee9abf 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_5.md index 4377f2e8d71..962c13012ef 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_1.md index 14f8a77e56c..60d3a142361 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_2.md index ac93623d8fb..58b072797da 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_3.md index 632c8df5c65..df247b55ac8 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.md index 342b32c09aa..7d2c120775f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_cy.md index 457dedb2ecd..99b817c4ae5 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_xz.md index 5dccf6d527c..2cd830fcd38 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_yz.md index f5e920774ae..b9e961c027b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz1.md index 1905e0926e8..1f043f92cd1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz2.md index a57c55a11dd..ae9de66b36d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz3.md index 350ff006b15..c6fa7bfce77 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index cf2ae9c6063..eb52ea133c0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index a2511d41b5f..c6c651945c0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index c206be49855..98d724eff6a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index f2a5be2a1f5..e26a0421faa 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index a1d404ca256..3ff6033563b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 68df75f914a..28dbbc5f5e4 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index b83a8ce36b4..6a4125d3682 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 612285a42ab..280d82b267f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 388ed8cdc9b..f1fe9ee5058 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index d3a7e87723d..333961285c3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index c3de71904e5..3505f5a3224 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f9c6a3e2be5..65026119855 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index d5c985e0796..a0bb2e76a64 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 0f926c6dda2..627fb219194 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 46a6e27eb44..2f5f82f6eae 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index f8456b1431b..369d5aaa84d 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 15f368c1916..578d6d6ce8f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index 726445eeb2d..8e046f83e51 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 53b82eaa9cb..e0014cba13f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 1e04d2caa69..93ce2c59649 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 2702d70ad2a..64ab667237f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index e2ff7a6f1f4..135e61f277c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index cd6187a120e..b8f9463abf9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 9555b3d2084..111444e1c8f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 77b0657c650..fbefcb8b4f9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 65b9e881cef..4b078bf8e38 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 3305f50da2d..8a012c27af7 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index dde19ae5be9..c96e50a1e92 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 46dd5306edf..0cc6288fe10 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 922381593cd..162ed425178 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index d6e5a41d2c2..fd3a6d226e9 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 07ebfa06168..e80f31b04cb 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index d217111888a..f6753583aad 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 8d28d26581a..1bc3ce9b67c 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 3d61e836fd5..db0dcda5fbd 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index b5b257a2490..12ef81f1e62 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 5be315f0fd5..f2e61ccd8a1 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 083e8f799d3..f6761b3d20a 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index c629014a532..39b49fd0ee3 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index 47dd64e0db1..55406b5018e 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index b129e6c9dea..46fb75a530b 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 138ea052eb4..0fbc533fe9f 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 41346e308d4..49e86957907 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4a07bda68d4..f96421aea84 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index e8e5c579c54..55746b9f343 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index cc0189d8f5a..c4334091977 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index c6a7ba05459..3711adb4cf0 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.37/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.37/qiskit.circuit.random.random_circuit.md index 5d743ae18bc..fd4e2f72b02 100644 --- a/docs/api/qiskit/0.37/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.37/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.37/qiskit.compiler.assemble.md b/docs/api/qiskit/0.37/qiskit.compiler.assemble.md index 56823f963b0..a475aa552aa 100644 --- a/docs/api/qiskit/0.37/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.37/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.37/qiskit.compiler.schedule.md b/docs/api/qiskit/0.37/qiskit.compiler.schedule.md index 42328394fcc..ff294cdf7ca 100644 --- a/docs/api/qiskit/0.37/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.37/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.37/qiskit.compiler.sequence.md b/docs/api/qiskit/0.37/qiskit.compiler.sequence.md index af389f4b77e..8f20db3e578 100644 --- a/docs/api/qiskit/0.37/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.37/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.37/qiskit.compiler.transpile.md b/docs/api/qiskit/0.37/qiskit.compiler.transpile.md index 483ef8aa8b1..e1b87cd235d 100644 --- a/docs/api/qiskit/0.37/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.37/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.37/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.37/qiskit.converters.ast_to_dag.md index 81a080ccce9..cb29baa7e15 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.37/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dag.md index 347dfca3b3e..5693eda468d 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dagdependency.md index 792ca8469b3..352874f4dd9 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_gate.md index 40ab2e004c5..9edd2876e71 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_instruction.md index da0b8ad6e7d..bda42401821 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.37/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.37/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.37/qiskit.converters.dag_to_circuit.md index 8b3840aeafe..173a653a546 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.37/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.37/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.37/qiskit.converters.dag_to_dagdependency.md index 929e6edac0a..12123f48abe 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.37/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_circuit.md index 667c940d784..f32fea4411a 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_dag.md index 69ddfbd513f..c43690495f3 100644 --- a/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.37/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.md index 4562ba7520e..e9041dfbd26 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -238,7 +238,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -248,7 +248,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -260,7 +260,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -268,7 +268,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -292,7 +292,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -314,7 +314,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -341,7 +341,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -349,7 +349,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -365,7 +365,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -373,7 +373,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -393,7 +393,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -401,7 +401,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -409,7 +409,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -423,7 +423,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -431,7 +431,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -439,7 +439,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -447,7 +447,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -455,7 +455,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -475,7 +475,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -487,7 +487,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -508,7 +508,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -516,7 +516,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -524,7 +524,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -532,7 +532,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -553,7 +553,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -569,7 +569,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -577,7 +577,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -585,7 +585,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -593,7 +593,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -617,7 +617,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -630,7 +630,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -638,7 +638,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -646,7 +646,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -654,7 +654,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -664,7 +664,7 @@ Add edges from predecessors to successors. -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single. @@ -685,7 +685,7 @@ This is used to consolidate a block of DAGOpNodes into a single operation. A typ -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -701,7 +701,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -711,7 +711,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -719,7 +719,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -746,7 +746,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -772,7 +772,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -780,7 +780,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -788,7 +788,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -808,7 +808,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -830,7 +830,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -838,7 +838,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.md index ba56811ef98..2fc0a5992bd 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.md index 4c79999ab15..92918d5817c 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.md index 6e58666b883..43016ead74c 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.md index 5334a18d4e3..1ddcf3d443c 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.md index d7df81693b3..e272e3ae301 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.md index 635da7d71ee..2946413a8a7 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.md index 1b32eebc94e..2efe00ed95c 100644 --- a/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.37/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.md index b5f94a3944c..1b0c5f993a0 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.37/qiskit.extensions.Initialize.md index 32bea9cfa30..193283b4824 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.md index 2a1e69d9c05..04a183d552a 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.md index fc1b795b546..fa8bc352cad 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.md index a620cad05bf..1c4184725ec 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.md index 6729dee680e..ed48a443574 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.md index d865ce96a93..c6cf90ae3b8 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.md index 719876cc5fb..18ad5490db5 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.md index e370966451c..2f5345b7446 100644 --- a/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.37/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.md index bda021b1659..6255f5e0275 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.md index b81a33221aa..10d38469788 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.37/qiskit.opflow.anti_commutator.md index 94d94f9a8b9..8770564f9b6 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.commutator.md b/docs/api/qiskit/0.37/qiskit.opflow.commutator.md index 028f5c2c715..a36dd0b732f 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.md index ec70b1befdb..21a6703b50d 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.md index ce60bde81ce..64ef196bc71 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.md index 4471490c971..40ba15332db 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.md index c84ea78ab22..9d21684a858 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.md index 7b680142506..bd7659b0264 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.md index 5379c3a7dc2..dba9eea2b82 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.37/qiskit.opflow.double_commutator.md index fe0303511a7..262e4c5b16f 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.md index 8ec69e36674..2e3fbc591e4 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.md index fbcd225453e..ae12a5c131d 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.md index e031b668cf9..6c8b81ad998 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.md index 53691d7b393..b86adc980a9 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c9ab7f63244..fde3a46fbcd 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.md index fef7bebca7a..84fb49b0280 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.md index 3c4a01505f9..a262c58877d 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.md index 85eb320a568..b08ae7c9705 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.md index 814875ad672..c193b9e5c77 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.md index 42ce88cb68e..a23e9d4a457 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.md index 98d43b903b6..f5d354d9f20 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.md index c8b0ad6e734..a2e3de2fca2 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.md index 58705d64606..9b17374fa4a 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.md index 1d1d1d7cf0a..40efe47f7a2 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.md index 2cc190cb1bb..2df7095b268 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.md index 09e77b6e534..3cdeeb100e7 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.md index 5f8ef045adb..ef95a578831 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.md index a22bd08c594..d18264b265a 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.md index e289bbc8e84..f26f82595f1 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.md index d6cd31bd04f..1ac4f41e32e 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.md index 86272da56dd..a51663e2803 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.md index dcddacefd35..3a2e97c7b63 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.md index ccab2f39b10..3d6658e0cb6 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.md index 7ca03ff7680..4091a328ef2 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.md index 0abcc297b08..f6d59b1ec16 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.md index aeedc8aa0da..dacab7a7920 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.md index 97c88bb452c..01c6ebc41f1 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.md index 7a9794ada93..774f3c03fcf 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.md index 3f5b15124c8..8969c666238 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.md index 6b9758f5414..550afaf9bcb 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.md index 01651a9865e..2c008853c65 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.md index 291e168e5d8..f839e09f9c3 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.md index 3f563c0eb24..2e4d635a55b 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.md index 614b698244f..a791585abee 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -181,7 +181,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -193,7 +193,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -215,7 +215,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -235,7 +235,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -259,7 +259,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -275,7 +275,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -296,7 +296,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.md index 752f4c66aef..547c213b633 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 1f2b55a1bbf..a5536aa05c2 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.md index b3d1bad4ff9..cbd0ba72f04 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -66,7 +66,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -82,7 +82,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -90,7 +90,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.md index 4417a723bac..a14bdd74033 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.md index df3f2fdda5c..c1d3a8baf9e 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.md index e6267c2b836..c42f27c1436 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.md index f6629dc73f5..b74ad5ae57a 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.md index 71fa713a85e..785a9b03ead 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.md index 565d410eba4..e7d6050ae9b 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.md index 2ed43795737..b0ac9b82925 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.md index d5a7ae232a6..d863ca8ba3b 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.37/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`abstract BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") +`abstract BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.md index 88f4f878a30..806f3993623 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.37/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") Bases: `abc.ABC` @@ -33,7 +33,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`abstract BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") +`abstract BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.37/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.37/qiskit.primitives.Estimator.md index a604fb2a00f..e49f71ae8db 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.37/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base_estimator.BaseEstimator") @@ -34,7 +34,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.md index 72af32dc012..8b2471605f3 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.37/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.37/qiskit.primitives.Sampler.md index 61d4dfd80b3..d01c981b600 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.37/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler") @@ -31,7 +31,7 @@ Sampler class -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.md index 08b1c029dfe..0202b461888 100644 --- a/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.37/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.providers.Backend.md b/docs/api/qiskit/0.37/qiskit.providers.Backend.md index 458a6b67da6..f5b81c69d16 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.37/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.md index a73f44474f0..71c8077a020 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.37/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.37/qiskit.providers.BackendV1.md index 3a09ee047f9..886793a7a3e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.37/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.37/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.37/qiskit.providers.BackendV2.md index 54146dd6d7a..e8864af2daa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -43,7 +43,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -65,7 +65,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -93,7 +93,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -115,7 +115,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -137,7 +137,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -163,7 +163,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Run on the backend. @@ -186,7 +186,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.37/qiskit.providers.Job.md b/docs/api/qiskit/0.37/qiskit.providers.Job.md index 4275fc38f34..620e20af999 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.37/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobError.md b/docs/api/qiskit/0.37/qiskit.providers.JobError.md index 64ada67074f..b5b9f935f9d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.37/qiskit.providers.JobStatus.md index 78953b0d230..9c459949445 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.37/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.md index ebadc5e6d3e..cc69c3f3a7d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.37/qiskit.providers.JobV1.md b/docs/api/qiskit/0.37/qiskit.providers.JobV1.md index a092a74cf3b..36896ce02e4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.37/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.37/qiskit.providers.Options.md b/docs/api/qiskit/0.37/qiskit.providers.Options.md index a31832ac0ad..22fb83a0178 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.37/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.37/qiskit.providers.Provider.md b/docs/api/qiskit/0.37/qiskit.providers.Provider.md index 8cbafb92e6c..c48224535fe 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.37/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.md index b73ab499f7d..784ce38174d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.md index e016eed75ac..ab025bb7e1b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.md index f835aa6559c..4a73c2c9a25 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.37/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.md b/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.md index c9d0d668a98..03f100aa884 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.md b/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.md index ba98a460a02..f5c0fa0bc9a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.md b/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.md index 0c07b8a06bb..159dbb1bece 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -185,7 +185,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -193,7 +193,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -209,7 +209,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -243,7 +243,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -251,7 +251,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -339,7 +339,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.md b/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.md index e9f6b725254..cfb27ed06ea 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.md b/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.md index 2faf456b13d..5f5fea54d4b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.md b/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.md index f84f6ceec55..d170055da16 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.md b/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.md index 6d7f8665b69..90aaf4fe5bd 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.md b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.md index dbd91ff6a89..7b10f1d65a1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -111,7 +111,7 @@ updated if it was provided -`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`static Snapshot.define_snapshot_register(circuit, label=None, qubits=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Defines qubits to snapshot for all snapshot methods @@ -119,7 +119,7 @@ Defines qubits to snapshot for all snapshot methods -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md index fd03cfdcf55..a4a6bb5b8f8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix -`SnapshotDensityMatrix(label, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") +`SnapshotDensityMatrix(label, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_density_matrix.py "view source code") Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.md b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.md index 58a7390279a..7867addeb6c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`SnapshotExpectationValue.assemble()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") +`SnapshotExpectationValue.assemble()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_expectation_value.py "view source code") Assemble a QasmQobjInstruction for snapshot\_expectation\_value. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.md b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.md index 48f3fd67226..865304ae4af 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities -`SnapshotProbabilities(label, num_qubits, variance=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") +`SnapshotProbabilities(label, num_qubits, variance=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_probabilities.py "view source code") Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.md b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.md index 5d543be3d84..bda0bfcf5be 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer -`SnapshotStabilizer(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") +`SnapshotStabilizer(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_stabilizer.py "view source code") Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.md b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.md index dc480834ae8..14ccbf8030f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.extensions.SnapshotStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector -`SnapshotStatevector(label, num_qubits=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") +`SnapshotStatevector(label, num_qubits=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/extensions/snapshot_statevector.py "view source code") Bases: [`qiskit.providers.aer.extensions.snapshot.Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.snapshot.Snapshot") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.md b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.md index 64be00ea2c3..64b83f8b8d3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.md b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.md index 3311b1ef835..a11cd3785f3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.md index 6792f878b7d..9f4f5d910de 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.md index bd7f6d6c5ed..e22bd5cc096 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.md index df3329c10f6..cd0ec83c251 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.md index ca0440155fe..57400178979 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.md index aca16ae6d38..26210ce8e35 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.md index 8ad8b654cbe..0a7fa0987e1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.md index be91313ed7d..8abd0693406 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.md index 94a8f02200c..792b8d286f4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.md index 521dfa280a1..1176293b922 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.md index b35310de3e7..4ee6e9012ad 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.md index 9383b4accc4..6a8805aaad1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.md index f1a9211081d..cb287b98b65 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.md index 0164a8f6caa..2559b92fd40 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.md index efd7134c047..1c202ef2c92 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.md index 5c8373f1097..b678f297871 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.md index 27f25642ad8..fc949293603 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.md index 97696fc5d59..d62ae60d622 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.md index dfd4c4be567..e73496faf6a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.md index 4a5e1e72f96..f856f90fb9b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.md index 602ca7e3f66..a84dc6e4f8e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.md index bd971583d97..7d52469ff82 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes.md index 6a13d926a38..a4a203a3491 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes_squared.md index 062a1c91353..eea7d4cf9e0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_clifford.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_clifford.md index 4f14f97b138..000ca032692 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_clifford.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_density_matrix.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_density_matrix.md index 291686fe2db..282a10cb17d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value.md index 7103d8722b2..e75393f0cff 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value_variance.md index a24adf5e5a1..4e195786ad8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_matrix_product_state.md index c670bea271c..6d69aa8667c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities.md index 7ca5a88ff97..2dacdffc24c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities_dict.md index f073b756427..dd06f62df2c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_stabilizer.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_stabilizer.md index 1a4f726abb7..35ab80e59f5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_state.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_state.md index 7b05f633ceb..855e187fc51 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_state.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector.md index 81e559b9687..a7b4154840a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector_dict.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector_dict.md index 5dcfd30ee90..ec01caea11d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_superop.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_superop.md index 0ecef858f02..b154bb253d3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_superop.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_unitary.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_unitary.md index 8db27bbcb5b..7b0c94f151b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_unitary.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_density_matrix.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_density_matrix.md index 5b553a67c48..8bb80af7d7e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_matrix_product_state.md index d98c5a76865..15e771861e8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_stabilizer.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_stabilizer.md index ce7e9a509b5..9912834fdf6 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_statevector.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_statevector.md index e7581c0bcd6..cebb8fb0124 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_statevector.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_superop.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_superop.md index 3dbebceb8fd..c93a433e30f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_superop.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_unitary.md b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_unitary.md index d911d25a185..f9c8bccee08 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_unitary.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.md index 940a2b5cd0a..9a84e8300ff 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.md index ff54c09d9f1..56af422c5cb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.md index e0b451505e9..d5d268b8004 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -129,7 +129,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -154,7 +154,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -176,7 +176,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -250,7 +250,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -258,7 +258,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -266,7 +266,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -292,7 +292,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -300,7 +300,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -308,7 +308,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.md index 2fb79644c87..8eacb9c4d32 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.md index 78081ebe78f..679ba4cd5e5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit.providers.aer.noise.LocalNoisePass "qiskit.providers.aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.amplitude_damping_error.md index 2bc7de3d3e7..afef934915d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.coherent_unitary_error.md index 1c9a2a9f64d..f8097665bd6 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.depolarizing_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.depolarizing_error.md index bbbe4d0f7b7..07c710fea35 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_gate_errors.md index ce7e7abaeba..c7f87eba5fa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_readout_errors.md index fb277fd28dd..a577cfc022a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/models.py "view source code") Return readout error parameters from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_error_values.md index 0ce4115bd93..c1f21a62240 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_length_values.md index 3c2c5f23334..f7992b91e97 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_param_values.md index 86a287d0afc..ce5427292f5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.readout_error_values.md index 88cd0f9ad0e..ab6e01038d7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.thermal_relaxation_values.md index ec6e650fa60..6721ae46ec3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.kraus_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.kraus_error.md index f0fb3742112..56e560125f2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.mixed_unitary_error.md index dd7f9434768..a6afa4cc627 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.pauli_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.pauli_error.md index ae03836579e..012f973c05c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_amplitude_damping_error.md index ffa103d1939..e23dc9a7b4a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_damping_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_damping_error.md index 26d234433ce..c258bb0356e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.reset_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.reset_error.md index 0de3a334da5..587100de267 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.reset_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.thermal_relaxation_error.md index 2ae3454801c..fad6d2a0c8a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.md index 9a5c7da246e..faef97589c8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.duffing_system_model.md index a5e56ada57e..cc6b846aa7f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.md index a73fc8a3c38..bbcee90f47f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_noise_model.md index bc76519e380..721c78a3ee0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_quantum_error.md index 7375eab0182..079e1acaff4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.insert_noise.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.insert_noise.md index 745f84bfd4e..5d930938583 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.remap_noise_model.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.remap_noise_model.md index 4afa3125223..bbae7213024 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transform_noise_model.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transform_noise_model.md index b33c5259857..1bc1e9aca76 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_noise_model.md index c053febb009..522f1ceb32e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_quantum_error.md index 31a80d77303..fc6592d7380 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.37/qiskit.providers.aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.10/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.md index 76ecd660a6f..63c6b01e9fe 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.md index 60acc4d6ba8..c4c1cb77055 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.md index 7564164039f..30b1f311250 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.md index a2a48f92ede..29955b2588b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.md index e20b46a253d..56ca9c78669 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.md index 2bd9491e834..57062b3f3cb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.37/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 8807aa994a7..5a12c1d0e72 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.md index aaee9cc0e85..d56d67194f1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.md index bb88bdd0b9e..1246e6f2745 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.md index 0c39311c970..e44a8d06c3a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.md index 1886b2c1bdc..2ecb161f1c4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.md index a0b1976076e..ea2ba45b28c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.md index df920c951ad..34b05160f39 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.md index 6d777b19559..925568dd5de 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.md index 5f8b92b095a..6af4b912205 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.md index 8b779cb0557..fbed1abee51 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.md index b888b4a2fb7..ea08dfe5bf2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.md index 1ed9b93cd0b..ce8c25ee397 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.md index 4208e92bae6..478f59476b8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.md index b23c255dc3d..29b427b3fdd 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.md index d25215922b5..165c9658db3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.md index fc6e39e7e5e..deea577db4d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.md index 18498775a52..be37f3b1254 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.md index d95e40c240e..313e3d2ecba 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.md index 3dce3809290..237a95bbfca 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.md index d1a47db36c4..6514d9b1d75 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.md index 1a9798327fa..fa38aa61c3b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.md index 0cd83e69070..c6f87d0f72d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.md index 053c72c13f2..c7d8cd5e534 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.md index f7f7de6292a..5ed78021a69 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.md index c35a10b156c..1304db5836b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.md index 5aba82671a4..0e51cc39ab8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.md index d89a142c5d7..a36486b15a2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.md index d3d46e57636..c58792f067d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.md index 8cbca5954de..d8515c2cc72 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.md index a05a6018942..c303702641d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.md index f13b16e7176..5ec0b24241d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.md index e02e1d54e8f..995acbf6e9c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.md index ebc27c0fa9e..0457f86b8d2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.md index 066f166442d..fa6ff522118 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.md index 40c57b4e852..ab9b3c51c33 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.md index 260cb63111a..17dbe7887e7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.md index cc10a663232..340ee116e7b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.md index 80757cab045..2986025467a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.md index c0e6196c8b9..2803169e1e2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.md index 67341a88090..826d79fd823 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.md index a943ea4a5a4..f1bef1983d8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.md index 4194604a5d8..37779210f98 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.md index c4856cca03d..73ccec9a35a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.md index 2d5b00a2625..3bd3cc697b7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.md index d1f765552fb..9c7147cc16b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.md index 1518d37660e..a2976ba68f8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.md index adff6839e59..a23af896e28 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.md index 05666bb2ff8..762a5d527df 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.md index 7b11b87d030..c28f17008b8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.md index ecbed438a65..c2b3e190277 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.md index d85afcf93bf..f56fa07d35b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.md index 7c63d12eab2..21aae092e60 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.md index 687b8d3421a..9feacfed2ec 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index 815490a843e..1e3bca18345 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.md index d8755b168d4..e606638d695 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.md index b1edd922e34..8e623c599b4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.md index b0f2538630c..b41818ac0e2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index a335a9850a1..21dd3c471b9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index ab794a6f02c..18b04f1d83d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.md index d17d14c1d60..ce6f7f95433 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.md index 2203dcfe022..4353f308fbc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.md index 75b0753cf6d..91b6be914fc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.md index 895b3aa383e..9226b0fc71f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.md index f773aad30cd..20c54256078 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 9a31d796bf8..14859425efe 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.md index 9a2a397b896..f8a31cded8a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index f5e9c31b9b6..cd74a81d48b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.md index 2ced7f4b2ff..97200007f64 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.md index 62fbfb6f7d3..0468c836d2a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.md index 13e61b4aaa0..79e1281e5b9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.md index 89182137d2a..d3ca72c84b9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.md index 9831ca3e292..3c16eafcdb1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.md index 97a05839d37..cc06f3e23ca 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.md index 313c59291fe..04f35ac5397 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.md index 6a3545efe10..fee91e5c185 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.md index a2501cfb3bf..395f04677e7 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.md index cac2ae19077..fd83f243167 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.md index 21bec32d8d6..71e6b924c7c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.md index e05bf27a82c..13c8a5e2600 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.md index 71be1a4f4fa..6dd0291331a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.md index 80f022bbddc..d6d3c8a0726 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.md index ed63aa27370..386719a42f6 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.md index dc4ed6c13cd..650b99478bd 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.md index f1d313a6248..cd96cea8680 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.md index 95ff1c3c4c2..2443e96bd93 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.md index 7d7e8ed9dc9..09d6726f199 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.md index 31fc7114885..f8e68f619bd 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.md index 49009bc3e69..a49cf627b7c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.md index f0ce64340fe..9fb59d7b568 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.md index 16bee570cd8..c6d49b97abe 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.md index 0c5b034ce01..4d2e1e67c3f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.md index 5f5560e0334..af57efb52bc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.md index 001171e6f9c..d1a3ae5f0af 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.37/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.md index ac2bb7e4984..d83cba70594 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.md index 9e2f72144f4..5696933d4a8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index d3d7859b636..d986df37b1e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 5645c4c24bd..7040b5ff883 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 2b79453f6ba..f4ce04dc5bb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index ea748b6719a..09a93e6b81f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.md index 3fab47b9099..82186cac087 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 4ffadf8c93c..4a17d4d7b0a 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.md index 66605916fec..3334bb4a3c2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -477,7 +477,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.md index 8f76680a706..1b44a08e8a0 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index d2954ec6fb0..fd69b6ed1dc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.md index f68ab861049..68cc2afa143 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.md index 3cdb81cf57a..b8da8734015 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -140,7 +140,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -209,7 +209,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -225,7 +225,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.md index a38a76dfdee..b3a3cd933dc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.md index 362fb52745c..0b711755a2f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.md index 0f765703d8d..9a6fb649ae6 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.md index b52b29d66b0..de434cd2de8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.md index 4b446849cc4..814bfa0dfc9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.md index fde38e8edaf..0d0b5413ec2 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.md index 211e69d3a91..3703893d197 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 856cff72d1e..6235546f8ec 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 869e3725218..b3a235e13fc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.md index bebdde0ac5f..9091dcf1e63 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 7f6e3e60997..35d375720a5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c753b9b03fd..0a5ff1c030d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.md index 0e16c129460..4119853fe38 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.md index c0ec62197bf..3abd0382d49 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.md index 0e98ceffabb..3890486708b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.md index 4a087d3fd82..543fb587672 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.md index c7d560a66e7..d3bfa9ccd14 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.md index 0626db0120a..3fd71c70852 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 8ea40cf804d..74ebff3e9fa 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 57a7fc6c085..5d38a428320 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 0481fda1214..2fd9874cefb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.md index 45b63ccd381..ab9a3314315 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.job_monitor.md index 4b7ee67e901..e407a59be71 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.least_busy.md index 29174c48477..9b045aec80e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.md index 9a198d26d89..ddbd2a9b158 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index a6b662fe102..64cce88e50c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 4006a3d0d4e..11e52eaec09 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 4e299221dae..57f826b9283 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index b19ab743224..02872ed993e 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index be41ee3b213..4e0a432bb6d 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 8f1556fcdd5..36bcff386f5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.md index 08ad74c3867..e9c1ab44d0b 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.md index ff5b8bf3438..4665b7e9bf3 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.md index 873c7251ec2..8a4f3f1a245 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 916b4476630..99613bad810 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 045bf20ddc8..892a734ebd4 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.md index 7feeaf688d5..be445fbb65c 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9188f764070..dd32329888f 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a0885b06940..d5400ad6165 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index b9a1da51d6b..69290448ca5 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.md index 869f5fc84c1..418963c5efc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 942dc83ad8f..03707eaa300 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 91ca5ee1f15..1220a71e9cd 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.md index f95d6bd4118..0dea489a2d1 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.seconds_to_duration.md index 1f138559be6..f005d414fbe 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.to_python_identifier.md index ad186c83b90..fe8ecb9ffe9 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.update_qobj_config.md index 3e2e6e9a4cc..a51e8c95919 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.utc_to_local.md index 161e29c2551..8cfe310b9f8 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.validate_job_tags.md index 6ef795cb48d..4c562c2a072 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.37/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.md index 0643db66817..24c83bf3d77 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.md index 48dc02f7651..858227205bb 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.md index 37bd9fc18bb..302196370fc 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.Command.md b/docs/api/qiskit/0.37/qiskit.providers.models.Command.md index 8e89ec5102a..12fe1740d24 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.md index c5e0b1e7da3..9c64fc77e58 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.md index 47b4091fcb8..4467ec3faab 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.md index 27108c5d6c8..d0a33b00230 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.md index 772823d1f81..6bccc9611ac 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.md index bab742abe80..8481e6a8661 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.md index b09e9a68fc2..8364b848cf6 100644 --- a/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.37/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.md index dd9d8d5c0a4..c570e768d47 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -159,7 +159,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -182,7 +182,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -204,7 +204,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -228,7 +228,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.37/qiskit.pulse.Schedule.md index a34fe5626d0..b8fcae6e723 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.md index 031c6cbcb0b..2c0b58274d8 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -172,7 +172,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -205,7 +205,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -236,7 +236,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -258,7 +258,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -283,7 +283,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -295,7 +295,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -307,7 +307,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire.md index 6758a3e10f1..8d2586eedc2 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire_channel.md index 0053054f7f3..0c258391edc 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.active_backend.md index 69715fda084..c742fef3ef2 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.active_circuit_scheduler_settings.md index ae992346e28..ba6033ed5d8 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.active_transpiler_settings.md index 43e8c0173ee..c8cda9e3064 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_equispaced.md index 84fab41aef6..c7ae40850ec 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_func.md index 6015c111509..fa9a484e1bc 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_left.md index ccf13b05427..c7160e2ca7b 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_right.md index a2e49d6f792..a0aa7a4714b 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_sequential.md index da9d8691aa1..4350d89d1f9 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.barrier.md index 304b5affa45..8501c23a2ef 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.build.md index 73fd3aa572e..bbeb2261e5d 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.call.md index 6ff747d1c7e..721f47bf082 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.circuit_scheduler_settings.md index c63397ee03c..b04450ac20e 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.control_channels.md index bb7af77a32c..12c030ec586 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.cx.md index 23146a89777..8c7d4387249 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.delay.md index 184dcb22cae..b37a0a85928 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.delay_qubits.md index 90a4534a0b5..7e271890296 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.drive_channel.md index e12921b2fbc..0949fce2e85 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.frequency_offset.md index b4fc7f3f429..4cec3bd4320 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.inline.md index 6c842fbf9ef..27c793eab2f 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.measure.md index ad942a62046..54a077b142f 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_all.md index 23892731acb..7aafcc9f4cd 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_channel.md index 734053bce5c..130d886e5bb 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.num_qubits.md index e0b622fcdfb..d494097d5cf 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.pad.md index 74ae434a5c1..905abb26ff0 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.phase_offset.md index 622c2e50441..aaeb01cae01 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.play.md index 64b79c965ff..413a51e3274 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.qubit_channels.md index edd01e6a2a2..2daf01b0968 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.samples_to_seconds.md index 12ebef79b4b..acd9061d577 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.seconds_to_samples.md index a1b026cc646..1ad3871d1de 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.set_frequency.md index 01d5586e566..c4299ca869f 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.set_phase.md index 35b1e5324ef..3af33632828 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_frequency.md index 2fabafe0abc..b263f80f922 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_phase.md index dac5a1ae749..d213ded71fe 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.snapshot.md index 06a48d33a7b..211443a72fb 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.transpiler_settings.md index a8a92836d6e..5c62885fbfb 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.u1.md index 69c8b572ec0..46af21df2f4 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.u2.md index aca3c602360..bc477938cc3 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.u3.md index 72beed256c5..edef6cc2219 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.37/qiskit.pulse.builder.x.md index 08d2133c82c..e1dcd47a47f 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.md index 21faba179e8..618d7ad0320 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.md index 15d8fab6b9f..5429edfeeca 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.md index b8856a45a01..ff5a61ec697 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.md index 4700ff8a21d..f3a0ae5e237 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.md index 172817d4dfa..344eb6a1967 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.md index d220e5aa7b5..26513d15484 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.md index 298f25f353f..ffc9ae54bd2 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.md index c9c927bb6d9..1ffe0988934 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.md index af587cf03e5..4b3c1437f2f 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -182,7 +182,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.md index 5fa2a38d281..dce46d9991c 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.md index 3cfb648cb3a..3bb8a0f24cc 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -158,7 +158,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.md index 67e3144f249..3998b4d65bc 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.md index 3c3313b29b8..61be78fe627 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.md index 6100878b1ed..92147cd1e17 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.md index 526b0fe0d96..85788029936 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.md index 6711c977bb6..91766dd5e40 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -156,7 +156,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.md index e76ff06b5cf..2e130f429ba 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration, amp, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.md index 60f564d63c9..3c2dd6f13db 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.md index 34cc58fee87..bbe919710cd 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.md index e97f9c2d759..eaf861e0764 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.md index e3ede890dd8..2b3d49f0d63 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.md index 905acc62048..d7924397ad6 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -158,7 +158,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -185,7 +185,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -197,7 +197,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.md index 5dd311a9a39..2c0b2bcbdc1 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.37/qiskit.pulse.library.cos.md index d9ef86281ca..d6247cf74a2 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.cos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_deriv.md index 7409327bd08..3671a09e5e5 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_square.md index 84a1d5835c6..f3a2511ddf9 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.gaussian_square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.37/qiskit.pulse.library.sawtooth.md index bdb8d87bc20..d4f93fdee5e 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.sawtooth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.37/qiskit.pulse.library.sech.md index 4e55d4501a5..4e6411ce864 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.sech.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.37/qiskit.pulse.library.sech_deriv.md index ff9823c67b6..016cd25ba1e 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.sech_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.37/qiskit.pulse.library.sin.md index 5c46b644955..fdaabc58f60 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.sin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.square.md b/docs/api/qiskit/0.37/qiskit.pulse.library.square.md index 7a818044a5a..f18e3ac157a 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.37/qiskit.pulse.library.triangle.md index ecd3ec8e247..f8ec24a5eaa 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.triangle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.37/qiskit.pulse.library.zero.md index b7e29a24331..8b46e88db55 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.library.zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.md index 728c0ec2df1..d5417983f92 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.md index 3b6e9ed8716..ba8089eebcd 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.md index bb8883c9769..0112a52c331 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.md index 6bde58df5b5..96c80e1d394 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.md index 5d51ab76329..717b9fa6f2c 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.add_implicit_acquires.md index 136204aa1f7..30e8b0c3566 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.align_measures.md index 480a807ce44..b64093186d9 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_dag.md index cea1c742f9a..ac3ff93c3cc 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_schedule.md index 052176a18ea..d8716d314b5 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.compress_pulses.md index 607d196ae5e..24013ca5a54 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.flatten.md index 8928c0f9019..2c83e11a3ce 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.inline_subroutines.md index 988bac0083c..7856760be86 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.pad.md index 116e533a331..28733b2d059 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_directives.md index f944cdb00f9..0cf357232b9 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_trivial_barriers.md index 17e6d66530f..6902bac3afc 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.37/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.37/qiskit.pulse.transforms.target_qobj_transform.md index 530d7a6f79d..91cce793766 100644 --- a/docs/api/qiskit/0.37/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.37/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.md index 81ad4e4eb5d..874320e62e2 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.37/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.37/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.37/qiskit.qasm.Qasm.md index c5c491580d8..90dfdd99d07 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.37/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.37/qiskit.qasm.QasmError.md index e329a4e943d..f0277f7da2e 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.37/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.md index e24f3d524eb..cd56907c785 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.37/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.md index c02df9e9dd9..d508f74e0b9 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.37/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.md b/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.md index c194a75720a..7c69bf2f124 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.md +++ b/docs/api/qiskit/0.37/qiskit.qasm3.Exporter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.Exporter -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ QASM3 exporter main class. -`Exporter.dump(circuit, stream)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") +`Exporter.dump(circuit, stream)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, dumping the result to a file or text stream. @@ -38,7 +38,7 @@ Convert the circuit to QASM 3, dumping the result to a file or text stream. -`Exporter.dumps(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") +`Exporter.dumps(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, returning the result as a string. diff --git a/docs/api/qiskit/0.37/qiskit.qasm3.dump.md b/docs/api/qiskit/0.37/qiskit.qasm3.dump.md index 8501c51ef1b..fb45dba2156 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm3.dump.md +++ b/docs/api/qiskit/0.37/qiskit.qasm3.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dump -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. diff --git a/docs/api/qiskit/0.37/qiskit.qasm3.dumps.md b/docs/api/qiskit/0.37/qiskit.qasm3.dumps.md index c6e709eac21..d07facc185d 100644 --- a/docs/api/qiskit/0.37/qiskit.qasm3.dumps.md +++ b/docs/api/qiskit/0.37/qiskit.qasm3.dumps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dumps -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.md index 4c8beb10fb5..9986846b3f8 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.md index caceebdea6f..fa8fca5cd84 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.md index 3c7950567ea..c62bcec1b75 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.md index 6915fe44d58..724c205fbb0 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.md index cada6e6d6a5..c15626ec148 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.md index b3658cec34e..3efe5859c1d 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.md index 271988a4447..22dfcfe3837 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.md index fdee1bf81c1..30a0e8ec24e 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.md index eeac8478627..a67da88f576 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.md index dae1ebe8a10..a537e98a9f8 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.md index 8c92bca0720..b9afa0b6c19 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.md index 352d1e0d9fe..aee49eb6d53 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.md index fad5374e449..bfe61a4e9c5 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.37/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.37/qiskit.qobj.Qobj.md index 9a61c90f112..cb834488faf 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.md index 0870511e020..32e15587131 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.md index 85512c9d60b..7bfb1585ec9 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.md index 550f2caed45..d95feab203b 100644 --- a/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.37/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.37/qiskit.qpy.dump.md b/docs/api/qiskit/0.37/qiskit.qpy.dump.md index 54275c2ae7c..a6510d541e9 100644 --- a/docs/api/qiskit/0.37/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.37/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.37/qiskit.qpy.load.md b/docs/api/qiskit/0.37/qiskit.qpy.load.md index 3735ef8a6e9..5a83e257799 100644 --- a/docs/api/qiskit/0.37/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.37/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.md index fba4d998b9a..f24e9e62dc6 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.md index d5e11c6faa1..1f22637b48d 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.md index 7ebb479b752..23324445d81 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.md index d030872ba5d..a8a8b21171b 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -407,7 +407,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -415,7 +415,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.md index eec78db3a6b..0babbbbdead 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.md index eeb6e2343c3..0c16e7e1616 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.md index f7c13480b38..56922f295d2 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.md index d68db1d9344..7711584c5af 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a :class\`.QuantumCircuit\` @@ -201,7 +201,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -237,7 +237,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -253,7 +253,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -303,7 +303,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -321,7 +321,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -347,7 +347,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -355,7 +355,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -363,7 +363,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.md index aabc31cf02a..7ead185ce61 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.md index 181e93b16be..840f95e9ac8 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.md index be5c344c9b1..0f17d1b41e4 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.md index 2ec619e4ff3..4cb4f10ebd8 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.md index fc27c2b438e..58c36b79800 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.md index a381968ccb0..3e3cf17fb4c 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.md index 9af60f4e3a5..16be1f02b64 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -50,7 +50,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -82,7 +82,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -114,7 +114,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -155,7 +155,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -175,7 +175,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -197,7 +197,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -234,7 +234,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -262,7 +262,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -308,7 +308,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -351,7 +351,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -372,7 +372,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -390,7 +390,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -470,7 +470,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -491,7 +491,7 @@ the simplified SparsePauliOp operator. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -519,7 +519,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -545,7 +545,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -567,7 +567,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -587,7 +587,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -595,7 +595,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.md index 86fdcf7523e..074d5ea9a84 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.md index c22b3b9acc2..989872b864a 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.md index 6e6e6761251..2aab94062c1 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ $$ -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.md index f95ef20409e..70dee161312 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.md index ff9a15f896b..83798e0b38c 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 3fa16f2d54b..9e7850c40eb 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.md index c6f3380cb5f..d3147b7398f 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.37/qiskit.quantum_info.average_gate_fidelity.md index b7a49d55b1c..1b96d16a9db 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.37/qiskit.quantum_info.concurrence.md index 498b0aa5bed..52cec654c43 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.37/qiskit.quantum_info.decompose_clifford.md index f10954d4401..c5d5eade3b6 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.37/qiskit.quantum_info.diamond_norm.md index 15b0e3e67da..21774f4c2bf 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.37/qiskit.quantum_info.entanglement_of_formation.md index e1664443c53..2db458d05a3 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.37/qiskit.quantum_info.entropy.md index f6f52c656cd..dd509470ac3 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.37/qiskit.quantum_info.gate_error.md index c7fda253ec5..80e42433ac7 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_distance.md index ee8844e0a91..4f6b2c4386a 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_fidelity.md index 87775ce8297..5109e32dde1 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.37/qiskit.quantum_info.mutual_information.md index 437e0dc14d7..ce6929c8569 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.37/qiskit.quantum_info.partial_trace.md index 4d7ad63bc38..f41d27f500d 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.37/qiskit.quantum_info.pauli_basis.md index 860a4b287b9..bd12c5dd812 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.37/qiskit.quantum_info.process_fidelity.md index 2e93dd0117e..fb2ddf17386 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.37/qiskit.quantum_info.purity.md index d242a145c03..e0c46d80759 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_clifford.md index 219d5fea2f6..019d0dd65d1 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_cnotdihedral.md index f424fdb178d..74d8715e442 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_density_matrix.md index 6348d50b409..2ce11719f18 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_hermitian.md index 7417b425da7..951a5050173 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli.md index 0c8d7380bfe..92c28142871 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_list.md index 0f3633ddc1d..492b5072760 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_table.md index 265c0110567..29cd46d68d0 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_quantum_channel.md index 6e2e14c02fe..90e5d9ca95a 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_stabilizer_table.md index 320e0ffb3bc..93f1c0e22b5 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_statevector.md index a97dd6a9038..1e018dd51ee 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.37/qiskit.quantum_info.random_unitary.md index 48696865ce5..651b6e1adc2 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.37/qiskit.quantum_info.shannon_entropy.md index 81584fad115..a1bf8f78e01 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.37/qiskit.quantum_info.state_fidelity.md index abe2cb13a70..e6456b2630a 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.md index 863dfda11c9..dd7943dcd3e 100644 --- a/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.37/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.md index 714f938c1ba..75a2b5c9a62 100644 --- a/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.37/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.37/qiskit.result.Counts.md b/docs/api/qiskit/0.37/qiskit.result.Counts.md index 4b974fee1ea..569a90e7c3a 100644 --- a/docs/api/qiskit/0.37/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.37/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.md index a531ded5624..d69573ef9ba 100644 --- a/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.37/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.md index e0fd72bf6fc..d97b5aa7e78 100644 --- a/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.37/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.md index 55bc8f4bb72..64838e54c77 100644 --- a/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.37/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.37/qiskit.result.Result.md b/docs/api/qiskit/0.37/qiskit.result.Result.md index d13dafec7cc..35f3be59fa4 100644 --- a/docs/api/qiskit/0.37/qiskit.result.Result.md +++ b/docs/api/qiskit/0.37/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.37/qiskit.result.ResultError.md b/docs/api/qiskit/0.37/qiskit.result.ResultError.md index 4ad99614373..b642c85c3d8 100644 --- a/docs/api/qiskit/0.37/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.37/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.37/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.37/qiskit.result.marginal_counts.md index bf2a30ccfb7..924531d111c 100644 --- a/docs/api/qiskit/0.37/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.37/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.37/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.37/qiskit.result.marginal_distribution.md index c2a67c781ac..b48ab41921a 100644 --- a/docs/api/qiskit/0.37/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.37/qiskit.result.marginal_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.37/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.37/qiskit.result.marginal_memory.md index 7774b3c5c51..a3d8742dcb8 100644 --- a/docs/api/qiskit/0.37/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.37/qiskit.result.marginal_memory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.md index 939ea8a4dc8..588b27dc88d 100644 --- a/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.md index e8b92f46194..aa4b4cb1011 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.37/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.md index 9cced88e5ba..c13d2d730a5 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.37/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.md index 56429730dc3..7c575df85ea 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.37/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.md index 533bc7d1eff..dd77812ba4e 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.37/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.md index 2f48b431ff9..6282dc8ca7b 100644 --- a/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.37/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.37/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.37/qiskit.tools.backend_monitor.md index ba646a67a14..f4bd7870850 100644 --- a/docs/api/qiskit/0.37/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.37/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.37/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.37/qiskit.tools.backend_overview.md index b57539983df..03f7466c6e0 100644 --- a/docs/api/qiskit/0.37/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.37/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.37/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.37/qiskit.tools.job_monitor.md index de4abf4ace6..a3750cd2b0b 100644 --- a/docs/api/qiskit/0.37/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.37/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.37/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.37/qiskit.tools.parallel_map.md index 018b21aab3c..f227996e722 100644 --- a/docs/api/qiskit/0.37/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.37/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.md index d8b7dc6d0e7..32f14a05f7b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.md index b07e2189736..069070e604a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.md index bde7d83da5c..3c6decc5d65 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -112,7 +112,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -124,7 +124,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -136,7 +136,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -161,7 +161,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -186,7 +186,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -208,7 +208,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -220,7 +220,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -232,7 +232,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -248,7 +248,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -258,7 +258,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -266,7 +266,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -274,7 +274,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -284,7 +284,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -308,7 +308,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -333,7 +333,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -341,7 +341,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.md index ad2e5c3ded9..62595b032ac 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.md index be42179ad50..89f31b36574 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.md index b32a44b62ff..83fa099e7c4 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.md index 15794221e04..1c07d29b304 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.md index a394576da55..e0176a50c58 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.md index ee68d67d417..68f6b59d293 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.37/qiskit.transpiler.Layout.md index 8c6bd623b09..91ad11954ad 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.md index 8488f9dbfec..daccaac5544 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.md index f30848bd558..8c16b0727a0 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.md index 7d75aa0e070..768ef107b0b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.md index 5c7aa10664d..ac7aebb84fa 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.Target.md b/docs/api/qiskit/0.37/qiskit.transpiler.Target.md index 6d103fa5ca1..94ebe930942 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -135,7 +135,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -162,7 +162,7 @@ for this target. -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -186,7 +186,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -208,7 +208,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -248,7 +248,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -264,7 +264,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -305,19 +305,19 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -337,7 +337,7 @@ The Instruction instance corresponding to the name -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -361,7 +361,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -385,7 +385,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -405,7 +405,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -421,7 +421,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -460,7 +460,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -478,7 +478,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.md index 1cb0f7e76e6..8d1af429531 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.md index d16f04fa8a4..0e3e8f1a7a1 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.md index c82877de6c3..7793a265727 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.md index 5c10f6cbdf1..98680583edb 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index d8f60c2e8dc..b3a84a1bdae 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.md index b4f298485e2..6cc4b930cd5 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 1c8788694bb..e23199f16f8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.md index 1977a87b85b..b79d405de7b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.md index 4f69c995619..89f4ac68ac6 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.md index 322e103bb69..12ec1cf6cda 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 23ffaafd707..8d4eee99595 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.md index 16341d16bbb..fd2bd66f27e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.md index 5ab02e8d9f8..d557c27c64e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.md index d2d5a3b35f2..e33b1d7287c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.md index 8908d246c8a..e544ea1e329 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.md index e10f63821c4..6b0d3d26d18 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.md index b87d35504ed..28725d698d4 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.md index d56bc37f451..3de16cb4874 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.md index f812084e487..62377a6b7dd 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.md index 9befcf9b96f..69c70c38e1e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.md index 85bc2384e0e..65360bf6bf8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.md index 09f3985aeee..30b2cf4b5fd 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CollectLinearFunctions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Run the CollectLinearFunctions pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.md index 422331d9823..f28446603fc 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.md index f9b45cd59c5..753d9192ec0 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.md index db4f7da294d..003f0d3d92b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.md index 556f9afbdab..648990c1ed6 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(swap_strategy=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -91,7 +91,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -117,7 +117,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.md index 4190be77d7a..bbe91eb43e0 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.md index 0a05da8a616..ddbf3dca4eb 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.md index b1e7b0cc763..74a7fddb6c3 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.md index 8f50512e5e1..8a2f69449a9 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.md index af7fef0f2df..9045859cf9a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index d12620baca9..e7b048f93c9 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.md index a23dd090ef7..f568030804e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.md index 6656e020bfa..9d6c801d2e4 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.md index 59bf1ebe24f..fc6c57c2f91 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None, gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None, gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.md index abf1b3ce91b..87b9cde4058 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.md index 5cf7c90c957..2f0c6c4a532 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.md index d48959a781d..0e33496dbe5 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 60e934c9529..3194ae01f87 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.md index fb6400787ea..d1a626e90e9 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.md index e3eaf348f08..adb5bdce89c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.md index ca4f3698bdc..ad5c6aaca9b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.md index e001bac7d97..a89d3eb1003 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.md index 94f67d6a214..fa9bb23c36c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.md index dcd2dbdb4ed..c35408366c4 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.md index 06e8be15d09..fc4912804f8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.md index 786891a0918..deee0dfc57c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.md index 8029352bd2f..47d11fa5a0a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index 8561042dec8..79d5eda1e15 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index d5ec4f8545f..03c39ff570a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.md index 8bd0ba60919..9549a10b4eb 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 362c0b59e58..6633cb1e6a7 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index b4178062b15..8cd52a6cff8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.md index 7517b68fbde..c129b2c70a8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.md index be89787400c..d185df2391b 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 75840fd32b9..5a1d2ce0742 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 4b1b8edce11..9b33a8a9f6d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.md index d36a168b63f..e6bb5178fe2 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 5155759e372..b15a18658fa 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.md index 0da636cd94f..1f31897f909 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 8e769817e50..5877b0db349 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -33,7 +33,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -66,7 +66,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") **Parameters** @@ -113,7 +113,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 6ae8d049c42..bdcdcc40756 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder") @@ -35,7 +35,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.md index ce518b6f89e..df241023587 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 937f304f740..34b6325a948 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 2fc91761e78..c64c43e122f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.md index b924921c1e7..9fb8bc650f8 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.md index 0d9ad10a9d2..3f4f31c678e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.md index cc2b65b4c0c..f70bf598f35 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.md index 6fcf8f12c15..8c3fb4f8d1d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.md index f6ca4d6c5e3..28cc6c0ec9a 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.md index 69c50109f90..bf5bb512187 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.md index 3d58ce54250..a285ae7e9ca 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.md index b62f7f4878f..ab66e85056c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.md index 0743a593485..173b10423f9 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.md index f2109c58e99..034cc5cb1ee 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.md index d52a0c81ffa..af74a407f06 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.md index 6c7f6226237..c04092bb876 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 92e5cdfc74d..e9f18187ecd 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.md index 6ef353882bd..67d9651564c 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.md index 62e203c09d8..c7e24a98edc 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.md index 5dabe456ffe..e1430059dac 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -54,7 +54,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.md index 6567629e2d2..786944c8943 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.md index b3413ce6465..444aa893952 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index fa310ae0e91..fd87ce98d06 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index d98b59d2236..f1ae89c1b37 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index f97036fd913..db4f00f964f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 912e4c99a2d..300e4cb6f30 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index 8c4a5e7e652..1c9b79bca06 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 283611e44e1..7134d7cf759 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index dba00d61d8e..ffff8355ada 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index d4674316d5b..ccaf1045a45 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.md index 91a0e0eea14..08681e35f51 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index e93f3ee2cb1..ab96df2711e 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index f3076809311..03086986058 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index fd5dd8c2f3a..2debe49ec93 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 3b0fd3970a5..99dd042916f 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index d72c40ba1eb..5bda3f0782d 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index eeae1b9da0b..dd146468938 100644 --- a/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.37/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.md index 10557ce7f23..69569d84a2c 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.37/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.37/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.37/qiskit.utils.apply_prefix.md index ada30896a58..d2ba35ed7d9 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.37/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.37/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.37/qiskit.utils.deprecate_arguments.md index 6b8211676e4..1852cd509a2 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.37/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.37/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.37/qiskit.utils.deprecate_function.md index 4d618856bdd..b4e0f410147 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.37/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.37/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.37/qiskit.utils.detach_prefix.md index 6e84580e2b6..debf9c40999 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.37/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.37/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.37/qiskit.utils.get_entangler_map.md index 32ef0f10a1c..9925bbfed31 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.37/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.37/qiskit.utils.has_aer.md b/docs/api/qiskit/0.37/qiskit.utils.has_aer.md index 4d2e83940e0..a0c79527ad6 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.37/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.37/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.37/qiskit.utils.has_ibmq.md index d4d571e981e..571adc3bed5 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.37/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.37/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.37/qiskit.utils.is_main_process.md index 5d426ac2785..20d71632557 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.37/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.37/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.37/qiskit.utils.local_hardware_info.md index 2678a0c2892..2b345c1076f 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.37/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.md index 4d36ed51c48..00b3ec84895 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.37/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.md index beb48019d41..56c2167ddc1 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.37/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.37/qiskit.utils.name_args.md b/docs/api/qiskit/0.37/qiskit.utils.name_args.md index d0683eaead1..5f3b328aa62 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.37/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.37/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.37/qiskit.utils.summarize_circuits.md index 9f634d9fd92..e6a7caac90b 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.37/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.37/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.37/qiskit.utils.validate_entangler_map.md index 74026c0f1bb..2db7c3961c2 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.37/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.37/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.37/qiskit.utils.wrap_method.md index f8e3079d1ea..640353a76d1 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.37/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.md index e1e521aecec..7492145f10f 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.37/qiskit.visualization.array_to_latex.md index 12a0f436664..4b06174f477 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.37/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.37/qiskit.visualization.circuit_drawer.md index 0fcecbfe6db..a19c3094011 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.37/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.37/qiskit.visualization.dag_drawer.md index cacda5da67b..2e6e5665f1b 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.37/qiskit.visualization.pass_manager_drawer.md index 6e186661290..bcab918330f 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_multivector.md index 8038307f5ef..f77c3ffc655 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_vector.md index a0ea3fc1916..5b831cbf524 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_circuit_layout.md index 35d94f061e7..c796fd159e6 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_coupling_map.md index 8b48039cf69..5922dfa5a3f 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_error_map.md index 0c6e33ccf80..63bebc4fc68 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_gate_map.md index bc494cb9efa..911cd4e8cb5 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_histogram.md index 0b4b341645d..9fd336dab98 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_city.md index 3bc81d0187e..b7a2dcbb7ec 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_hinton.md index b143c2d2529..e210917ff02 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_paulivec.md index 857c04e3e65..99673c78e4e 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_qsphere.md index faa37e61b5c..c35edff2f4b 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.md index 4c479861afd..43f23ad7dca 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.md index 027edf6bafb..481c6c1280a 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.md index 620232e4924..a07e6d16b4d 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.draw.md index 367fd4598a7..e3d5eca74b9 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.md index 14a7cd44762..8ae0b1f8e84 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.37/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.37/qiskit.visualization.timeline.draw.md index e4c1ae790c3..c2854e14a5c 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.37/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.37/qiskit.visualization.visualize_transition.md index ed425b4d9f7..5efb3da3ff9 100644 --- a/docs/api/qiskit/0.37/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.37/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.37/synthesis_aqc.md b/docs/api/qiskit/0.37/synthesis_aqc.md index 6ca9598396a..f3f53c8afce 100644 --- a/docs/api/qiskit/0.37/synthesis_aqc.md +++ b/docs/api/qiskit/0.37/synthesis_aqc.md @@ -127,7 +127,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.37/utils.md b/docs/api/qiskit/0.37/utils.md index 1e8ccbfeb2c..11b793d0fa9 100644 --- a/docs/api/qiskit/0.37/utils.md +++ b/docs/api/qiskit/0.37/utils.md @@ -109,7 +109,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -230,7 +230,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -244,7 +244,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From c5778c50b309db0d982f4b344172eb8db2b74af1 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:44:49 +0100 Subject: [PATCH 18/41] Regenerate qiskit 0.38.0 --- docs/api/qiskit/0.38/execute.md | 2 +- docs/api/qiskit/0.38/pulse.md | 8 +- .../0.38/qiskit.algorithms.AlgorithmError.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.38/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.38/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.38/qiskit.algorithms.Grover.md | 8 +- .../0.38/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../0.38/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.38/qiskit.algorithms.QAOA.md | 2 +- .../0.38/qiskit.algorithms.RealEvolver.md | 4 +- .../api/qiskit/0.38/qiskit.algorithms.Shor.md | 8 +- .../0.38/qiskit.algorithms.ShorResult.md | 2 +- .../0.38/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.38/qiskit.algorithms.VQD.md | 14 +- docs/api/qiskit/0.38/qiskit.algorithms.VQE.md | 14 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 8 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- .../0.38/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.38/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.38/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.38/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.38/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.38/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 6 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.38/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.38/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- .../0.38/qiskit.algorithms.optimizers.TNC.md | 2 +- .../0.38/qiskit.algorithms.optimizers.UMDA.md | 6 +- .../qiskit/0.38/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.38/qiskit.assembler.disassemble.md | 2 +- .../0.38/qiskit.circuit.AncillaQubit.md | 2 +- .../0.38/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.38/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.38/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.38/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.38/qiskit.circuit.Clbit.md | 2 +- .../0.38/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.38/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.38/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.38/qiskit.circuit.Delay.md | 12 +- .../0.38/qiskit.circuit.EquivalenceLibrary.md | 12 +- .../qiskit/0.38/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.38/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.38/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.38/qiskit.circuit.Instruction.md | 26 +- .../0.38/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.38/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.38/qiskit.circuit.ParameterVector.md | 6 +- .../0.38/qiskit.circuit.QuantumCircuit.md | 230 +++++++++--------- .../0.38/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.38/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.38/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.AND.md | 2 +- .../0.38/qiskit.circuit.library.Barrier.md | 8 +- .../0.38/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.38/qiskit.circuit.library.C3XGate.md | 6 +- .../0.38/qiskit.circuit.library.C4XGate.md | 6 +- .../0.38/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.38/qiskit.circuit.library.CHGate.md | 4 +- .../0.38/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.38/qiskit.circuit.library.CRXGate.md | 4 +- .../0.38/qiskit.circuit.library.CRYGate.md | 4 +- .../0.38/qiskit.circuit.library.CRZGate.md | 4 +- .../0.38/qiskit.circuit.library.CSXGate.md | 2 +- .../0.38/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.38/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.38/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.38/qiskit.circuit.library.CUGate.md | 4 +- .../0.38/qiskit.circuit.library.CXGate.md | 6 +- .../0.38/qiskit.circuit.library.CYGate.md | 4 +- .../0.38/qiskit.circuit.library.CZGate.md | 4 +- .../0.38/qiskit.circuit.library.DCXGate.md | 2 +- .../0.38/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.38/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.GRZ.md | 2 +- .../0.38/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.38/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.38/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.38/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.38/qiskit.circuit.library.MCMT.md | 6 +- .../0.38/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.38/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.38/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.38/qiskit.circuit.library.MSGate.md | 2 +- .../0.38/qiskit.circuit.library.Measure.md | 4 +- .../0.38/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.38/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.38/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.38/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.38/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.38/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.38/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.38/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.38/qiskit.circuit.library.RGate.md | 4 +- .../0.38/qiskit.circuit.library.RVGate.md | 6 +- .../0.38/qiskit.circuit.library.RXGate.md | 6 +- .../0.38/qiskit.circuit.library.RXXGate.md | 4 +- .../0.38/qiskit.circuit.library.RYGate.md | 6 +- .../0.38/qiskit.circuit.library.RYYGate.md | 4 +- .../0.38/qiskit.circuit.library.RZGate.md | 6 +- .../0.38/qiskit.circuit.library.RZXGate.md | 4 +- .../0.38/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.38/qiskit.circuit.library.Reset.md | 4 +- .../0.38/qiskit.circuit.library.SGate.md | 4 +- .../0.38/qiskit.circuit.library.SXGate.md | 6 +- .../0.38/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.38/qiskit.circuit.library.SdgGate.md | 4 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.38/qiskit.circuit.library.SwapGate.md | 6 +- .../0.38/qiskit.circuit.library.TGate.md | 4 +- .../0.38/qiskit.circuit.library.TdgGate.md | 4 +- .../0.38/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.38/qiskit.circuit.library.U1Gate.md | 6 +- .../0.38/qiskit.circuit.library.U2Gate.md | 4 +- .../0.38/qiskit.circuit.library.U3Gate.md | 6 +- .../0.38/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.38/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.38/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 4 +- .../qiskit.circuit.library.XXPlusYYGate.md | 4 +- .../0.38/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.38/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.38/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.38/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.38/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.38/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.38/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.38/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.38/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.38/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.38/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.38/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.38/qiskit.compiler.transpile.md | 2 +- .../0.38/qiskit.converters.ast_to_dag.md | 2 +- .../0.38/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.38/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.38/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.38/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.38/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.38/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.38/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.38/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.38/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.38/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.38/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.38/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.38/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.38/qiskit.extensions.Snapshot.md | 8 +- .../0.38/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.38/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.38/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.38/qiskit.extensions.UCRZGate.md | 2 +- .../0.38/qiskit.extensions.UnitaryGate.md | 16 +- .../qiskit/0.38/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.38/qiskit.opflow.OpflowError.md | 2 +- .../0.38/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.38/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.38/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.38/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.38/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.38/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.38/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.38/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.38/qiskit.opflow.gradients.QFI.md | 4 +- .../0.38/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.38/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.38/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.38/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.38/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 +-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 12 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.38/qiskit.opflow.state_fns.StateFn.md | 40 +-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../0.38/qiskit.primitives.BaseEstimator.md | 4 +- .../0.38/qiskit.primitives.BaseSampler.md | 4 +- .../0.38/qiskit.primitives.Estimator.md | 4 +- .../0.38/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.38/qiskit.primitives.Sampler.md | 4 +- .../0.38/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.38/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.38/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.38/qiskit.providers.BackendV2.md | 16 +- docs/api/qiskit/0.38/qiskit.providers.Job.md | 2 +- .../qiskit/0.38/qiskit.providers.JobError.md | 2 +- .../qiskit/0.38/qiskit.providers.JobStatus.md | 2 +- .../0.38/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.38/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.38/qiskit.providers.Options.md | 8 +- .../qiskit/0.38/qiskit.providers.Provider.md | 2 +- .../0.38/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.38/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.38/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.38/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.38/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.38/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.38/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.38/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.38/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.38/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.38/qiskit.pulse.ScheduleBlock.md | 22 +- .../0.38/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.38/qiskit.pulse.builder.align_func.md | 2 +- .../0.38/qiskit.pulse.builder.align_left.md | 2 +- .../0.38/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.38/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.delay.md | 2 +- .../0.38/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.38/qiskit.pulse.builder.inline.md | 2 +- .../0.38/qiskit.pulse.builder.measure.md | 2 +- .../0.38/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.38/qiskit.pulse.builder.num_qubits.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.pad.md | 2 +- .../0.38/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.38/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.38/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.38/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.38/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.38/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.38/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.38/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.38/qiskit.pulse.instructions.Call.md | 6 +- .../0.38/qiskit.pulse.instructions.Delay.md | 4 +- .../0.38/qiskit.pulse.instructions.Play.md | 4 +- .../qiskit.pulse.instructions.SetFrequency.md | 4 +- .../qiskit.pulse.instructions.SetPhase.md | 4 +- ...iskit.pulse.instructions.ShiftFrequency.md | 4 +- .../qiskit.pulse.instructions.ShiftPhase.md | 4 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.38/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.38/qiskit.pulse.library.Drag.md | 2 +- .../0.38/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- .../0.38/qiskit.pulse.library.Waveform.md | 4 +- .../qiskit/0.38/qiskit.pulse.library.cos.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.38/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.38/qiskit.pulse.library.sech.md | 2 +- .../0.38/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.38/qiskit.pulse.library.sin.md | 2 +- .../0.38/qiskit.pulse.library.square.md | 2 +- .../0.38/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.38/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.38/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.38/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.38/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.38/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.38/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.38/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.38/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.38/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.38/qiskit.qasm.QasmTerminalStyle.md | 2 +- docs/api/qiskit/0.38/qiskit.qasm3.Exporter.md | 6 +- docs/api/qiskit/0.38/qiskit.qasm3.dump.md | 2 +- docs/api/qiskit/0.38/qiskit.qasm3.dumps.md | 2 +- .../0.38/qiskit.qobj.GateCalibration.md | 6 +- .../0.38/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.md | 6 +- .../0.38/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.38/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.38/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.38/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.38/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.38/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.38/qiskit.qobj.Qobj.md | 2 +- .../0.38/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.38/qiskit.qobj.QobjHeader.md | 2 +- .../0.38/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.38/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.38/qiskit.qpy.load.md | 2 +- .../0.38/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.38/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.38/qiskit.quantum_info.Choi.md | 12 +- .../0.38/qiskit.quantum_info.Clifford.md | 32 +-- .../0.38/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.38/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.38/qiskit.quantum_info.Operator.md | 28 +-- .../qiskit/0.38/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.38/qiskit.quantum_info.Pauli.md | 38 +-- .../0.38/qiskit.quantum_info.PauliList.md | 54 ++-- .../0.38/qiskit.quantum_info.PauliTable.md | 40 +-- .../0.38/qiskit.quantum_info.Quaternion.md | 14 +- .../0.38/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.38/qiskit.quantum_info.SparsePauliOp.md | 42 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.38/qiskit.quantum_info.Statevector.md | 40 +-- .../0.38/qiskit.quantum_info.Stinespring.md | 14 +- .../0.38/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.38/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.38/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.38/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.38/qiskit.quantum_info.entropy.md | 2 +- .../0.38/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.38/qiskit.quantum_info.partial_trace.md | 2 +- .../0.38/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.38/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.38/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.38/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.38/qiskit.result.ProbDistribution.md | 6 +- .../0.38/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.38/qiskit.result.Result.md | 16 +- .../qiskit/0.38/qiskit.result.ResultError.md | 2 +- .../0.38/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.38/qiskit.result.marginal_memory.md | 2 +- .../0.38/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.38/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.38/qiskit.synthesis.ProductFormula.md | 2 +- .../0.38/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../0.38/qiskit.tools.backend_monitor.md | 2 +- .../0.38/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.38/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.38/qiskit.tools.parallel_map.md | 2 +- .../0.38/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.38/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.38/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.38/qiskit.transpiler.Layout.md | 30 +-- .../0.38/qiskit.transpiler.PassManager.md | 14 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.38/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 12 +- .../qiskit/0.38/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.38/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.38/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...ranspiler.passes.CollectLinearFunctions.md | 4 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- .../0.38/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.38/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 4 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- .../0.38/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.38/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.38/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.38/qiskit.transpiler.passes.Width.md | 4 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- .../0.38/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.38/qiskit.utils.apply_prefix.md | 2 +- .../0.38/qiskit.utils.deprecate_arguments.md | 2 +- .../0.38/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.38/qiskit.utils.detach_prefix.md | 2 +- .../0.38/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.38/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.38/qiskit.utils.has_ibmq.md | 2 +- .../0.38/qiskit.utils.is_main_process.md | 2 +- .../0.38/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 6 +- .../api/qiskit/0.38/qiskit.utils.name_args.md | 2 +- .../0.38/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.38/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.38/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.38/qiskit_aer.AerError.md | 2 +- .../api/qiskit/0.38/qiskit_aer.AerProvider.md | 6 +- .../qiskit/0.38/qiskit_aer.AerSimulator.md | 14 +- .../qiskit/0.38/qiskit_aer.PulseSimulator.md | 8 +- .../qiskit/0.38/qiskit_aer.QasmSimulator.md | 12 +- .../0.38/qiskit_aer.StatevectorSimulator.md | 8 +- .../0.38/qiskit_aer.UnitarySimulator.md | 8 +- .../api/qiskit/0.38/qiskit_aer.jobs.AerJob.md | 16 +- .../qiskit/0.38/qiskit_aer.jobs.AerJobSet.md | 20 +- .../0.38/qiskit_aer.library.SaveAmplitudes.md | 2 +- ...iskit_aer.library.SaveAmplitudesSquared.md | 2 +- .../0.38/qiskit_aer.library.SaveClifford.md | 2 +- .../qiskit_aer.library.SaveDensityMatrix.md | 2 +- ...qiskit_aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...skit_aer.library.SaveMatrixProductState.md | 2 +- .../qiskit_aer.library.SaveProbabilities.md | 2 +- ...iskit_aer.library.SaveProbabilitiesDict.md | 2 +- .../0.38/qiskit_aer.library.SaveStabilizer.md | 2 +- .../0.38/qiskit_aer.library.SaveState.md | 2 +- .../qiskit_aer.library.SaveStatevector.md | 2 +- .../qiskit_aer.library.SaveStatevectorDict.md | 2 +- .../0.38/qiskit_aer.library.SaveSuperOp.md | 2 +- .../0.38/qiskit_aer.library.SaveUnitary.md | 2 +- .../qiskit_aer.library.SetDensityMatrix.md | 2 +- ...iskit_aer.library.SetMatrixProductState.md | 2 +- .../0.38/qiskit_aer.library.SetStabilizer.md | 2 +- .../0.38/qiskit_aer.library.SetStatevector.md | 2 +- .../0.38/qiskit_aer.library.SetSuperOp.md | 2 +- .../0.38/qiskit_aer.library.SetUnitary.md | 2 +- .../qiskit_aer.library.save_amplitudes.md | 2 +- ...kit_aer.library.save_amplitudes_squared.md | 2 +- .../0.38/qiskit_aer.library.save_clifford.md | 2 +- .../qiskit_aer.library.save_density_matrix.md | 2 +- ...skit_aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...t_aer.library.save_matrix_product_state.md | 2 +- .../qiskit_aer.library.save_probabilities.md | 2 +- ...kit_aer.library.save_probabilities_dict.md | 2 +- .../qiskit_aer.library.save_stabilizer.md | 2 +- .../0.38/qiskit_aer.library.save_state.md | 2 +- .../qiskit_aer.library.save_statevector.md | 2 +- ...iskit_aer.library.save_statevector_dict.md | 2 +- .../0.38/qiskit_aer.library.save_superop.md | 2 +- .../0.38/qiskit_aer.library.save_unitary.md | 2 +- .../qiskit_aer.library.set_density_matrix.md | 2 +- ...it_aer.library.set_matrix_product_state.md | 2 +- .../0.38/qiskit_aer.library.set_stabilizer.md | 2 +- .../qiskit_aer.library.set_statevector.md | 2 +- .../0.38/qiskit_aer.library.set_superop.md | 2 +- .../0.38/qiskit_aer.library.set_unitary.md | 2 +- .../0.38/qiskit_aer.noise.LocalNoisePass.md | 4 +- .../0.38/qiskit_aer.noise.NoiseModel.md | 24 +- .../0.38/qiskit_aer.noise.QuantumError.md | 24 +- .../0.38/qiskit_aer.noise.ReadoutError.md | 24 +- .../qiskit_aer.noise.RelaxationNoisePass.md | 2 +- ...iskit_aer.noise.amplitude_damping_error.md | 2 +- ...qiskit_aer.noise.coherent_unitary_error.md | 2 +- .../qiskit_aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...skit_aer.noise.device.gate_error_values.md | 2 +- ...kit_aer.noise.device.gate_length_values.md | 2 +- ...skit_aer.noise.device.gate_param_values.md | 2 +- ...t_aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../0.38/qiskit_aer.noise.kraus_error.md | 2 +- .../qiskit_aer.noise.mixed_unitary_error.md | 2 +- .../0.38/qiskit_aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- .../qiskit_aer.noise.phase_damping_error.md | 2 +- .../0.38/qiskit_aer.noise.reset_error.md | 2 +- ...skit_aer.noise.thermal_relaxation_error.md | 2 +- .../0.38/qiskit_aer.primitives.Estimator.md | 4 +- .../0.38/qiskit_aer.primitives.Sampler.md | 4 +- .../0.38/qiskit_aer.pulse.PulseSystemModel.md | 10 +- .../qiskit_aer.pulse.duffing_system_model.md | 2 +- .../qiskit_aer.quantum_info.AerStatevector.md | 14 +- .../0.38/qiskit_aer.utils.NoiseTransformer.md | 36 +-- ...iskit_aer.utils.approximate_noise_model.md | 2 +- ...kit_aer.utils.approximate_quantum_error.md | 2 +- .../0.38/qiskit_aer.utils.insert_noise.md | 2 +- .../qiskit_aer.utils.remap_noise_model.md | 2 +- .../qiskit_aer.utils.transform_noise_model.md | 2 +- .../qiskit_aer.utils.transpile_noise_model.md | 2 +- ...iskit_aer.utils.transpile_quantum_error.md | 2 +- docs/api/qiskit/0.38/synthesis_aqc.md | 2 +- docs/api/qiskit/0.38/utils.md | 6 +- 1001 files changed, 2750 insertions(+), 2750 deletions(-) diff --git a/docs/api/qiskit/0.38/execute.md b/docs/api/qiskit/0.38/execute.md index a17746f7189..b985ccabdba 100644 --- a/docs/api/qiskit/0.38/execute.md +++ b/docs/api/qiskit/0.38/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.38/pulse.md b/docs/api/qiskit/0.38/pulse.md index 78a69057c3d..4ed4f2ec629 100644 --- a/docs/api/qiskit/0.38/pulse.md +++ b/docs/api/qiskit/0.38/pulse.md @@ -66,7 +66,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -226,7 +226,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -668,7 +668,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.md index b0fed3020bb..a9a7ecc5fa6 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.md index 9df139d438c..8d0e3536038 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.md index b664511d8b1..73182e78add 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.md index 03251e09098..0d3c0c02e88 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -101,7 +101,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -146,7 +146,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.md index 83121015046..ee7fa67d9ea 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.md index 4d81fb54c0c..9bebb360d87 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.md index 509c33d52f0..1b5cf41eb84 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.md index d3ed7f38f61..aa7bcebadbd 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.md index d8ba140394b..f30112d54bd 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.md index 0eafb70f99d..323e7603d22 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.md index 1fc10d8edc4..fbe6103cd3f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state, aux_operators=None, truncation_threshold=1e-12, t_param=None, hamiltonian_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state, aux_operators=None, truncation_threshold=1e-12, t_param=None, hamiltonian_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.md index 1c8ede9bff9..c124fc4f563 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.md index 89f158be231..9e54c94e6a8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.md index adb1f75b096..81ee1ea3c56 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.38/qiskit.algorithms.Grover.md index 556ff14562e..500a97f2ba8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -93,7 +93,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -118,7 +118,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -144,7 +144,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.md index 424fe1346fd..aa788a7cdd9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.md index 7dc61fa73dd..b9d37191884 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 0cc2ae79c54..2ad720e3034 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.md index 3565dac9725..5d4221bc7d6 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.md index 60135699e68..52fb555bfef 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -53,7 +53,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -77,7 +77,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 61b110204fd..3f40c3f11d9 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.md index 95a395f7dd1..c03d30ab92f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -37,7 +37,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -63,7 +63,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 76f8483cbe9..673962c144a 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -44,7 +44,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -74,7 +74,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -99,7 +99,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -120,7 +120,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5104226d362..cd72b04f885 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.md index 9152055b8b2..eac4113da04 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -45,7 +45,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.md index 121b3bcc29b..bebfbabfdbd 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.md index 85a3ce17fda..d7ef5fc96c7 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -33,7 +33,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -54,7 +54,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.md index b2cbe61d186..2ba42040301 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -26,7 +26,7 @@ The Numpy Minimum Eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.md index ef3376fa89b..9a62f0d81d0 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -61,7 +61,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -75,7 +75,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary=None, state_preparation=None, pe_circuit=None, num_unitary_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -96,7 +96,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.md index 07a57d9d773..430d452c695 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.md index 2b5b3901ae5..b534c08d4cf 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.md index 1fb9890da09..330d37eed59 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.md index f2d11107ced..37ec009cf85 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.38/qiskit.algorithms.Shor.md index e3950930788..e9708696437 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -54,7 +54,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -82,7 +82,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.md index 4bfd0a02f77..665b902ca3a 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.md index 5e81a09442c..a39de3334cb 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -76,7 +76,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.38/qiskit.algorithms.VQD.md index 8e17e6f3733..0b0948b0189 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -46,7 +46,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -67,7 +67,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -88,7 +88,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -115,7 +115,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -145,7 +145,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -161,7 +161,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.38/qiskit.algorithms.VQE.md index d1cc29fbcd2..59894959a1f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -74,7 +74,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -95,7 +95,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -116,7 +116,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -143,7 +143,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -170,7 +170,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -186,7 +186,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.38/qiskit.algorithms.eval_observables.md index febfacd4c18..f8799bcf96c 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/aux_ops_evaluator.py "view source code") Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index ed27b9c91ec..3a46507a905 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -54,7 +54,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -74,7 +74,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -94,7 +94,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -114,7 +114,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.md index 5cc09e47bf7..eaff0e34e98 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -66,7 +66,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -94,7 +94,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.md index 14938f15008..0a79d614cee 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.md index dd442832305..c1b10a16091 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index ec626df9a4e..7bba6518ecb 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -512,7 +512,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1167,7 +1167,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2218,7 +2218,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index 2bae5d34d71..a3675782801 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ An abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 3a127b1ed6f..e284fe97bf8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -69,7 +69,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -89,7 +89,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -109,7 +109,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -129,7 +129,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index b933349b139..e2dba6186f4 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -42,7 +42,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.md index cc0ff076413..bcf5426d2ce 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -535,7 +535,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1190,7 +1190,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1727,7 +1727,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2241,7 +2241,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index bed3fec7d4e..e5a63cf5f6f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -548,7 +548,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1203,7 +1203,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1740,7 +1740,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2254,7 +2254,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.md index 1cb8688928e..894b499136c 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.md index 7544a0d591c..558c4585b08 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.md index a648a1877f4..b614e37a57f 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.md index 5a3c454ee58..4e6b250eeb3 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.md index bc57da09bc2..be44deb46ce 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.md index e4223a487f8..d8a7a046deb 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.md index 391659e822c..3203ca42762 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index b6a3aea03e8..a2c4729a203 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.md index a255d933e97..2d457a019ea 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.md index bdfcaa5b31a..8b67d0f4899 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.md index 99bc8ac4945..715b5a3f2d8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -95,7 +95,7 @@ print(f"Found minimum {x_opt} at a value of {fx_opt} using {nfevs} evaluations." -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -126,7 +126,7 @@ grad -`GradientDescent.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.md index 1324484d666..06e5745cf0e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.md index ad7878ee38b..9cc66a7db55 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.md index abc54192c33..ff5a1f71011 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=1000, maxiter=15000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, epsilon=1e-08, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.md index 9dda785473e..dcdc693575e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.md index 0f67766227d..f104446a4cc 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.md index 06a8e016367..778fdd7491d 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.md index 9448b48f246..237ae14428b 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.md index 0feaf00fe83..7d5af1edf57 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 70c8b675948..80667952f92 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.md index f51710209d9..4f4a5948bb6 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.md index e6d6ee22d92..3e292c95b1b 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.md index 78539300626..da4928e7f47 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -125,7 +125,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.md index 37ecfdb60b7..6b96077fd76 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.md index c72764e743e..b49e6d36348 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.md index 1412a12a915..8e11a1d3e41 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.md index 2e010229187..f845e57f356 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.md index 1d1df375bf0..d857a73840e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.md index ca77b9084a5..9461cbfe252 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.md index e265b689e6c..7a01daab1a0 100644 --- a/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.38/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.38/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.38/qiskit.assembler.assemble_circuits.md index f9e300f0673..f81988a18b2 100644 --- a/docs/api/qiskit/0.38/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.38/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.38/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.38/qiskit.assembler.assemble_schedules.md index 346b1237212..0cc2fa90802 100644 --- a/docs/api/qiskit/0.38/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.38/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.38/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.38/qiskit.assembler.disassemble.md index d768c0b9789..aae6f3b0ade 100644 --- a/docs/api/qiskit/0.38/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.38/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.md index 7764648d58c..ac6f9e5a828 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.md index 31b327569d8..3eedaa24a19 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.md index a949986bddb..0ee88f643e0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.md index 07b8170ee06..a1646efc135 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.md index a4e947082c6..b5d6ba4e3d7 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.38/qiskit.circuit.Clbit.md index d8e609ae094..6a54840e2ef 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.md index 919021aa97a..e6cfabf8f6c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.md index f855010fa63..e8027b1a1bd 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.md index 042424ec55d..5b67cda240b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -224,7 +224,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Delay.md b/docs/api/qiskit/0.38/qiskit.circuit.Delay.md index 535ce9f99cf..5ddc938d076 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.md index 13122fcab8b..8686fcf8d94 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.md index 9e84829e9f0..94b0da1b9cb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Gate.md b/docs/api/qiskit/0.38/qiskit.circuit.Gate.md index a74275d117d..bc58366d323 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.md index 76d9a331625..bd9883d1d24 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.38/qiskit.circuit.Instruction.md index 7defa08fdf8..0e1a7ef0ce6 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.md index 8a2b291381d..5ea20b28d31 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -85,7 +85,7 @@ This same instance of [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.c -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.38/qiskit.circuit.Parameter.md index a3ea550929a..00193b9ccd1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -206,7 +206,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.md index 6273fef38c9..25b9e7ecfd6 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -218,7 +218,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.md index 97bd45ceec5..03e33758ee0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.md index bc5a9d3f058..2c849aa242e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -139,7 +139,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -162,7 +162,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -174,7 +174,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -204,7 +204,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -308,7 +308,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -324,7 +324,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -353,7 +353,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -377,7 +377,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -389,7 +389,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -409,7 +409,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -434,7 +434,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -459,7 +459,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -473,7 +473,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -485,7 +485,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -497,7 +497,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -526,7 +526,7 @@ A handle to the instructions created. -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -554,7 +554,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -610,7 +610,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -634,7 +634,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -660,7 +660,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -680,7 +680,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -706,7 +706,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -722,7 +722,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -748,7 +748,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -774,7 +774,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -800,7 +800,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -826,7 +826,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -852,7 +852,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -877,7 +877,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -906,7 +906,7 @@ A handle to the instructions created. -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -932,7 +932,7 @@ A handle to the instructions created. -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -960,7 +960,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -985,7 +985,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -1010,7 +1010,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -1035,7 +1035,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1058,7 +1058,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1079,7 +1079,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1105,7 +1105,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1156,7 +1156,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1230,7 +1230,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1253,7 +1253,7 @@ A handle to the instructions created. -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -1281,7 +1281,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1312,7 +1312,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1367,7 +1367,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1395,7 +1395,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1415,7 +1415,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1435,7 +1435,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1455,7 +1455,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1485,7 +1485,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1493,7 +1493,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1513,7 +1513,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1535,7 +1535,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1561,7 +1561,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1607,7 +1607,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1782,7 +1782,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1884,7 +1884,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1907,7 +1907,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1993,7 +1993,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2034,7 +2034,7 @@ A handle to the instructions created. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -2058,7 +2058,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2095,7 +2095,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2120,7 +2120,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2142,7 +2142,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2171,7 +2171,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2194,7 +2194,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2214,7 +2214,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2228,7 +2228,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2244,7 +2244,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2256,7 +2256,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2279,7 +2279,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2300,7 +2300,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2439,7 +2439,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2466,7 +2466,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2486,7 +2486,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2506,7 +2506,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2533,7 +2533,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2560,7 +2560,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2584,7 +2584,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2609,7 +2609,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2633,7 +2633,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2655,7 +2655,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2675,7 +2675,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2695,7 +2695,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2749,7 +2749,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2789,7 +2789,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2816,7 +2816,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2840,7 +2840,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2864,7 +2864,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2888,7 +2888,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2912,7 +2912,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2935,7 +2935,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2959,7 +2959,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2983,7 +2983,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3395,7 +3395,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3563,7 +3563,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3641,7 +3641,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3664,7 +3664,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3686,7 +3686,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3708,7 +3708,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3730,7 +3730,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3752,7 +3752,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3805,7 +3805,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3826,7 +3826,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3847,7 +3847,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3875,7 +3875,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3900,7 +3900,7 @@ A handle to the instructions created. -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -3923,7 +3923,7 @@ A handle to the instructions created. -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -3947,7 +3947,7 @@ A handle to the instructions created. -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -4107,7 +4107,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -4152,7 +4152,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -4168,7 +4168,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4191,7 +4191,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4213,7 +4213,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.md index 85e9b11e6e3..a046bf78aa9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.38/qiskit.circuit.Qubit.md index 768ad4c74e5..3fc0bcbbba5 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.md index 1c5c997f07f..ebdb15aba67 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.md index c7a369d597b..ab5aca189a8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.md index 4cd83562974..a3d9fe226f5 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 038ae519bdc..aeaba018123 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 71c633bfcca..86bc8d41372 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.38/qiskit.circuit.library.AND.md index 685f55674bb..18e1ce26ecd 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.md index 49d1d038a95..794c393b04d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.md index 535c909d083..adf7f14a007 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.md index d0e46122f22..0b032c6b44c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.md index 20b6f31ce0a..5ba6d862ef2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.md index 529dc6eeb45..52dcae8c322 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.md index 7bcc7b9e23b..fbadf3f8de3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.md index 6d3cf3f6e4c..1f49edc69ae 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.md index 2daeebc27bc..4d86068e71a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.md index a6a030e94a6..18ec5102b4b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.md index 1541b328234..e79fa04d797 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.md index 54cd97d8b99..44bced9e831 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.md index 2cdca4fc66c..7e31ffbba9d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.md index 96d43432174..b5f84d8a274 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.md index 2bfcef043d8..df2f04bd4e1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.md index dd009422f01..dfd5f2af299 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.md index 1d94a2d4193..490d09fdfc0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.md index dd546097b30..da1a791d2bf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.md index 2ed5c8176f2..35422546aa8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.md index 057927e667e..6e57c923d44 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.md index f181c55da90..bb33601a92a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.md index febfdd5c704..721b17473ef 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.md index 2872a099723..808dc79f73c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.md index 43eea9712ad..b5539f23974 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.md index e1642461831..7eb2ad7e091 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.md index db792d75345..80b6dcf0986 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.md index 993c5541a04..ecc8a591ce7 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.md index e6e293ddf05..62db9555f78 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.md index 1e3eae5c1a2..3a7e60eecf0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.md index f7c6b370781..78d02adc9ff 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.md index 6bccaa1d467..9c9e83caa81 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GR.md index aeb8c5a07b5..11eee7e45b0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.md index d32a54ac30a..10068e9af9c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.md index 75835c181ca..f6b5c0a10c3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.md index ec5de13de99..41160f20f03 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.md index 136ff409df6..b04a3db29ea 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.md index 259e2e42630..9365f2ed466 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.md index bb75a69eaa8..2adb25dff77 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.md index 95bee51223f..63a45331bf4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.md index 0cf5a1f247c..a018e2c4778 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.md index 78ab994d032..6b8d8e2c2b0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.md index 000e6b28c57..9daa5346440 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.md index aa50e8d0f93..007b5f03ef2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.md index 50788824442..6cba4e4c80d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.md index 771e52d08c4..8f1bba81d3e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.md index 0fb5acb7c94..ffeb80dd176 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.md index d166a7286a3..a5c62bd4b64 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.md index 425ddc3f10b..a62d57b59ae 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.md index edb047f31ff..c00d9202001 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.md index acfd6f54e90..40fd9036cc2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.md index 70257d44985..55174bb855e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.md index b648f932644..8c3390f1f1b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.md index b1e625bd023..296829d9896 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.md index 1e6e90b79c0..dc78ba07964 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.md index 6bec51ad49c..02a22ebb3b3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.md index 7a470a1782e..e2d7bddf593 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.md index 9a077b97397..50c37992a6e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.38/qiskit.circuit.library.OR.md index 802d00a75ce..efd2693a663 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.md index 35f88d8b212..4f64b8c5f51 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.md index 31ae9cdcc57..58bd154d923 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.md index c5e72b4045e..794f471cb74 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.md index 238012fc9db..0ed32b4898e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.md index 5eb746d53ca..d8e0c2ca953 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.md index bd81f2b1bb2..4593eab21a8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.md index 50c159518fa..2bca7d8f982 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.md index 2bc11334843..f29e67c8c55 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.md index 5d9fb649f7c..c6ea4180c63 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 3e7be0f44cc..9317c165efb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index e7bd0cb7662..cecfde3e607 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.md index 8a9d8ec176b..aa8673de18a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.md index cc9732da4d8..5bacf2099cf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.md index 417a55eb0de..6238d621bfc 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.md index b7076cfdb63..fec4136a8ca 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.md index 22e50752b9a..b0e4f4fbc8a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.md index fe3f7caf71f..2f78e167ddf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.md index 8167047768c..aa522abf3da 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.md index da81dfa5bd5..17aec80f634 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.md index 30ba630985a..a9245aad26b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.md index 1f30f3fee7b..db4196a2fb4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.md index 4906c9968b6..66ea33cafbf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.md index 7a0f17dc3d2..bcd36c54eaf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.md index 10715cda5eb..f0e67e77d2c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.md index ea69ae37eb1..b3aecf02ca9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.md index 478ab3cfc4c..f7d8a4a0971 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.md index d74c43b9da1..102fa12c0d6 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.md index c73ad699859..c481da5cb97 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.md index fb2a51bd8d4..7634f475606 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.md index b28ff5a3aeb..941c29347fa 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.md index 112911dcb34..3787b514f50 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.md index 4c222b7115a..7c15ac5a4ec 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.md index 0d243fd47c9..dcdad8c161e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.md index cb5c4d94e24..6f6e401259a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.md index f1b06425e26..913d0a74934 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.md index b825a03aa36..c1916cef904 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.md index b60eba2094d..bd948afd7d4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.md index 4cc11c78e58..0bfc1699556 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.md index c636080ea9d..40d491358d6 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -132,7 +132,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.md index 7448a312c4d..10ee8f1ed20 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.md index 00267efe6df..f90f839d625 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -60,7 +60,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.md index a45cb754397..1d23a1f82d2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.md index 252fbc8884b..323cb2b2f25 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.md index 79734a2db3f..42936e81bd3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.md index 10a7d6d3f9e..73c5c67f03f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.md index 05e41a79ab7..b62e5ca1697 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.md index 1a5cfc79528..09f614a2a39 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.md index dcb54a17fc6..1c4ab41cff2 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.md index 87ffe1a7fd2..db6b4a27f59 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.md index 4824c8c074d..0b40f2ce3cb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.md index 7c3261f0fe9..10ad096c816 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.md index cef16198c87..fefe739d51a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.md index d9669da38d0..7ceb6f0ebd0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_1.md index 68502a28a47..3c4c64baec0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_2.md index 54d15c5e597..eb264738f11 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_3.md index 32d4806b73c..7529929a5c9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_4.md index 10a2f397498..95d525034b5 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_3_1.md index c4f2f9b0cde..a1a4d9bbfc0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_1.md index 4189b09bb7e..78188355c16 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_2.md index a865e0d3f37..00cd32d5707 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_3.md index 2b0c301a0ba..2cdd4a6560f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_4.md index 9752623348b..7c525a8f567 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_5_1.md index a94d26df264..eb5e57bd546 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_1.md index 6a6a05ee095..721b6d74890 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_2.md index 9b1b1b60227..6bb63266684 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_3.md index 41b38a67823..086003cce00 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_4.md index f629ab88800..da501ee9abf 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_5.md index 4377f2e8d71..962c13012ef 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_1.md index 14f8a77e56c..60d3a142361 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_2.md index ac93623d8fb..58b072797da 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_3.md index 632c8df5c65..df247b55ac8 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.md index 342b32c09aa..7d2c120775f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_cy.md index 457dedb2ecd..99b817c4ae5 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_xz.md index 5dccf6d527c..2cd830fcd38 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_yz.md index f5e920774ae..b9e961c027b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz1.md index 1905e0926e8..1f043f92cd1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz2.md index a57c55a11dd..ae9de66b36d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz3.md index 350ff006b15..c6fa7bfce77 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index cf2ae9c6063..eb52ea133c0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index a2511d41b5f..c6c651945c0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index c206be49855..98d724eff6a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index f2a5be2a1f5..e26a0421faa 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index a1d404ca256..3ff6033563b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 68df75f914a..28dbbc5f5e4 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index b83a8ce36b4..6a4125d3682 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 612285a42ab..280d82b267f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 388ed8cdc9b..f1fe9ee5058 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index d3a7e87723d..333961285c3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index c3de71904e5..3505f5a3224 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index f9c6a3e2be5..65026119855 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index d5c985e0796..a0bb2e76a64 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 0f926c6dda2..627fb219194 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 46a6e27eb44..2f5f82f6eae 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index f8456b1431b..369d5aaa84d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 15f368c1916..578d6d6ce8f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index 726445eeb2d..8e046f83e51 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 53b82eaa9cb..e0014cba13f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 1e04d2caa69..93ce2c59649 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 2702d70ad2a..64ab667237f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index e2ff7a6f1f4..135e61f277c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index cd6187a120e..b8f9463abf9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 9555b3d2084..111444e1c8f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 77b0657c650..fbefcb8b4f9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 65b9e881cef..4b078bf8e38 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 3305f50da2d..8a012c27af7 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index dde19ae5be9..c96e50a1e92 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 46dd5306edf..0cc6288fe10 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 922381593cd..162ed425178 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index d6e5a41d2c2..fd3a6d226e9 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 07ebfa06168..e80f31b04cb 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index d217111888a..f6753583aad 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 8d28d26581a..1bc3ce9b67c 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 3d61e836fd5..db0dcda5fbd 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index b5b257a2490..12ef81f1e62 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 5be315f0fd5..f2e61ccd8a1 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 083e8f799d3..f6761b3d20a 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index c629014a532..39b49fd0ee3 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index 47dd64e0db1..55406b5018e 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index b129e6c9dea..46fb75a530b 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 138ea052eb4..0fbc533fe9f 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 41346e308d4..49e86957907 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 4a07bda68d4..f96421aea84 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index e8e5c579c54..55746b9f343 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index cc0189d8f5a..c4334091977 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index c6a7ba05459..3711adb4cf0 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.38/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.38/qiskit.circuit.random.random_circuit.md index 508d243035b..4135a9a773d 100644 --- a/docs/api/qiskit/0.38/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.38/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.38/qiskit.compiler.assemble.md b/docs/api/qiskit/0.38/qiskit.compiler.assemble.md index 56823f963b0..a475aa552aa 100644 --- a/docs/api/qiskit/0.38/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.38/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.38/qiskit.compiler.schedule.md b/docs/api/qiskit/0.38/qiskit.compiler.schedule.md index 42328394fcc..ff294cdf7ca 100644 --- a/docs/api/qiskit/0.38/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.38/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.38/qiskit.compiler.sequence.md b/docs/api/qiskit/0.38/qiskit.compiler.sequence.md index af389f4b77e..8f20db3e578 100644 --- a/docs/api/qiskit/0.38/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.38/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.38/qiskit.compiler.transpile.md b/docs/api/qiskit/0.38/qiskit.compiler.transpile.md index 483ef8aa8b1..e1b87cd235d 100644 --- a/docs/api/qiskit/0.38/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.38/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=None, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.38/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.38/qiskit.converters.ast_to_dag.md index 9eab48da67b..24879a5d505 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.38/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dag.md index 41fa309d5ab..fbf818413d7 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dagdependency.md index 792ca8469b3..352874f4dd9 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_gate.md index 40ab2e004c5..9edd2876e71 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_instruction.md index da0b8ad6e7d..bda42401821 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.38/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.38/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.38/qiskit.converters.dag_to_circuit.md index 8b3840aeafe..173a653a546 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.38/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.38/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.38/qiskit.converters.dag_to_dagdependency.md index 929e6edac0a..12123f48abe 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.38/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_circuit.md index 667c940d784..f32fea4411a 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_dag.md index 69ddfbd513f..c43690495f3 100644 --- a/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.38/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.md index 4562ba7520e..e9041dfbd26 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -238,7 +238,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -248,7 +248,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -260,7 +260,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -268,7 +268,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -292,7 +292,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -314,7 +314,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -341,7 +341,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -349,7 +349,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -365,7 +365,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -373,7 +373,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -393,7 +393,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -401,7 +401,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -409,7 +409,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -423,7 +423,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -431,7 +431,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -439,7 +439,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -447,7 +447,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -455,7 +455,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -475,7 +475,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -487,7 +487,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -508,7 +508,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -516,7 +516,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -524,7 +524,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -532,7 +532,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -553,7 +553,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -561,7 +561,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -569,7 +569,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -577,7 +577,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -585,7 +585,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -593,7 +593,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -601,7 +601,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -617,7 +617,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -630,7 +630,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -638,7 +638,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -646,7 +646,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -654,7 +654,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -664,7 +664,7 @@ Add edges from predecessors to successors. -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single. @@ -685,7 +685,7 @@ This is used to consolidate a block of DAGOpNodes into a single operation. A typ -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -701,7 +701,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -711,7 +711,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. @@ -719,7 +719,7 @@ Return the number of operations. -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -746,7 +746,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -772,7 +772,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -780,7 +780,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -788,7 +788,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -808,7 +808,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -830,7 +830,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -838,7 +838,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.md index ba56811ef98..2fc0a5992bd 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.md index 4c79999ab15..92918d5817c 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.md index 6e58666b883..43016ead74c 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.md index 5334a18d4e3..1ddcf3d443c 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.md index d7df81693b3..e272e3ae301 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.md index 635da7d71ee..2946413a8a7 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.md index 1b32eebc94e..2efe00ed95c 100644 --- a/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.38/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.md index b5f94a3944c..1b0c5f993a0 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.38/qiskit.extensions.Initialize.md index 32bea9cfa30..193283b4824 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.md index 2a1e69d9c05..04a183d552a 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.md index fc1b795b546..fa8bc352cad 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.md index a620cad05bf..1c4184725ec 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.md index 6729dee680e..ed48a443574 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.md index d865ce96a93..c6cf90ae3b8 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.md index 719876cc5fb..18ad5490db5 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.md index e370966451c..2f5345b7446 100644 --- a/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.38/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.md index bda021b1659..6255f5e0275 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.md index b81a33221aa..10d38469788 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.38/qiskit.opflow.anti_commutator.md index 94d94f9a8b9..8770564f9b6 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.commutator.md b/docs/api/qiskit/0.38/qiskit.opflow.commutator.md index 028f5c2c715..a36dd0b732f 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.md index ec70b1befdb..21a6703b50d 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.md index ce60bde81ce..64ef196bc71 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.md index 4471490c971..40ba15332db 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.md index c84ea78ab22..9d21684a858 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.md index 7b680142506..bd7659b0264 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.md index 5379c3a7dc2..dba9eea2b82 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.38/qiskit.opflow.double_commutator.md index fe0303511a7..262e4c5b16f 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.md index 8ec69e36674..2e3fbc591e4 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.md index fbcd225453e..ae12a5c131d 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.md index e031b668cf9..6c8b81ad998 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.md index 53691d7b393..b86adc980a9 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c9ab7f63244..fde3a46fbcd 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.md index fef7bebca7a..84fb49b0280 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.md index 3c4a01505f9..a262c58877d 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.md index 85eb320a568..b08ae7c9705 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.md index 814875ad672..c193b9e5c77 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.md index 42ce88cb68e..a23e9d4a457 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.md index 98d43b903b6..f5d354d9f20 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.md index c8b0ad6e734..a2e3de2fca2 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.md index 58705d64606..9b17374fa4a 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.md index 1d1d1d7cf0a..40efe47f7a2 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.md index 2cc190cb1bb..2df7095b268 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.md index 09e77b6e534..3cdeeb100e7 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.md index 5f8ef045adb..ef95a578831 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.md index a22bd08c594..d18264b265a 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.md index e289bbc8e84..f26f82595f1 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.md index d6cd31bd04f..1ac4f41e32e 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.md index 86272da56dd..a51663e2803 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.md index dcddacefd35..3a2e97c7b63 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.md index ccab2f39b10..3d6658e0cb6 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.md index 7ca03ff7680..4091a328ef2 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.md index 0abcc297b08..f6d59b1ec16 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.md index aeedc8aa0da..dacab7a7920 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.md index 97c88bb452c..01c6ebc41f1 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.md index 7a9794ada93..774f3c03fcf 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.md index 3f5b15124c8..8969c666238 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.md index 6b9758f5414..550afaf9bcb 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.md index 01651a9865e..2c008853c65 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.md index 291e168e5d8..f839e09f9c3 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.md index 3f563c0eb24..2e4d635a55b 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.md index 614b698244f..a791585abee 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -181,7 +181,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -193,7 +193,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -215,7 +215,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -235,7 +235,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -259,7 +259,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -275,7 +275,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -296,7 +296,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.md index 752f4c66aef..547c213b633 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 1f2b55a1bbf..a5536aa05c2 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.md index b3d1bad4ff9..cbd0ba72f04 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -66,7 +66,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -82,7 +82,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -90,7 +90,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.md index 4417a723bac..a14bdd74033 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.md index df3f2fdda5c..c1d3a8baf9e 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.md index e6267c2b836..c42f27c1436 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.md index f6629dc73f5..b74ad5ae57a 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.md index 71fa713a85e..785a9b03ead 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.md index 565d410eba4..e7d6050ae9b 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.md index 2ed43795737..b0ac9b82925 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.md index d5a7ae232a6..d863ca8ba3b 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.38/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") Bases: `abc.ABC` @@ -36,7 +36,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`abstract BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") +`abstract BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.md index 88f4f878a30..806f3993623 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.38/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") Bases: `abc.ABC` @@ -33,7 +33,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`abstract BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") +`abstract BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/base_sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.38/qiskit.primitives.Estimator.md index a604fb2a00f..e49f71ae8db 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.38/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base_estimator.BaseEstimator") @@ -34,7 +34,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.md index 72af32dc012..8b2471605f3 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.38/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/estimator_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.38/qiskit.primitives.Sampler.md index 61d4dfd80b3..d01c981b600 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.38/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler") @@ -31,7 +31,7 @@ Sampler class -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.md index 08b1c029dfe..0202b461888 100644 --- a/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.38/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.providers.Backend.md b/docs/api/qiskit/0.38/qiskit.providers.Backend.md index 458a6b67da6..f5b81c69d16 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.38/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.md index a73f44474f0..71c8077a020 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.38/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.38/qiskit.providers.BackendV1.md index 3a09ee047f9..886793a7a3e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.38/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.38/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.38/qiskit.providers.BackendV2.md index 54146dd6d7a..e8864af2daa 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -43,7 +43,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -65,7 +65,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -93,7 +93,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -115,7 +115,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -137,7 +137,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -163,7 +163,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Run on the backend. @@ -186,7 +186,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.38/qiskit.providers.Job.md b/docs/api/qiskit/0.38/qiskit.providers.Job.md index 4275fc38f34..620e20af999 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.38/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobError.md b/docs/api/qiskit/0.38/qiskit.providers.JobError.md index 64ada67074f..b5b9f935f9d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.38/qiskit.providers.JobStatus.md index 78953b0d230..9c459949445 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.38/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.md index ebadc5e6d3e..cc69c3f3a7d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.38/qiskit.providers.JobV1.md b/docs/api/qiskit/0.38/qiskit.providers.JobV1.md index a092a74cf3b..36896ce02e4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.38/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.38/qiskit.providers.Options.md b/docs/api/qiskit/0.38/qiskit.providers.Options.md index a31832ac0ad..22fb83a0178 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.38/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.38/qiskit.providers.Provider.md b/docs/api/qiskit/0.38/qiskit.providers.Provider.md index 8cbafb92e6c..c48224535fe 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.38/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.md index b73ab499f7d..784ce38174d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.md index e016eed75ac..ab025bb7e1b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.md index f835aa6559c..4a73c2c9a25 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.38/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.md index 76ecd660a6f..63c6b01e9fe 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.md index 60acc4d6ba8..c4c1cb77055 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.md index 7564164039f..30b1f311250 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.md index a2a48f92ede..29955b2588b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.md index e20b46a253d..56ca9c78669 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.md index 2bd9491e834..57062b3f3cb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.38/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 8807aa994a7..5a12c1d0e72 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.md index aaee9cc0e85..d56d67194f1 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.md index bb88bdd0b9e..1246e6f2745 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.md index 0c39311c970..e44a8d06c3a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.md index 1886b2c1bdc..2ecb161f1c4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.md index a0b1976076e..ea2ba45b28c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.md index df920c951ad..34b05160f39 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.md index 6d777b19559..925568dd5de 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.md index 5f8b92b095a..6af4b912205 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.md index 8b779cb0557..fbed1abee51 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.md index b888b4a2fb7..ea08dfe5bf2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.md index 1ed9b93cd0b..ce8c25ee397 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.md index 4208e92bae6..478f59476b8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.md index b23c255dc3d..29b427b3fdd 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.md index d25215922b5..165c9658db3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.md index fc6e39e7e5e..deea577db4d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.md index 18498775a52..be37f3b1254 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.md index d95e40c240e..313e3d2ecba 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.md index 3dce3809290..237a95bbfca 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.md index d1a47db36c4..6514d9b1d75 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.md index 1a9798327fa..fa38aa61c3b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.md index 0cd83e69070..c6f87d0f72d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.md index 053c72c13f2..c7d8cd5e534 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.md index f7f7de6292a..5ed78021a69 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.md index c35a10b156c..1304db5836b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.md index 5aba82671a4..0e51cc39ab8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.md index d89a142c5d7..a36486b15a2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.md index d3d46e57636..c58792f067d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.md index 8cbca5954de..d8515c2cc72 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.md index a05a6018942..c303702641d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.md index f13b16e7176..5ec0b24241d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.md index e02e1d54e8f..995acbf6e9c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.md index ebc27c0fa9e..0457f86b8d2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.md index 066f166442d..fa6ff522118 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.md index 40c57b4e852..ab9b3c51c33 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.md index 260cb63111a..17dbe7887e7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.md index cc10a663232..340ee116e7b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.md index 80757cab045..2986025467a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.md index c0e6196c8b9..2803169e1e2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.md index 67341a88090..826d79fd823 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.md index a943ea4a5a4..f1bef1983d8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.md index 4194604a5d8..37779210f98 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.md index c4856cca03d..73ccec9a35a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.md index 2d5b00a2625..3bd3cc697b7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.md index d1f765552fb..9c7147cc16b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.md index 1518d37660e..a2976ba68f8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.md index adff6839e59..a23af896e28 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.md index 05666bb2ff8..762a5d527df 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.md index 7b11b87d030..c28f17008b8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.md index ecbed438a65..c2b3e190277 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.md index d85afcf93bf..f56fa07d35b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.md index 7c63d12eab2..21aae092e60 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.md index 687b8d3421a..9feacfed2ec 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index 815490a843e..1e3bca18345 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.md index d8755b168d4..e606638d695 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.md index b1edd922e34..8e623c599b4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.md index b0f2538630c..b41818ac0e2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index a335a9850a1..21dd3c471b9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index ab794a6f02c..18b04f1d83d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.md index d17d14c1d60..ce6f7f95433 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.md index 2203dcfe022..4353f308fbc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.md index 75b0753cf6d..91b6be914fc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.md index 895b3aa383e..9226b0fc71f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.md index f773aad30cd..20c54256078 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 9a31d796bf8..14859425efe 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.md index 9a2a397b896..f8a31cded8a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index f5e9c31b9b6..cd74a81d48b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.md index 2ced7f4b2ff..97200007f64 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.md index 62fbfb6f7d3..0468c836d2a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.md index 13e61b4aaa0..79e1281e5b9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.md index 89182137d2a..d3ca72c84b9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.md index 9831ca3e292..3c16eafcdb1 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.md index 97a05839d37..cc06f3e23ca 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.md index 313c59291fe..04f35ac5397 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.md index 6a3545efe10..fee91e5c185 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.md index a2501cfb3bf..395f04677e7 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.md index cac2ae19077..fd83f243167 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.md index 21bec32d8d6..71e6b924c7c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.md index e05bf27a82c..13c8a5e2600 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.md index 71be1a4f4fa..6dd0291331a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.md index 80f022bbddc..d6d3c8a0726 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.md index ed63aa27370..386719a42f6 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.md index dc4ed6c13cd..650b99478bd 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.md index f1d313a6248..cd96cea8680 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.md index 95ff1c3c4c2..2443e96bd93 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.md index 7d7e8ed9dc9..09d6726f199 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.md index 31fc7114885..f8e68f619bd 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.md index 49009bc3e69..a49cf627b7c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.md index f0ce64340fe..9fb59d7b568 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.md index 16bee570cd8..c6d49b97abe 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.md index 0c5b034ce01..4d2e1e67c3f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.md index 5f5560e0334..af57efb52bc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.md index 001171e6f9c..d1a3ae5f0af 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.38/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.md index ac2bb7e4984..d83cba70594 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.md index 9e2f72144f4..5696933d4a8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index d3d7859b636..d986df37b1e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 5645c4c24bd..7040b5ff883 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 2b79453f6ba..f4ce04dc5bb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index ea748b6719a..09a93e6b81f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.md index 3fab47b9099..82186cac087 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 4ffadf8c93c..4a17d4d7b0a 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.md index 66605916fec..3334bb4a3c2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -477,7 +477,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.md index 8f76680a706..1b44a08e8a0 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index d2954ec6fb0..fd69b6ed1dc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.md index f68ab861049..68cc2afa143 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.md index 3cdb81cf57a..b8da8734015 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -140,7 +140,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -209,7 +209,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -225,7 +225,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.md index a38a76dfdee..b3a3cd933dc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.md index 362fb52745c..0b711755a2f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.md index 0f765703d8d..9a6fb649ae6 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.md index b52b29d66b0..de434cd2de8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.md index 4b446849cc4..814bfa0dfc9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.md index fde38e8edaf..0d0b5413ec2 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.md index 211e69d3a91..3703893d197 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 856cff72d1e..6235546f8ec 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 869e3725218..b3a235e13fc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.md index bebdde0ac5f..9091dcf1e63 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 7f6e3e60997..35d375720a5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c753b9b03fd..0a5ff1c030d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.md index 0e16c129460..4119853fe38 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.md index c0ec62197bf..3abd0382d49 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.md index 0e98ceffabb..3890486708b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.md index 4a087d3fd82..543fb587672 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.md index c7d560a66e7..d3bfa9ccd14 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.md index 0626db0120a..3fd71c70852 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 8ea40cf804d..74ebff3e9fa 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 57a7fc6c085..5d38a428320 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 0481fda1214..2fd9874cefb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.md index 45b63ccd381..ab9a3314315 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.job_monitor.md index 4b7ee67e901..e407a59be71 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.least_busy.md index 29174c48477..9b045aec80e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.md index 9a198d26d89..ddbd2a9b158 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index a6b662fe102..64cce88e50c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 4006a3d0d4e..11e52eaec09 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 4e299221dae..57f826b9283 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index b19ab743224..02872ed993e 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index be41ee3b213..4e0a432bb6d 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 8f1556fcdd5..36bcff386f5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.md index 08ad74c3867..e9c1ab44d0b 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.md index ff5b8bf3438..4665b7e9bf3 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.md index 873c7251ec2..8a4f3f1a245 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 916b4476630..99613bad810 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 045bf20ddc8..892a734ebd4 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.md index 7feeaf688d5..be445fbb65c 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9188f764070..dd32329888f 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a0885b06940..d5400ad6165 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index b9a1da51d6b..69290448ca5 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.md index 869f5fc84c1..418963c5efc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 942dc83ad8f..03707eaa300 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 91ca5ee1f15..1220a71e9cd 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.md index f95d6bd4118..0dea489a2d1 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.seconds_to_duration.md index 1f138559be6..f005d414fbe 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.to_python_identifier.md index ad186c83b90..fe8ecb9ffe9 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.update_qobj_config.md index 3e2e6e9a4cc..a51e8c95919 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.utc_to_local.md index 161e29c2551..8cfe310b9f8 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.validate_job_tags.md index 6ef795cb48d..4c562c2a072 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.38/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.md index 0643db66817..24c83bf3d77 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.md index 48dc02f7651..858227205bb 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.md index 37bd9fc18bb..302196370fc 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.Command.md b/docs/api/qiskit/0.38/qiskit.providers.models.Command.md index 8e89ec5102a..12fe1740d24 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.md index c5e0b1e7da3..9c64fc77e58 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.md index 47b4091fcb8..4467ec3faab 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.md index 27108c5d6c8..d0a33b00230 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.md index 772823d1f81..6bccc9611ac 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.md index bab742abe80..8481e6a8661 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.md index b09e9a68fc2..8364b848cf6 100644 --- a/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.38/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.md index dd9d8d5c0a4..c570e768d47 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -159,7 +159,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -182,7 +182,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -204,7 +204,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -228,7 +228,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.38/qiskit.pulse.Schedule.md index a34fe5626d0..b8fcae6e723 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.md index 031c6cbcb0b..2c0b58274d8 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -89,7 +89,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -110,7 +110,7 @@ Schedule with updated parameters. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -172,7 +172,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -205,7 +205,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -236,7 +236,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -258,7 +258,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -283,7 +283,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -295,7 +295,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -307,7 +307,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire.md index 6758a3e10f1..8d2586eedc2 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire_channel.md index 0053054f7f3..0c258391edc 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.active_backend.md index 69715fda084..c742fef3ef2 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.active_circuit_scheduler_settings.md index ae992346e28..ba6033ed5d8 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.active_transpiler_settings.md index 43e8c0173ee..c8cda9e3064 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_equispaced.md index e3e450e74a2..9fa83c581a4 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_func.md index c62c6d4980a..7905bd6d1ca 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_left.md index ccf13b05427..c7160e2ca7b 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_right.md index a2e49d6f792..a0aa7a4714b 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_sequential.md index da9d8691aa1..4350d89d1f9 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.barrier.md index 304b5affa45..8501c23a2ef 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.build.md index 73fd3aa572e..bbeb2261e5d 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.call.md index 6ff747d1c7e..721f47bf082 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.circuit_scheduler_settings.md index c63397ee03c..b04450ac20e 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.control_channels.md index bb7af77a32c..12c030ec586 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.cx.md index 23146a89777..8c7d4387249 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.delay.md index 184dcb22cae..b37a0a85928 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.delay_qubits.md index 90a4534a0b5..7e271890296 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.drive_channel.md index e12921b2fbc..0949fce2e85 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.frequency_offset.md index b4fc7f3f429..4cec3bd4320 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.inline.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.inline.md index 6c842fbf9ef..27c793eab2f 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.inline.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.inline -`inline()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`inline()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Deprecated. Inline all instructions within this context into the parent context, inheriting the scheduling policy of the parent context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.measure.md index ad942a62046..54a077b142f 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_all.md index 23892731acb..7aafcc9f4cd 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_channel.md index 734053bce5c..130d886e5bb 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.num_qubits.md index e0b622fcdfb..d494097d5cf 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.pad.md index 74ae434a5c1..905abb26ff0 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.pad -`pad(*chs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`pad(*chs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Deprecated. Pad all available timeslots with delays upon exiting context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.phase_offset.md index 622c2e50441..aaeb01cae01 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.play.md index 64b79c965ff..413a51e3274 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.qubit_channels.md index fd2f0864a2b..0068f47898d 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.samples_to_seconds.md index 12ebef79b4b..acd9061d577 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.seconds_to_samples.md index a1b026cc646..1ad3871d1de 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.set_frequency.md index 01d5586e566..c4299ca869f 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.set_phase.md index 35b1e5324ef..3af33632828 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_frequency.md index 2fabafe0abc..b263f80f922 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_phase.md index dac5a1ae749..d213ded71fe 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.snapshot.md index 06a48d33a7b..211443a72fb 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.transpiler_settings.md index a8a92836d6e..5c62885fbfb 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.u1.md index 69c8b572ec0..46af21df2f4 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.u2.md index aca3c602360..bc477938cc3 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.u3.md index 72beed256c5..edef6cc2219 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.38/qiskit.pulse.builder.x.md index 08d2133c82c..e1dcd47a47f 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.md index 21faba179e8..618d7ad0320 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.md index 15d8fab6b9f..5429edfeeca 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.md index b8856a45a01..ff5a61ec697 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.md index 4700ff8a21d..f3a0ae5e237 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.md index 172817d4dfa..344eb6a1967 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.md index d220e5aa7b5..26513d15484 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.md index 298f25f353f..ffc9ae54bd2 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.md index c9c927bb6d9..1ffe0988934 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.md index af587cf03e5..4b3c1437f2f 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. @@ -182,7 +182,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Call.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") +`Call.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/call.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.md index 5fa2a38d281..dce46d9991c 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -166,7 +166,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Delay.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") +`Delay.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/delay.py "view source code") Return `True` iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.md index 3cfb648cb3a..3bb8a0f24cc 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -158,7 +158,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Play.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") +`Play.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/play.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.md index 67e3144f249..3998b4d65bc 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.md index 3c3313b29b8..61be78fe627 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -160,7 +160,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`SetPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.md index 6100878b1ed..92147cd1e17 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftFrequency.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/frequency.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.md index 526b0fe0d96..85788029936 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`ShiftPhase.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/phase.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.md index 6711c977bb6..91766dd5e40 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -156,7 +156,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.md index e76ff06b5cf..2e130f429ba 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration, amp, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.md index 60f564d63c9..3c2dd6f13db 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.md index 34cc58fee87..bbe919710cd 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration, amp, sigma, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.md index e97f9c2d759..eaf861e0764 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.md index e3ede890dd8..2b3d49f0d63 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.md index f9c4ee1970e..19eef748bc1 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -158,7 +158,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -185,7 +185,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -197,7 +197,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.md index 5dd311a9a39..2c0b2bcbdc1 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.38/qiskit.pulse.library.cos.md index d9ef86281ca..d6247cf74a2 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.cos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_deriv.md index 7409327bd08..3671a09e5e5 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_square.md index 84a1d5835c6..f3a2511ddf9 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.gaussian_square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.38/qiskit.pulse.library.sawtooth.md index cd0c9c61c73..8bd0cd6bc4e 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.sawtooth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.38/qiskit.pulse.library.sech.md index 4e55d4501a5..4e6411ce864 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.sech.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.38/qiskit.pulse.library.sech_deriv.md index ff9823c67b6..016cd25ba1e 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.sech_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.38/qiskit.pulse.library.sin.md index 5c46b644955..fdaabc58f60 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.sin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.square.md b/docs/api/qiskit/0.38/qiskit.pulse.library.square.md index 7a818044a5a..f18e3ac157a 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.38/qiskit.pulse.library.triangle.md index a32dcabf406..520a9086720 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.triangle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.38/qiskit.pulse.library.zero.md index b7e29a24331..8b46e88db55 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.library.zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.md index 728c0ec2df1..d5417983f92 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.md index 3b6e9ed8716..ba8089eebcd 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.md index bb8883c9769..0112a52c331 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.md index 6bde58df5b5..96c80e1d394 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.md index 5d51ab76329..717b9fa6f2c 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.add_implicit_acquires.md index 136204aa1f7..30e8b0c3566 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.align_measures.md index 480a807ce44..b64093186d9 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_dag.md index cea1c742f9a..ac3ff93c3cc 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_schedule.md index 052176a18ea..d8716d314b5 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.compress_pulses.md index 607d196ae5e..24013ca5a54 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.flatten.md index 8928c0f9019..2c83e11a3ce 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.inline_subroutines.md index 988bac0083c..7856760be86 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.pad.md index 116e533a331..28733b2d059 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_directives.md index f944cdb00f9..0cf357232b9 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_trivial_barriers.md index 17e6d66530f..6902bac3afc 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.38/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.38/qiskit.pulse.transforms.target_qobj_transform.md index 530d7a6f79d..91cce793766 100644 --- a/docs/api/qiskit/0.38/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.38/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.md index 81ad4e4eb5d..874320e62e2 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.38/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.38/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.38/qiskit.qasm.Qasm.md index c5c491580d8..90dfdd99d07 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.38/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.38/qiskit.qasm.QasmError.md index e329a4e943d..f0277f7da2e 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.38/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.md index e24f3d524eb..cd56907c785 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.38/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.md index c02df9e9dd9..d508f74e0b9 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.38/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.md b/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.md index c194a75720a..7c69bf2f124 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.md +++ b/docs/api/qiskit/0.38/qiskit.qasm3.Exporter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.Exporter -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ QASM3 exporter main class. -`Exporter.dump(circuit, stream)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") +`Exporter.dump(circuit, stream)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, dumping the result to a file or text stream. @@ -38,7 +38,7 @@ Convert the circuit to QASM 3, dumping the result to a file or text stream. -`Exporter.dumps(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") +`Exporter.dumps(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, returning the result as a string. diff --git a/docs/api/qiskit/0.38/qiskit.qasm3.dump.md b/docs/api/qiskit/0.38/qiskit.qasm3.dump.md index 8501c51ef1b..fb45dba2156 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm3.dump.md +++ b/docs/api/qiskit/0.38/qiskit.qasm3.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dump -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. diff --git a/docs/api/qiskit/0.38/qiskit.qasm3.dumps.md b/docs/api/qiskit/0.38/qiskit.qasm3.dumps.md index c6e709eac21..d07facc185d 100644 --- a/docs/api/qiskit/0.38/qiskit.qasm3.dumps.md +++ b/docs/api/qiskit/0.38/qiskit.qasm3.dumps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dumps -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.md index 4c8beb10fb5..9986846b3f8 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.md index caceebdea6f..fa8fca5cd84 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.md index 3c7950567ea..c62bcec1b75 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.md index 6915fe44d58..724c205fbb0 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.md index cada6e6d6a5..c15626ec148 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.md index b3658cec34e..3efe5859c1d 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.md index 271988a4447..22dfcfe3837 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.md index fdee1bf81c1..30a0e8ec24e 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.md index eeac8478627..a67da88f576 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.md index dae1ebe8a10..a537e98a9f8 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.md index 8c92bca0720..b9afa0b6c19 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.md index 352d1e0d9fe..aee49eb6d53 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.md index fad5374e449..bfe61a4e9c5 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.38/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.38/qiskit.qobj.Qobj.md index 9a61c90f112..cb834488faf 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.md index 0870511e020..32e15587131 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.md index 85512c9d60b..7bfb1585ec9 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.md index 550f2caed45..d95feab203b 100644 --- a/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.38/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.38/qiskit.qpy.dump.md b/docs/api/qiskit/0.38/qiskit.qpy.dump.md index 54275c2ae7c..a6510d541e9 100644 --- a/docs/api/qiskit/0.38/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.38/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.38/qiskit.qpy.load.md b/docs/api/qiskit/0.38/qiskit.qpy.load.md index 3735ef8a6e9..5a83e257799 100644 --- a/docs/api/qiskit/0.38/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.38/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.md index fba4d998b9a..f24e9e62dc6 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.md index d5e11c6faa1..1f22637b48d 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.md index 7ebb479b752..23324445d81 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.md index d030872ba5d..a8a8b21171b 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`static Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -407,7 +407,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -415,7 +415,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.md index eec78db3a6b..0babbbbdead 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.md index eeb6e2343c3..0c16e7e1616 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.md index f7c13480b38..56922f295d2 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.md index d68db1d9344..7711584c5af 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a :class\`.QuantumCircuit\` @@ -201,7 +201,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -237,7 +237,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -253,7 +253,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -303,7 +303,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -321,7 +321,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -347,7 +347,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -355,7 +355,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -363,7 +363,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.md index aabc31cf02a..7ead185ce61 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.md index 181e93b16be..840f95e9ac8 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.md index 2d91e8c9544..e10ef310791 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.md index a77eb6d47fd..c5c7890d380 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.md index fc27c2b438e..58c36b79800 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.md index a381968ccb0..3e3cf17fb4c 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.md index 9af60f4e3a5..16be1f02b64 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -50,7 +50,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -82,7 +82,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -114,7 +114,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -155,7 +155,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -175,7 +175,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -197,7 +197,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -234,7 +234,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -262,7 +262,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -308,7 +308,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -351,7 +351,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -372,7 +372,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -390,7 +390,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -470,7 +470,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -491,7 +491,7 @@ the simplified SparsePauliOp operator. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -519,7 +519,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -545,7 +545,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -567,7 +567,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -587,7 +587,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -595,7 +595,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.md index 86fdcf7523e..074d5ea9a84 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.md index defa1cd7654..9a2fa889a3a 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.md index 6e6e6761251..2aab94062c1 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ $$ -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.md index f95ef20409e..70dee161312 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.md index ff9a15f896b..83798e0b38c 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 3fa16f2d54b..9e7850c40eb 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.md index c6f3380cb5f..d3147b7398f 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.38/qiskit.quantum_info.average_gate_fidelity.md index b7a49d55b1c..1b96d16a9db 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.38/qiskit.quantum_info.concurrence.md index 498b0aa5bed..52cec654c43 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.38/qiskit.quantum_info.decompose_clifford.md index f10954d4401..c5d5eade3b6 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.38/qiskit.quantum_info.diamond_norm.md index 15b0e3e67da..21774f4c2bf 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.38/qiskit.quantum_info.entanglement_of_formation.md index e1664443c53..2db458d05a3 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.38/qiskit.quantum_info.entropy.md index f6f52c656cd..dd509470ac3 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.38/qiskit.quantum_info.gate_error.md index c7fda253ec5..80e42433ac7 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_distance.md index ee8844e0a91..4f6b2c4386a 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_fidelity.md index 25fd58bed3e..6bc075cc351 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.38/qiskit.quantum_info.mutual_information.md index 437e0dc14d7..ce6929c8569 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.38/qiskit.quantum_info.partial_trace.md index 4d7ad63bc38..f41d27f500d 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.38/qiskit.quantum_info.pauli_basis.md index 860a4b287b9..bd12c5dd812 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.38/qiskit.quantum_info.process_fidelity.md index 2e93dd0117e..fb2ddf17386 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.38/qiskit.quantum_info.purity.md index d242a145c03..e0c46d80759 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_clifford.md index 219d5fea2f6..019d0dd65d1 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_cnotdihedral.md index f424fdb178d..74d8715e442 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_density_matrix.md index 6348d50b409..2ce11719f18 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_hermitian.md index 7417b425da7..951a5050173 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli.md index 0c8d7380bfe..92c28142871 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_list.md index 0f3633ddc1d..492b5072760 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_table.md index 265c0110567..29cd46d68d0 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_quantum_channel.md index 6e2e14c02fe..90e5d9ca95a 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_stabilizer_table.md index 320e0ffb3bc..93f1c0e22b5 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_statevector.md index a97dd6a9038..1e018dd51ee 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.38/qiskit.quantum_info.random_unitary.md index 48696865ce5..651b6e1adc2 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.38/qiskit.quantum_info.shannon_entropy.md index 81584fad115..a1bf8f78e01 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.38/qiskit.quantum_info.state_fidelity.md index abe2cb13a70..e6456b2630a 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.md index 863dfda11c9..dd7943dcd3e 100644 --- a/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.38/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.md index 714f938c1ba..75a2b5c9a62 100644 --- a/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.38/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.38/qiskit.result.Counts.md b/docs/api/qiskit/0.38/qiskit.result.Counts.md index 4b974fee1ea..569a90e7c3a 100644 --- a/docs/api/qiskit/0.38/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.38/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.md index a531ded5624..d69573ef9ba 100644 --- a/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.38/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.md index e0fd72bf6fc..d97b5aa7e78 100644 --- a/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.38/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.md index 55bc8f4bb72..64838e54c77 100644 --- a/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.38/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.38/qiskit.result.Result.md b/docs/api/qiskit/0.38/qiskit.result.Result.md index d13dafec7cc..35f3be59fa4 100644 --- a/docs/api/qiskit/0.38/qiskit.result.Result.md +++ b/docs/api/qiskit/0.38/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.38/qiskit.result.ResultError.md b/docs/api/qiskit/0.38/qiskit.result.ResultError.md index 4ad99614373..b642c85c3d8 100644 --- a/docs/api/qiskit/0.38/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.38/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.38/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.38/qiskit.result.marginal_counts.md index bf2a30ccfb7..924531d111c 100644 --- a/docs/api/qiskit/0.38/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.38/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.38/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.38/qiskit.result.marginal_distribution.md index c2a67c781ac..b48ab41921a 100644 --- a/docs/api/qiskit/0.38/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.38/qiskit.result.marginal_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.38/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.38/qiskit.result.marginal_memory.md index 7774b3c5c51..a3d8742dcb8 100644 --- a/docs/api/qiskit/0.38/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.38/qiskit.result.marginal_memory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.md index 939ea8a4dc8..588b27dc88d 100644 --- a/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.md index e8b92f46194..aa4b4cb1011 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.38/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.md index 9cced88e5ba..c13d2d730a5 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.38/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.md index 56429730dc3..7c575df85ea 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.38/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.md index 533bc7d1eff..dd77812ba4e 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.38/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.md index 2f48b431ff9..6282dc8ca7b 100644 --- a/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.38/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.38/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.38/qiskit.tools.backend_monitor.md index ba646a67a14..f4bd7870850 100644 --- a/docs/api/qiskit/0.38/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.38/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.38/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.38/qiskit.tools.backend_overview.md index b57539983df..03f7466c6e0 100644 --- a/docs/api/qiskit/0.38/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.38/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.38/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.38/qiskit.tools.job_monitor.md index de4abf4ace6..a3750cd2b0b 100644 --- a/docs/api/qiskit/0.38/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.38/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.38/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.38/qiskit.tools.parallel_map.md index 018b21aab3c..f227996e722 100644 --- a/docs/api/qiskit/0.38/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.38/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.md index d8b7dc6d0e7..32f14a05f7b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.md index b07e2189736..069070e604a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.md index bde7d83da5c..3c6decc5d65 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -112,7 +112,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -124,7 +124,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -136,7 +136,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -161,7 +161,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -186,7 +186,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -208,7 +208,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -220,7 +220,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -232,7 +232,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -248,7 +248,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -258,7 +258,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -266,7 +266,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -274,7 +274,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -284,7 +284,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -308,7 +308,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -333,7 +333,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -341,7 +341,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.md index ad2e5c3ded9..62595b032ac 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.md index be42179ad50..89f31b36574 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.md index b32a44b62ff..83fa099e7c4 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.md index 15794221e04..1c07d29b304 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.md index a394576da55..e0176a50c58 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.md index ee68d67d417..68f6b59d293 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.38/qiskit.transpiler.Layout.md index 8c6bd623b09..91ad11954ad 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit (extending the length of the layout by one.) @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.md index 8488f9dbfec..daccaac5544 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.md index f30848bd558..8c16b0727a0 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -42,7 +42,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.md index 7d75aa0e070..768ef107b0b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.md index 5c7aa10664d..ac7aebb84fa 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.Target.md b/docs/api/qiskit/0.38/qiskit.transpiler.Target.md index 6d103fa5ca1..94ebe930942 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -135,7 +135,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -162,7 +162,7 @@ for this target. -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -186,7 +186,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -208,7 +208,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -248,7 +248,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -264,7 +264,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -305,19 +305,19 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -337,7 +337,7 @@ The Instruction instance corresponding to the name -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -361,7 +361,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -385,7 +385,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -405,7 +405,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -421,7 +421,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -460,7 +460,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -478,7 +478,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.md index 1cb0f7e76e6..8d1af429531 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.md index d16f04fa8a4..0e3e8f1a7a1 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.md index c82877de6c3..7793a265727 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.md index 5c10f6cbdf1..98680583edb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index d8f60c2e8dc..b3a84a1bdae 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.md index b4f298485e2..6cc4b930cd5 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 1c8788694bb..e23199f16f8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.md index 1977a87b85b..b79d405de7b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.md index 4f69c995619..89f4ac68ac6 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.md index 322e103bb69..12ec1cf6cda 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 23ffaafd707..8d4eee99595 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.md index 16341d16bbb..fd2bd66f27e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.md index 5ab02e8d9f8..d557c27c64e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.md index d2d5a3b35f2..e33b1d7287c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.md index 8908d246c8a..e544ea1e329 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.md index e10f63821c4..6b0d3d26d18 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.md index b87d35504ed..28725d698d4 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.md index d56bc37f451..3de16cb4874 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.md index f812084e487..62377a6b7dd 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.md index 9befcf9b96f..69c70c38e1e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.md index 85bc2384e0e..65360bf6bf8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.md index 09f3985aeee..30b2cf4b5fd 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CollectLinearFunctions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Run the CollectLinearFunctions pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.md index 422331d9823..f28446603fc 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.md index f9b45cd59c5..753d9192ec0 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.md index db4f7da294d..003f0d3d92b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.md index 556f9afbdab..648990c1ed6 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(swap_strategy=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -91,7 +91,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -117,7 +117,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.md index 4190be77d7a..bbe91eb43e0 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.md index 0a05da8a616..ddbf3dca4eb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.md index b1e7b0cc763..74a7fddb6c3 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.md index 8f50512e5e1..8a2f69449a9 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.md index af7fef0f2df..9045859cf9a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index d12620baca9..e7b048f93c9 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.md index a23dd090ef7..f568030804e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.md index 6656e020bfa..9d6c801d2e4 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.md index 59bf1ebe24f..fc6c57c2f91 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None, gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None, gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.md index abf1b3ce91b..87b9cde4058 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.md index 5cf7c90c957..2f0c6c4a532 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.md index 0af88ab3fdc..f141b8c67eb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 60e934c9529..3194ae01f87 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.md index fb6400787ea..d1a626e90e9 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.md index e3eaf348f08..adb5bdce89c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.md index ca4f3698bdc..ad5c6aaca9b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.md index e001bac7d97..a89d3eb1003 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.md index 94f67d6a214..fa9bb23c36c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.md index dcd2dbdb4ed..c35408366c4 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.md index 06e8be15d09..fc4912804f8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.md index 786891a0918..deee0dfc57c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.md index 8029352bd2f..47d11fa5a0a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index 8561042dec8..79d5eda1e15 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index d5ec4f8545f..03c39ff570a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.md index 8bd0ba60919..9549a10b4eb 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 362c0b59e58..6633cb1e6a7 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index b4178062b15..8cd52a6cff8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.md index 7517b68fbde..c129b2c70a8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.md index be89787400c..d185df2391b 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 75840fd32b9..5a1d2ce0742 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 4b1b8edce11..9b33a8a9f6d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.md index d36a168b63f..e6bb5178fe2 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 1f5e22c454c..3a61977446c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.md index 0da636cd94f..1f31897f909 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 8e769817e50..5877b0db349 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: `qiskit.transpiler.passes.calibration.builders.CalibrationBuilder` @@ -33,7 +33,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -66,7 +66,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") **Parameters** @@ -113,7 +113,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 6ae8d049c42..bdcdcc40756 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.builders.RZXCalibrationBuilder") @@ -35,7 +35,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/calibration/builders.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.md index ce518b6f89e..df241023587 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 937f304f740..34b6325a948 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 2fc91761e78..c64c43e122f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.md index b924921c1e7..9fb8bc650f8 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.md index 0d9ad10a9d2..3f4f31c678e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.md index cc2b65b4c0c..f70bf598f35 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.md index 6fcf8f12c15..8c3fb4f8d1d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.md index f6ca4d6c5e3..28cc6c0ec9a 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.md index 69c50109f90..bf5bb512187 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.md index 3d58ce54250..a285ae7e9ca 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.md index b62f7f4878f..ab66e85056c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.md index 0743a593485..173b10423f9 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.md index f2109c58e99..034cc5cb1ee 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.md index d52a0c81ffa..af74a407f06 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.md index 6c7f6226237..c04092bb876 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 92e5cdfc74d..e9f18187ecd 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.md index 6ef353882bd..67d9651564c 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.md index 62e203c09d8..c7e24a98edc 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.md index 5dabe456ffe..e1430059dac 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -54,7 +54,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.md index 6567629e2d2..786944c8943 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.md index b3413ce6465..444aa893952 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index fa310ae0e91..fd87ce98d06 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index d98b59d2236..f1ae89c1b37 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index f97036fd913..db4f00f964f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 912e4c99a2d..300e4cb6f30 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index 8c4a5e7e652..1c9b79bca06 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 283611e44e1..7134d7cf759 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index dba00d61d8e..ffff8355ada 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index d4674316d5b..ccaf1045a45 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.md index 91a0e0eea14..08681e35f51 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index e93f3ee2cb1..ab96df2711e 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index f3076809311..03086986058 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index fd5dd8c2f3a..2debe49ec93 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 3b0fd3970a5..99dd042916f 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index d72c40ba1eb..5bda3f0782d 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index eeae1b9da0b..dd146468938 100644 --- a/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.38/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.md index 10557ce7f23..69569d84a2c 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.38/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.38/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.38/qiskit.utils.apply_prefix.md index ada30896a58..d2ba35ed7d9 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.38/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.38/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.38/qiskit.utils.deprecate_arguments.md index 6b8211676e4..1852cd509a2 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.38/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.38/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.38/qiskit.utils.deprecate_function.md index 4d618856bdd..b4e0f410147 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.38/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.38/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.38/qiskit.utils.detach_prefix.md index 6e84580e2b6..debf9c40999 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.38/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.38/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.38/qiskit.utils.get_entangler_map.md index 32ef0f10a1c..9925bbfed31 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.38/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.38/qiskit.utils.has_aer.md b/docs/api/qiskit/0.38/qiskit.utils.has_aer.md index 4d2e83940e0..a0c79527ad6 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.38/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.38/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.38/qiskit.utils.has_ibmq.md index d4d571e981e..571adc3bed5 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.38/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.38/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.38/qiskit.utils.is_main_process.md index 5d426ac2785..20d71632557 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.38/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.38/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.38/qiskit.utils.local_hardware_info.md index 2678a0c2892..2b345c1076f 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.38/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.md index 4d36ed51c48..00b3ec84895 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.38/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.md index beb48019d41..56c2167ddc1 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.38/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. diff --git a/docs/api/qiskit/0.38/qiskit.utils.name_args.md b/docs/api/qiskit/0.38/qiskit.utils.name_args.md index d0683eaead1..5f3b328aa62 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.38/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.38/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.38/qiskit.utils.summarize_circuits.md index 9f634d9fd92..e6a7caac90b 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.38/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.38/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.38/qiskit.utils.validate_entangler_map.md index 74026c0f1bb..2db7c3961c2 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.38/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.38/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.38/qiskit.utils.wrap_method.md index f8e3079d1ea..640353a76d1 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.38/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.md index e1e521aecec..7492145f10f 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.38/qiskit.visualization.array_to_latex.md index 12a0f436664..4b06174f477 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.38/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.38/qiskit.visualization.circuit_drawer.md index 34028ed21cf..54fc8d80f74 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.38/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.38/qiskit.visualization.dag_drawer.md index 4e3c4af4489..4a43f49a267 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.38/qiskit.visualization.pass_manager_drawer.md index 6e186661290..bcab918330f 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_multivector.md index 2ef8dc30ec8..28440729b26 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_vector.md index f936119e3a3..f149480d8fb 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_circuit_layout.md index 439cf329342..d14181df82b 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_coupling_map.md index d4d4eeb6450..89bd61fc0c7 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_error_map.md index 70c87718a0e..3604d28f8af 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_gate_map.md index 6a7f2bbc09d..f906c072f1b 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_histogram.md index 1c1c712d47a..1f60d3b82b5 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of data. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_city.md index ca6302f5ccf..34e94743c6b 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_hinton.md index 790b3cb51b8..3484b37cff2 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_paulivec.md index 601d7d1bfe2..d2ce4ddb035 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_qsphere.md index eaae01f9244..0557ab9a45d 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.md index 4c479861afd..43f23ad7dca 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.md index 027edf6bafb..481c6c1280a 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.md index 620232e4924..a07e6d16b4d 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.draw.md index fe40925f7f2..b1937df9979 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.md index 14a7cd44762..8ae0b1f8e84 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.38/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.38/qiskit.visualization.timeline.draw.md index 9f1fcaaac7a..fb242dcb83c 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.38/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.38/qiskit.visualization.visualize_transition.md index ed425b4d9f7..5efb3da3ff9 100644 --- a/docs/api/qiskit/0.38/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.38/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.38/qiskit_aer.AerError.md b/docs/api/qiskit/0.38/qiskit_aer.AerError.md index 5f4c2607a79..91244a10699 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.AerError.md +++ b/docs/api/qiskit/0.38/qiskit_aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.38/qiskit_aer.AerProvider.md b/docs/api/qiskit/0.38/qiskit_aer.AerProvider.md index 4f6b0e4db92..77c9fa9340c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.AerProvider.md +++ b/docs/api/qiskit/0.38/qiskit_aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.md b/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.md index 47bc8a665dc..9cde92150bd 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.md +++ b/docs/api/qiskit/0.38/qiskit_aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -205,7 +205,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -213,7 +213,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -263,7 +263,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -271,7 +271,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -359,7 +359,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.md b/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.md index 7fcf1526bba..3d25707435b 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.md +++ b/docs/api/qiskit/0.38/qiskit_aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.md b/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.md index 41467bd0e1c..8f2f21730ab 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.md +++ b/docs/api/qiskit/0.38/qiskit_aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.md b/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.md index 32eeaabdfc3..d59c192ceaf 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.38/qiskit_aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.md b/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.md index 1f06420d096..c87ff1ea1f7 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.38/qiskit_aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.md b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.md index db313fa15b5..cdf53e9e60e 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.md b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.md index 36f087d4664..6249b146be1 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.38/qiskit_aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.md index a6a3c1ee847..3457e924414 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.md index dbe9b362161..b16ed6fca93 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.md index 61c035747e2..a553e3e4af3 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.md index a97970dec60..68c04471132 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.md index 4f170429cb8..fbbc9be197e 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.md index b65cc654c01..f601397e76f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.md index ff45c0c06ee..10cfc651eec 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.md index 750f4dfb595..8509eeeea01 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.md index 24aaefbd1fd..3863e28f4ab 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.md index 9e4d612450f..a74c3cc3d87 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.md index cb8857d14a2..3f8b64809d4 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.md index 323c863b155..bc75412a401 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.md index aa18c03bbdf..2526eefb249 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.md index d9ad2d95fc5..455d9f2e07c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.md b/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.md index da93367d185..1a2a5efa681 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.md index f3fc262661e..4f540720c71 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.md index 095d26f3275..538b8e1ce0c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.md b/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.md index 26b4d86aeea..a0fec10f158 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.md b/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.md index b79415d8eb7..565a4c97f7a 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.md b/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.md index a1818ec75a6..c373d432109 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.md b/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.md index 590a0694967..de590aa0a79 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes.md index 390115a92e8..ec1b668c7c4 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes_squared.md index c6e631fd67a..82d8c10578c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_clifford.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_clifford.md index a15ce90d970..3545ea80cb0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_clifford.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_density_matrix.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_density_matrix.md index c5bf046d92e..2afcf6cbd81 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value.md index 83f3756753a..4eb728318a6 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value_variance.md index e0c48040e8b..06e3e06dc46 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_matrix_product_state.md index fc4efa9230c..3ec3e9646c5 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities.md index 3f917fa6387..95c6cffa69a 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities_dict.md index d554184bcd8..d6cb284ec4e 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_stabilizer.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_stabilizer.md index 012a26267e4..e0cb79acf70 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_state.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_state.md index b58f26be497..6254b7409a8 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_state.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector.md index f6638818b12..d8bd261964f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector_dict.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector_dict.md index 9b4deb5fb70..010dcaf80d0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_superop.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_superop.md index 4bed5d00e43..ef47af6761f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_superop.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.save_unitary.md b/docs/api/qiskit/0.38/qiskit_aer.library.save_unitary.md index fd8a0373bab..ded625276b0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.save_unitary.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.set_density_matrix.md b/docs/api/qiskit/0.38/qiskit_aer.library.set_density_matrix.md index 2938daa4809..6fedfb63299 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.38/qiskit_aer.library.set_matrix_product_state.md index a8c1135644e..ba41900f2b0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.set_stabilizer.md b/docs/api/qiskit/0.38/qiskit_aer.library.set_stabilizer.md index 690a1072521..f291fd9fa05 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.set_statevector.md b/docs/api/qiskit/0.38/qiskit_aer.library.set_statevector.md index 41e1bce3a7c..91728cb7f66 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.set_statevector.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.set_superop.md b/docs/api/qiskit/0.38/qiskit_aer.library.set_superop.md index 48988d8ec8c..fcbccc6a02f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.set_superop.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.library.set_unitary.md b/docs/api/qiskit/0.38/qiskit_aer.library.set_unitary.md index e6f8fd9c84e..c3a15022d7e 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.library.set_unitary.md +++ b/docs/api/qiskit/0.38/qiskit_aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.md index 73775726a61..5de51b3413a 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.md b/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.md index 5308b0b88e6..99e942aa604 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.md b/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.md index c81f1308985..1db3c8d7e4b 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -129,7 +129,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -154,7 +154,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -176,7 +176,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -250,7 +250,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -258,7 +258,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -266,7 +266,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -292,7 +292,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -300,7 +300,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -308,7 +308,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.md b/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.md index 473f00da065..bf79429206c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.md index cf2c6e6cba9..b983d9d944c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.amplitude_damping_error.md index 060dec129a3..4feddbe5752 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.coherent_unitary_error.md index f90a1a068c5..5f375e4118e 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.depolarizing_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.depolarizing_error.md index 682b4c35050..1a855f9520d 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_gate_errors.md index 49fe31e638b..bc466816714 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_readout_errors.md index 036856d7afc..5ec67050a9a 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return readout error parameters from either of device Target or BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_error_values.md index 995c5adf824..4e229d33a5a 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_length_values.md index c7985d8a231..5adc8d2bc1d 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_param_values.md index 9a03c869835..4b68d14dcb0 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.readout_error_values.md index 9e7cd14a25f..54ed50271bf 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.38/qiskit_aer.noise.device.thermal_relaxation_values.md index 4315386aea1..9a514b55877 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.kraus_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.kraus_error.md index 1d5fb16a3df..2c1fd8347bb 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.mixed_unitary_error.md index 134d564711e..fade2783f7b 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.pauli_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.pauli_error.md index b4e9f01faec..75a2282158c 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.phase_amplitude_damping_error.md index 70ced555d78..930337b8f4f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.phase_damping_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.phase_damping_error.md index 2dadfc13527..c686b920614 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.reset_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.reset_error.md index 955de63ad01..68b38e7ce57 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.reset_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.38/qiskit_aer.noise.thermal_relaxation_error.md index 52d4dc7edcd..a131331ef50 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.md b/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.md index 20ddfde5a04..ab8ce2fe881 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.md +++ b/docs/api/qiskit/0.38/qiskit_aer.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit, observables: Iterable[SparsePauliOp] | SparsePauliOp, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base_estimator.BaseEstimator") @@ -48,7 +48,7 @@ Aer implmentation of Estimator. -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.md b/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.md index 4f07f87c3e2..3328c97d315 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.md +++ b/docs/api/qiskit/0.38/qiskit_aer.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler") @@ -44,7 +44,7 @@ Aer implementation of Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.md index 1f9c2bb1d0c..3df65cca226 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.38/qiskit_aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.38/qiskit_aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.38/qiskit_aer.pulse.duffing_system_model.md index ea9d60c65fd..7bd6f1f4889 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.38/qiskit_aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.md b/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.md index e2cc57c2947..4dba548f226 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.md +++ b/docs/api/qiskit/0.38/qiskit_aer.quantum_info.AerStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector -`AerStatevector(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector(data, dims=None, **configs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") @@ -38,7 +38,7 @@ The `dims` kwarg is used to `Statevector` constructor. -`AerStatevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the conjugate of the operator. @@ -212,7 +212,7 @@ complex -`classmethod AerStatevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the output statevector of an instruction. @@ -238,7 +238,7 @@ The final statevector. -`static AerStatevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`static AerStatevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a computational basis statevector. @@ -266,7 +266,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerStatevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -355,7 +355,7 @@ tuple -`AerStatevector.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.metadata()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return result metadata of an operation that executed lastly. @@ -538,7 +538,7 @@ Additional Information: -`AerStatevector.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.md index 19ae0afd358..1bc6ad231e2 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_noise_model.md index fb3f3841a0a..a55bd1cde5f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_quantum_error.md index b11ed875e94..34cea362496 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.insert_noise.md b/docs/api/qiskit/0.38/qiskit_aer.utils.insert_noise.md index 4a76436e647..781c8172b8d 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.remap_noise_model.md b/docs/api/qiskit/0.38/qiskit_aer.utils.remap_noise_model.md index c299cda8af2..33d73b14a5f 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.transform_noise_model.md b/docs/api/qiskit/0.38/qiskit_aer.utils.transform_noise_model.md index d7301f5f544..f5fb8849045 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_noise_model.md index 4fd8ade1fe4..f1c17a64b81 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_quantum_error.md index 0e89f33a58f..accabb93593 100644 --- a/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.38/qiskit_aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.38/synthesis_aqc.md b/docs/api/qiskit/0.38/synthesis_aqc.md index 6ca9598396a..f3f53c8afce 100644 --- a/docs/api/qiskit/0.38/synthesis_aqc.md +++ b/docs/api/qiskit/0.38/synthesis_aqc.md @@ -127,7 +127,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.38/utils.md b/docs/api/qiskit/0.38/utils.md index 2bfd872f6bd..e52fba5ed46 100644 --- a/docs/api/qiskit/0.38/utils.md +++ b/docs/api/qiskit/0.38/utils.md @@ -109,7 +109,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -230,7 +230,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -244,7 +244,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From 0cf527d8e4da179fc5d7f9837458ffeb4f067a26 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:47:23 +0100 Subject: [PATCH 19/41] Regenerate qiskit 0.39.5 --- docs/api/qiskit/0.39/execute.md | 2 +- docs/api/qiskit/0.39/pulse.md | 10 +- .../0.39/qiskit.algorithms.AlgorithmError.md | 2 +- .../0.39/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.39/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.39/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.39/qiskit.algorithms.Grover.md | 8 +- .../0.39/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../api/qiskit/0.39/qiskit.algorithms.PVQD.md | 8 +- .../0.39/qiskit.algorithms.PVQDResult.md | 2 +- .../0.39/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.39/qiskit.algorithms.QAOA.md | 2 +- .../0.39/qiskit.algorithms.RealEvolver.md | 4 +- .../0.39/qiskit.algorithms.RealTimeEvolver.md | 4 +- .../api/qiskit/0.39/qiskit.algorithms.Shor.md | 8 +- .../0.39/qiskit.algorithms.ShorResult.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 4 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.39/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.39/qiskit.algorithms.VQD.md | 14 +- .../0.39/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.39/qiskit.algorithms.VQE.md | 14 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 6 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 6 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 6 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- .../qiskit.algorithms.estimate_observables.md | 2 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 6 +- ...lgorithms.gradients.BaseSamplerGradient.md | 6 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 8 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 6 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 6 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 6 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 6 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 6 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 6 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.39/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.39/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.39/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.39/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.39/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.39/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 16 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.39/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.39/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- ...lgorithms.optimizers.SteppableOptimizer.md | 18 +- .../0.39/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.39/qiskit.algorithms.optimizers.UMDA.md | 6 +- ...optimizers.optimizer_utils.LearningRate.md | 6 +- ...thms.state_fidelities.BaseStateFidelity.md | 6 +- ...ithms.state_fidelities.ComputeUncompute.md | 6 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 6 +- .../qiskit/0.39/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.39/qiskit.assembler.disassemble.md | 2 +- .../0.39/qiskit.circuit.AncillaQubit.md | 2 +- .../0.39/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.39/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.39/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.39/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.39/qiskit.circuit.Clbit.md | 2 +- .../0.39/qiskit.circuit.CommutationChecker.md | 4 +- .../0.39/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.39/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.39/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.39/qiskit.circuit.Delay.md | 12 +- .../0.39/qiskit.circuit.EquivalenceLibrary.md | 12 +- .../qiskit/0.39/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.39/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.39/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.39/qiskit.circuit.Instruction.md | 26 +- .../0.39/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.39/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.39/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.39/qiskit.circuit.ParameterVector.md | 6 +- .../0.39/qiskit.circuit.QuantumCircuit.md | 236 +++++++++--------- .../0.39/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.39/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.39/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.AND.md | 2 +- .../0.39/qiskit.circuit.library.Barrier.md | 8 +- .../0.39/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.39/qiskit.circuit.library.C3XGate.md | 6 +- .../0.39/qiskit.circuit.library.C4XGate.md | 6 +- .../0.39/qiskit.circuit.library.CCXGate.md | 6 +- .../0.39/qiskit.circuit.library.CCZGate.md | 4 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.39/qiskit.circuit.library.CHGate.md | 4 +- .../0.39/qiskit.circuit.library.CPhaseGate.md | 6 +- .../0.39/qiskit.circuit.library.CRXGate.md | 4 +- .../0.39/qiskit.circuit.library.CRYGate.md | 4 +- .../0.39/qiskit.circuit.library.CRZGate.md | 4 +- .../0.39/qiskit.circuit.library.CSGate.md | 4 +- .../0.39/qiskit.circuit.library.CSXGate.md | 2 +- .../0.39/qiskit.circuit.library.CSdgGate.md | 4 +- .../0.39/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.39/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.39/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.39/qiskit.circuit.library.CUGate.md | 4 +- .../0.39/qiskit.circuit.library.CXGate.md | 6 +- .../0.39/qiskit.circuit.library.CYGate.md | 4 +- .../0.39/qiskit.circuit.library.CZGate.md | 4 +- .../0.39/qiskit.circuit.library.DCXGate.md | 2 +- .../0.39/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.39/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.GRZ.md | 2 +- .../0.39/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.39/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.39/qiskit.circuit.library.IGate.md | 4 +- .../qiskit/0.39/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.39/qiskit.circuit.library.MCMT.md | 6 +- .../0.39/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.39/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.39/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.39/qiskit.circuit.library.MSGate.md | 2 +- .../0.39/qiskit.circuit.library.Measure.md | 4 +- .../0.39/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.39/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.39/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.39/qiskit.circuit.library.PhaseGate.md | 6 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.39/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.39/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.39/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.39/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.39/qiskit.circuit.library.RGate.md | 4 +- .../0.39/qiskit.circuit.library.RVGate.md | 6 +- .../0.39/qiskit.circuit.library.RXGate.md | 6 +- .../0.39/qiskit.circuit.library.RXXGate.md | 4 +- .../0.39/qiskit.circuit.library.RYGate.md | 6 +- .../0.39/qiskit.circuit.library.RYYGate.md | 4 +- .../0.39/qiskit.circuit.library.RZGate.md | 6 +- .../0.39/qiskit.circuit.library.RZXGate.md | 4 +- .../0.39/qiskit.circuit.library.RZZGate.md | 4 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.39/qiskit.circuit.library.Reset.md | 4 +- .../0.39/qiskit.circuit.library.SGate.md | 4 +- .../0.39/qiskit.circuit.library.SXGate.md | 6 +- .../0.39/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.39/qiskit.circuit.library.SdgGate.md | 4 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.39/qiskit.circuit.library.SwapGate.md | 6 +- .../0.39/qiskit.circuit.library.TGate.md | 4 +- .../0.39/qiskit.circuit.library.TdgGate.md | 4 +- .../0.39/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.39/qiskit.circuit.library.U1Gate.md | 6 +- .../0.39/qiskit.circuit.library.U2Gate.md | 4 +- .../0.39/qiskit.circuit.library.U3Gate.md | 6 +- .../0.39/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.39/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.39/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 4 +- .../qiskit.circuit.library.XXPlusYYGate.md | 4 +- .../0.39/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.39/qiskit.circuit.library.ZGate.md | 6 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.39/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.39/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.39/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.39/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.39/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.39/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.39/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.39/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.39/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.39/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.39/qiskit.compiler.transpile.md | 2 +- .../0.39/qiskit.converters.ast_to_dag.md | 2 +- .../0.39/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.39/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.39/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.39/qiskit.dagcircuit.DAGCircuit.md | 132 +++++----- .../0.39/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.39/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.39/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.39/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.39/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.39/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.39/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.39/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.39/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.39/qiskit.extensions.Snapshot.md | 8 +- .../0.39/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.39/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.39/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.39/qiskit.extensions.UCRZGate.md | 2 +- .../0.39/qiskit.extensions.UnitaryGate.md | 16 +- .../qiskit/0.39/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.39/qiskit.opflow.OpflowError.md | 2 +- .../0.39/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.39/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.39/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.39/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.39/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.39/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.39/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.39/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.39/qiskit.opflow.gradients.QFI.md | 4 +- .../0.39/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.39/qiskit.opflow.list_ops.ComposedOp.md | 14 +- .../0.39/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.39/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.39/qiskit.opflow.list_ops.TensoredOp.md | 10 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 +-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 16 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.39/qiskit.opflow.state_fns.StateFn.md | 40 +-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../qiskit.primitives.BackendEstimator.md | 4 +- .../0.39/qiskit.primitives.BackendSampler.md | 4 +- .../0.39/qiskit.primitives.BaseEstimator.md | 6 +- .../0.39/qiskit.primitives.BaseSampler.md | 6 +- .../0.39/qiskit.primitives.Estimator.md | 4 +- .../0.39/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.39/qiskit.primitives.Sampler.md | 4 +- .../0.39/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.39/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.39/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.39/qiskit.providers.BackendV2.md | 16 +- .../qiskit.providers.BackendV2Converter.md | 12 +- docs/api/qiskit/0.39/qiskit.providers.Job.md | 2 +- .../qiskit/0.39/qiskit.providers.JobError.md | 2 +- .../qiskit/0.39/qiskit.providers.JobStatus.md | 2 +- .../0.39/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.39/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.39/qiskit.providers.Options.md | 8 +- .../qiskit/0.39/qiskit.providers.Provider.md | 2 +- .../0.39/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.39/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.39/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.39/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.39/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.39/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.39/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.39/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.39/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.39/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.39/qiskit.pulse.ScheduleBlock.md | 30 +-- .../0.39/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.39/qiskit.pulse.builder.align_func.md | 2 +- .../0.39/qiskit.pulse.builder.align_left.md | 2 +- .../0.39/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.39/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.delay.md | 2 +- .../0.39/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.39/qiskit.pulse.builder.measure.md | 2 +- .../0.39/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.39/qiskit.pulse.builder.num_qubits.md | 2 +- .../0.39/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- .../0.39/qiskit.pulse.builder.reference.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.39/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.39/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.39/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.39/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.39/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.39/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.39/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.39/qiskit.pulse.instructions.Call.md | 4 +- .../0.39/qiskit.pulse.instructions.Delay.md | 2 +- .../0.39/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../0.39/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.39/qiskit.pulse.library.Drag.md | 2 +- .../0.39/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- .../0.39/qiskit.pulse.library.Waveform.md | 4 +- .../qiskit/0.39/qiskit.pulse.library.cos.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.39/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.39/qiskit.pulse.library.sech.md | 2 +- .../0.39/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.39/qiskit.pulse.library.sin.md | 2 +- .../0.39/qiskit.pulse.library.square.md | 2 +- .../0.39/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.39/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.39/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.39/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.39/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.39/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.39/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.39/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.39/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.39/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.39/qiskit.qasm.QasmTerminalStyle.md | 2 +- docs/api/qiskit/0.39/qiskit.qasm3.Exporter.md | 6 +- docs/api/qiskit/0.39/qiskit.qasm3.dump.md | 2 +- docs/api/qiskit/0.39/qiskit.qasm3.dumps.md | 2 +- .../0.39/qiskit.qobj.GateCalibration.md | 6 +- .../0.39/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.md | 6 +- .../0.39/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.39/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.39/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.39/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.39/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.39/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.39/qiskit.qobj.Qobj.md | 2 +- .../0.39/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.39/qiskit.qobj.QobjHeader.md | 2 +- .../0.39/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.39/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.39/qiskit.qpy.load.md | 2 +- .../0.39/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.39/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.39/qiskit.quantum_info.Choi.md | 12 +- .../0.39/qiskit.quantum_info.Clifford.md | 34 +-- .../0.39/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.39/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 6 +- .../0.39/qiskit.quantum_info.Operator.md | 28 +-- .../qiskit/0.39/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.39/qiskit.quantum_info.Pauli.md | 38 +-- .../0.39/qiskit.quantum_info.PauliList.md | 54 ++-- .../0.39/qiskit.quantum_info.PauliTable.md | 40 +-- .../0.39/qiskit.quantum_info.Quaternion.md | 14 +- .../0.39/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.39/qiskit.quantum_info.SparsePauliOp.md | 46 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.39/qiskit.quantum_info.Statevector.md | 40 +-- .../0.39/qiskit.quantum_info.Stinespring.md | 14 +- .../0.39/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.39/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.39/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.39/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.39/qiskit.quantum_info.entropy.md | 2 +- .../0.39/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.39/qiskit.quantum_info.partial_trace.md | 2 +- .../0.39/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.39/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.39/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.39/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.39/qiskit.result.ProbDistribution.md | 6 +- .../0.39/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.39/qiskit.result.Result.md | 16 +- .../qiskit/0.39/qiskit.result.ResultError.md | 2 +- .../0.39/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.39/qiskit.result.marginal_memory.md | 2 +- ...qiskit.result.sampled_expectation_value.md | 2 +- .../0.39/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.39/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.39/qiskit.synthesis.ProductFormula.md | 2 +- .../0.39/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../0.39/qiskit.tools.backend_monitor.md | 2 +- .../0.39/qiskit.tools.backend_overview.md | 2 +- .../qiskit/0.39/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.39/qiskit.tools.parallel_map.md | 2 +- .../0.39/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.39/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.39/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.39/qiskit.transpiler.Layout.md | 30 +-- .../0.39/qiskit.transpiler.PassManager.md | 16 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.39/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 12 +- .../qiskit/0.39/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.39/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.39/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...ranspiler.passes.CollectLinearFunctions.md | 4 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...r.passes.CommutativeInverseCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 4 +- .../0.39/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.39/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- .../qiskit.transpiler.passes.HLSConfig.md | 4 +- ...it.transpiler.passes.HighLevelSynthesis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 4 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- ...kit.transpiler.passes.OptimizeCliffords.md | 4 +- .../0.39/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- ....passes.ResetAfterMeasureSimplification.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.39/qiskit.transpiler.passes.Size.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.39/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.39/qiskit.transpiler.passes.Width.md | 4 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 4 +- ....plugin.HighLevelSynthesisPluginManager.md | 6 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 4 +- ...rs.plugin.PassManagerStagePluginManager.md | 4 +- ..._passmanagers.plugin.list_stage_plugins.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- .../0.39/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.39/qiskit.utils.apply_prefix.md | 2 +- .../0.39/qiskit.utils.deprecate_arguments.md | 2 +- .../0.39/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.39/qiskit.utils.detach_prefix.md | 2 +- .../0.39/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.39/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.39/qiskit.utils.has_ibmq.md | 2 +- .../0.39/qiskit.utils.is_main_process.md | 2 +- .../0.39/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 8 +- .../api/qiskit/0.39/qiskit.utils.name_args.md | 2 +- .../0.39/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.39/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.39/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 2 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 2 +- ...skit.visualization.pulse_v2.IQXStandard.md | 2 +- .../qiskit.visualization.pulse_v2.draw.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.timeline.draw.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.39/qiskit_aer.AerError.md | 2 +- .../api/qiskit/0.39/qiskit_aer.AerProvider.md | 6 +- .../qiskit/0.39/qiskit_aer.AerSimulator.md | 14 +- .../qiskit/0.39/qiskit_aer.PulseSimulator.md | 8 +- .../qiskit/0.39/qiskit_aer.QasmSimulator.md | 12 +- .../0.39/qiskit_aer.StatevectorSimulator.md | 8 +- .../0.39/qiskit_aer.UnitarySimulator.md | 8 +- .../api/qiskit/0.39/qiskit_aer.jobs.AerJob.md | 16 +- .../qiskit/0.39/qiskit_aer.jobs.AerJobSet.md | 20 +- .../0.39/qiskit_aer.library.SaveAmplitudes.md | 2 +- ...iskit_aer.library.SaveAmplitudesSquared.md | 2 +- .../0.39/qiskit_aer.library.SaveClifford.md | 2 +- .../qiskit_aer.library.SaveDensityMatrix.md | 2 +- ...qiskit_aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...skit_aer.library.SaveMatrixProductState.md | 2 +- .../qiskit_aer.library.SaveProbabilities.md | 2 +- ...iskit_aer.library.SaveProbabilitiesDict.md | 2 +- .../0.39/qiskit_aer.library.SaveStabilizer.md | 2 +- .../0.39/qiskit_aer.library.SaveState.md | 2 +- .../qiskit_aer.library.SaveStatevector.md | 2 +- .../qiskit_aer.library.SaveStatevectorDict.md | 2 +- .../0.39/qiskit_aer.library.SaveSuperOp.md | 2 +- .../0.39/qiskit_aer.library.SaveUnitary.md | 2 +- .../qiskit_aer.library.SetDensityMatrix.md | 2 +- ...iskit_aer.library.SetMatrixProductState.md | 2 +- .../0.39/qiskit_aer.library.SetStabilizer.md | 2 +- .../0.39/qiskit_aer.library.SetStatevector.md | 2 +- .../0.39/qiskit_aer.library.SetSuperOp.md | 2 +- .../0.39/qiskit_aer.library.SetUnitary.md | 2 +- .../qiskit_aer.library.save_amplitudes.md | 2 +- ...kit_aer.library.save_amplitudes_squared.md | 2 +- .../0.39/qiskit_aer.library.save_clifford.md | 2 +- .../qiskit_aer.library.save_density_matrix.md | 2 +- ...skit_aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...t_aer.library.save_matrix_product_state.md | 2 +- .../qiskit_aer.library.save_probabilities.md | 2 +- ...kit_aer.library.save_probabilities_dict.md | 2 +- .../qiskit_aer.library.save_stabilizer.md | 2 +- .../0.39/qiskit_aer.library.save_state.md | 2 +- .../qiskit_aer.library.save_statevector.md | 2 +- ...iskit_aer.library.save_statevector_dict.md | 2 +- .../0.39/qiskit_aer.library.save_superop.md | 2 +- .../0.39/qiskit_aer.library.save_unitary.md | 2 +- .../qiskit_aer.library.set_density_matrix.md | 2 +- ...it_aer.library.set_matrix_product_state.md | 2 +- .../0.39/qiskit_aer.library.set_stabilizer.md | 2 +- .../qiskit_aer.library.set_statevector.md | 2 +- .../0.39/qiskit_aer.library.set_superop.md | 2 +- .../0.39/qiskit_aer.library.set_unitary.md | 2 +- .../0.39/qiskit_aer.noise.LocalNoisePass.md | 4 +- .../0.39/qiskit_aer.noise.NoiseModel.md | 24 +- .../0.39/qiskit_aer.noise.QuantumError.md | 24 +- .../0.39/qiskit_aer.noise.ReadoutError.md | 24 +- .../qiskit_aer.noise.RelaxationNoisePass.md | 2 +- ...iskit_aer.noise.amplitude_damping_error.md | 2 +- ...qiskit_aer.noise.coherent_unitary_error.md | 2 +- .../qiskit_aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...skit_aer.noise.device.gate_error_values.md | 2 +- ...kit_aer.noise.device.gate_length_values.md | 2 +- ...skit_aer.noise.device.gate_param_values.md | 2 +- ...t_aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../0.39/qiskit_aer.noise.kraus_error.md | 2 +- .../qiskit_aer.noise.mixed_unitary_error.md | 2 +- .../0.39/qiskit_aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- .../qiskit_aer.noise.phase_damping_error.md | 2 +- .../0.39/qiskit_aer.noise.reset_error.md | 2 +- ...skit_aer.noise.thermal_relaxation_error.md | 2 +- .../0.39/qiskit_aer.primitives.Estimator.md | 4 +- .../0.39/qiskit_aer.primitives.Sampler.md | 4 +- .../0.39/qiskit_aer.pulse.PulseSystemModel.md | 10 +- .../qiskit_aer.pulse.duffing_system_model.md | 2 +- .../qiskit_aer.quantum_info.AerStatevector.md | 14 +- .../0.39/qiskit_aer.utils.NoiseTransformer.md | 36 +-- ...iskit_aer.utils.approximate_noise_model.md | 2 +- ...kit_aer.utils.approximate_quantum_error.md | 2 +- .../0.39/qiskit_aer.utils.insert_noise.md | 2 +- .../qiskit_aer.utils.remap_noise_model.md | 2 +- .../qiskit_aer.utils.transform_noise_model.md | 2 +- .../qiskit_aer.utils.transpile_noise_model.md | 2 +- ...iskit_aer.utils.transpile_quantum_error.md | 2 +- docs/api/qiskit/0.39/synthesis_aqc.md | 2 +- docs/api/qiskit/0.39/utils.md | 6 +- 1077 files changed, 2909 insertions(+), 2909 deletions(-) diff --git a/docs/api/qiskit/0.39/execute.md b/docs/api/qiskit/0.39/execute.md index b53a00ba90f..d62673a2e94 100644 --- a/docs/api/qiskit/0.39/execute.md +++ b/docs/api/qiskit/0.39/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.39/pulse.md b/docs/api/qiskit/0.39/pulse.md index 3577723448f..9c22da5c597 100644 --- a/docs/api/qiskit/0.39/pulse.md +++ b/docs/api/qiskit/0.39/pulse.md @@ -67,7 +67,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -171,7 +171,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -189,7 +189,7 @@ And classical IO channels are children of: -`ClassicalIOChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`ClassicalIOChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Base class of classical IO channels. These cannot have instructions scheduled on them. @@ -238,7 +238,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -687,7 +687,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.md index b890fa1dc3c..6e4d2584a43 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.md index bd3c7949124..05bf59a3ed9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/algorithm_job.py "view source code") +`AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/algorithm_job.py "view source code") Bases: `qiskit.primitives.primitive_job.PrimitiveJob` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.md index 39685958bd4..dd01febac14 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.md index 8e656d78048..6cb0adb4e58 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.md index dd249e9e3a2..063422e6092 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -77,7 +77,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -98,7 +98,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -119,7 +119,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -145,7 +145,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.md index cc58490a9ef..bc3ebe8dc99 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.md index 6cdb60be253..c2052f0f93b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.md index 6420e74110a..8bf61eadefe 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.md index d59a246e44a..3fa514ec7a0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.md index 763c2a602f2..6a1b20c1958 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.md index 3cc0b091b8d..9c311b4bfd9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.md index d8da8c5a7d4..be21024dad1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -40,7 +40,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.md index 97cc0e2d371..a5ced3d5793 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.md index f969e4b8057..b6c465b13ff 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -52,7 +52,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -72,7 +72,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 9ec8bc81804..604e762f6e1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.39/qiskit.algorithms.Grover.md index 4a0088a799a..7e84354406e 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -94,7 +94,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -121,7 +121,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -147,7 +147,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.md index 0c4d52808e7..300c674c672 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.md index 89d4e6243a9..88b5a782d0e 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -58,7 +58,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 93ddcec082c..4c3603264f4 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.md index 8a44238e51c..996ca225c82 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The ImaginaryEvolver interface has been superseded by the `qiskit.algorithms.tim -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.md index de2d443a030..3945f038557 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`abstract ImaginaryTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.md index 1df11dc1654..73ee23ac58c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -78,7 +78,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 0776b7837d9..4486ef7963a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.md index 32bba477d2d..64933c11bd2 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -39,7 +39,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -65,7 +65,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 9beb552d754..3e30acf7f0f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -45,7 +45,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -71,7 +71,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -92,7 +92,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -109,7 +109,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 91849a294a6..150b6a5e509 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.md index 86bd0bcd32c..5416ee768a5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.md index 7e6a45f5e9c..d1320f8a48f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.md index 650e02d4982..d3d6fc55559 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -56,7 +56,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.md index 20f595a6427..c31ec0e0800 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -28,7 +28,7 @@ The NumPyMinimumEigensolver class has been superseded by the [`qiskit.algorithms -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -49,7 +49,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.md index 6128a59b92a..f75fbfb8f93 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -159,7 +159,7 @@ quantum algorithm for the time evolution of parameterized circuits, [Quantum 5, -`PVQD.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. @@ -186,7 +186,7 @@ A result object containing the evolution information and evaluated observables. -`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Get a function to evaluate the infidelity between Trotter step and ansatz. @@ -211,7 +211,7 @@ a second callable to evaluate the gradient of the infidelity. -`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform a single time step. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.md index c5a3ddf9bb5..27fada19ac8 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.md index e71fe5d3c0a..a14216ae997 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -66,7 +66,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -80,7 +80,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -101,7 +101,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.md index eee9247a89e..58cc03ce908 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.md index 24d270dbc49..a938964ea42 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.md index e0badcee877..134ebb3fd45 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.md index 8b4dc4c824e..3116a9e0739 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The RealEvolver interface has been superseded by the `qiskit.algorithms.time_evo -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.md index 10e56b22086..b584bec493f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`abstract RealTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.39/qiskit.algorithms.Shor.md index 1fd6378cbc2..fa3b39de962 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -56,7 +56,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -84,7 +84,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.md index 0baff1861a5..86dfb21e4b7 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.md index 63a01df041e..7d1e6f12b57 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: `object` @@ -98,7 +98,7 @@ dict\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), complex] -`TimeEvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.md index 88afce37e4f..5c785e0b1fc 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.md index 40d963a5538..b937e6d087a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -51,7 +51,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -80,7 +80,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.39/qiskit.algorithms.VQD.md index fa77911d8ac..811820f6795 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -48,7 +48,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -69,7 +69,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -90,7 +90,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -117,7 +117,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -147,7 +147,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -163,7 +163,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.md index a8b9913a5b7..2bf42e9b773 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.39/qiskit.algorithms.VQE.md index 181db0cc2d9..31a9886627b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -76,7 +76,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -97,7 +97,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -118,7 +118,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -145,7 +145,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -172,7 +172,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -188,7 +188,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.md index 547be6697f7..b50f3182b97 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ An eigensolver result. -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.md index 539c21d55d1..014dea15ac8 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index da69b3d2ef6..327d575b389 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -33,7 +33,7 @@ The NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valu -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -54,7 +54,7 @@ An eigensolver result. -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index a4df6c777c9..d42dfa41c46 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.md index 85b0a234c95..814bf71cb68 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -144,7 +144,7 @@ An eigensolver result. -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.md index a0d8d2ea907..4664ee80143 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.estimate_observables.md b/docs/api/qiskit/0.39/qiskit.algorithms.estimate_observables.md index 2ddf116c17a..0d1c4df5d63 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.estimate_observables.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.estimate_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.estimate_observables -`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/observables_evaluator.py "view source code") +`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.39/qiskit.algorithms.eval_observables.md index c5536797d89..911068ae17b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/aux_ops_evaluator.py "view source code") Pending deprecation: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 7abf398a24e..2d3344d07dc 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`BaseEstimatorGradient(estimator, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient(estimator, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Bases: `abc.ABC` @@ -27,7 +27,7 @@ Base class for an `EstimatorGradient` to compute the gradients of the expectatio -`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Run the job of the estimator gradient on the given circuits. @@ -51,7 +51,7 @@ The job object of the gradients of the expectation values. The i-th result corre -`BaseEstimatorGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.md index c602f1dab11..0aa1dc45785 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Bases: `abc.ABC` @@ -27,7 +27,7 @@ Base class for a `SamplerGradient` to compute the gradients of the sampling prob -`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Run the job of the sampler gradient on the given circuits. @@ -50,7 +50,7 @@ The job object of the gradients of the sampling probability. The i-th result cor -`BaseSamplerGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.md index 811e6c593fb..3cd56e35baa 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") +`EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 7ef6243ee55..a1e8480adac 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`FiniteDiffEstimatorGradient(estimator, epsilon, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") +`FiniteDiffEstimatorGradient(estimator, epsilon, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index a70dcadb900..1723d1758cb 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`FiniteDiffSamplerGradient(sampler, epsilon, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") +`FiniteDiffSamplerGradient(sampler, epsilon, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index 26d3a8f2428..0b36069d3b9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`LinCombEstimatorGradient(estimator, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") +`LinCombEstimatorGradient(estimator, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.md index f17da0e405b..9934e70858a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`LinCombSamplerGradient(sampler, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") +`LinCombSamplerGradient(sampler, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 6b1433f564e..0c8ab327ca8 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`ParamShiftEstimatorGradient(estimator, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") +`ParamShiftEstimatorGradient(estimator, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 371f89f942d..79b46fd224c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`ParamShiftSamplerGradient(sampler, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") +`ParamShiftSamplerGradient(sampler, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index a5b0658483f..89585518433 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") +`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.md index da8926accc5..fa4ad0afbba 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") +`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.md index f0570470ce1..aa9b22379ec 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") +`SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 05dd0082b65..9272062ff22 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -57,7 +57,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -77,7 +77,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -97,7 +97,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -117,7 +117,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.md index 296d2621c76..5ef8470d80d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -73,7 +73,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -101,7 +101,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.md index 0bbe8223807..e3c87d50dac 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.md index 709ac5eda7e..e660cf3390b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index c97816b96ac..62d0a64d58f 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -543,7 +543,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1249,7 +1249,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2301,7 +2301,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index fcef3942028..0d396f30657 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.md index a1db6a81c85..548439d596d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -72,7 +72,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -92,7 +92,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -112,7 +112,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -132,7 +132,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index bc721dfbab7..09cac3b8d2e 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -47,7 +47,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.md index ba514285ef9..065c2cd2a00 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -569,7 +569,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1275,7 +1275,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1813,7 +1813,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2327,7 +2327,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index 066c326713d..bfad233de9a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -582,7 +582,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1288,7 +1288,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1826,7 +1826,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2340,7 +2340,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index c8a3aaff2bc..234f56aa792 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -69,7 +69,7 @@ the maximum number of iterations for the adaptive loop. If `None`, the algorithm -`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Computes the minimum eigenvalue. @@ -95,7 +95,7 @@ An [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qis -`classmethod AdaptVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`classmethod AdaptVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 542ef4d0110..5e1eb5db344 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 24c9a021034..6a8d60fa196 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ A minimum eigensolver result. -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index fad1ea0efb1..24558cecf74 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index d68a79a869b..136bfde64be 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -26,7 +26,7 @@ The NumPy minimum eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -47,7 +47,7 @@ A minimum eigensolver result. -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 408a31e9e3d..52a0579b8ea 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.md index cd70990aea6..164869caf64 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 92f085c02bf..3786f05213c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Sampling Minimum Eigensolver Interface. -`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -43,7 +43,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`classmethod SamplingMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index faf3bbc1eae..6c356263981 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 823edd63222..e505a8995a0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -144,7 +144,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`classmethod SamplingVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index 0f8c349a2b2..9b29632d158 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.md index e7b9939ffb8..0e770255428 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -129,7 +129,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -150,7 +150,7 @@ A minimum eigensolver result. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index f92516e5391..e6989e94393 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.md index 4de646e8a23..5a0c83276d5 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.md index 99096337f4a..753a0c80941 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.md index 2975a66297a..054500e6cb9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.md index 7627fa03857..066e18658d7 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.md index bf09d0512c5..b2b044733d3 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.md index a146063874c..7718faf46c9 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.md index a442401291c..e95f7ba042a 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.md index 2d6ee0257d2..4783a7289e0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index ea8fba8d881..3df083d1af3 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.md index b99a2f527bd..033df96fe92 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.md index f7db84d87ff..20a6791f653 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.md index 8d918f287d3..5e53bcc9b4d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") @@ -141,7 +141,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`GradientDescent.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Returns an object with the data needed to evaluate the gradient. @@ -155,7 +155,7 @@ If this object contains a gradient function the gradient can be evaluated direct -`GradientDescent.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Condition that indicates the optimization process should come to an end. @@ -173,7 +173,7 @@ When the stepsize is smaller than the tolerance, the optimization process is con -`GradientDescent.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Creates a result of the optimization process. @@ -191,7 +191,7 @@ The result of the optimization process. -`GradientDescent.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Evaluates the gradient. @@ -213,7 +213,7 @@ The data containing the gradient evaluation. -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -299,7 +299,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`GradientDescent.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -332,7 +332,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.GradientDescent#ask -`GradientDescent.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Updates `x` by an ammount proportional to the learning rate and value of the gradient at that point. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.md index 77fe4c97d7a..fecc5bd99c4 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.md index 35e38dcf18f..41394b56258 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.md index 5ff9d439dff..ff61b58c1ba 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.md index 5bf202b30d6..e7dd0f8e1bc 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.md index 8a7ca184d11..4eb042f266b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.md index cf8bccd978f..e2a28f134d6 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.md index 8fd8c8a68ce..16157ca106c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.md index 9c1ac041872..dfc5627aa9b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.md index bb0e8763917..51dcafc55ea 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.md index c08733d6d7e..1791fc1b4cf 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index d638855f533..d7e09f83d9b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.md index 0a812f1f0bf..93ee26ff7ad 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.md index 9094b5aca3a..03a7b2fc525 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.md index 523166ac3cc..d6910b9e56d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -154,7 +154,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.md index 3535fe5d3c3..f54d6cf0f97 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.md index 01df61fc999..0878995a17b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -37,7 +37,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -68,7 +68,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.md index 821a4fefc66..e96e55e8116 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.md index 1a9b1962591..dfabf893ccb 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.md index bc182c4a2e5..ccccc698085 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -77,7 +77,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`SteppableOptimizer.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Ask the optimizer for a set of points to evaluate. @@ -95,7 +95,7 @@ An object containing the data needed to make the funciton evaluation to advance -`SteppableOptimizer.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Condition that indicates the optimization process should continue. @@ -111,7 +111,7 @@ Condition that indicates the optimization process should continue. -`abstract SteppableOptimizer.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Returns the result of the optimization. @@ -129,7 +129,7 @@ The result of the optimization process. -`abstract SteppableOptimizer.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Evaluates the function according to the instructions contained in `ask_data`. @@ -182,7 +182,7 @@ grad -`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Minimizes the function. @@ -237,7 +237,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -256,7 +256,7 @@ Populates the state of the optimizer with the data provided and sets all the cou -`SteppableOptimizer.step()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.step()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Performs one step in the optimization process. @@ -270,7 +270,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#a -`SteppableOptimizer.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Updates the optimization state using the results of the function evaluation. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.md index e0677f01e7c..c0658e79da0 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.md index 8a7a72e5ec5..ed9196263db 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.md index cd3a13dc3ca..6099fd4b5e7 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 9e2e440bd74..30cc60e271b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: `Generator` @@ -34,7 +34,7 @@ Raise GeneratorExit inside generator. -`LearningRate.send(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.send(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Send a value into the generator. Return next yielded value or raise StopIteration. @@ -42,7 +42,7 @@ Send a value into the generator. Return next yielded value or raise StopIteratio -`LearningRate.throw(typ, val=None, tb=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.throw(typ, val=None, tb=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Raise an exception in the generator. Return next yielded value or raise StopIteration. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index 7a3a1560293..5511c5d8d37 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: `abc.ABC` @@ -28,7 +28,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. @@ -49,7 +49,7 @@ The fidelity quantum circuit corresponding to `circuit_1` and `circuit_2`. -`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.md index 27b379487cb..e7116f7a10b 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`ComputeUncompute(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") @@ -39,7 +39,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Combines `circuit_1` and `circuit_2` to create the fidelity circuit following the compute-uncompute method. @@ -80,7 +80,7 @@ Primitive job for the fidelity calculation. The job’s result is an instance of -`ComputeUncompute.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Update the fidelity’s default options setting. diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.md index 0cecde44ae8..4985f76bc6c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index e0bd92111a7..e34c28b1f59 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`TrotterQRTE(product_formula=None, estimator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, estimator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using an estimator primitive provided. @@ -78,7 +78,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.md index c9da235cb7b..3c5454959d6 100644 --- a/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.39/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.39/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.39/qiskit.assembler.assemble_circuits.md index f8dddee0fb2..6e1aad4ceb7 100644 --- a/docs/api/qiskit/0.39/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.39/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.39/qiskit.assembler.assemble_schedules.md index d84dd49de0a..11c73d7bc11 100644 --- a/docs/api/qiskit/0.39/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.39/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.39/qiskit.assembler.disassemble.md index e10248e89b4..a432e6e0ed8 100644 --- a/docs/api/qiskit/0.39/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.39/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.md index cea75b50435..6129e32a9c6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.md index 59ac6beaaf1..be282fc4e01 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.md index a655283267d..7af8aa87c3a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.md index 42e95ca2558..df666215c4d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.md index b268976dfd0..65817563d79 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.39/qiskit.circuit.Clbit.md index 793f665f069..1b3b467d368 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.md b/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.md index 04ca76ef390..ba03d012773 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.CommutationChecker.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CommutationChecker -`CommutationChecker`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/commutation_checker.py "view source code") +`CommutationChecker` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/commutation_checker.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ This code is essentially copy-pasted from commutative\_analysis.py. This code cl -`CommutationChecker.commute(op1, qargs1, cargs1, op2, qargs2, cargs2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/commutation_checker.py "view source code") +`CommutationChecker.commute(op1, qargs1, cargs1, op2, qargs2, cargs2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/commutation_checker.py "view source code") Checks if two Operations commute. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.md index 3bbfc38c4e9..f9106d8d8b5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.md index 7e25a3fb3de..880b0035a94 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.md index 5375ca79227..99fcdd65e18 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -224,7 +224,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Delay.md b/docs/api/qiskit/0.39/qiskit.circuit.Delay.md index 59ed7ea7fe6..e5af7abda51 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.md index 137465b62fb..043183b963e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.md index 2cc4615ae2b..a2d91060d86 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Gate.md b/docs/api/qiskit/0.39/qiskit.circuit.Gate.md index 6dd6ef92682..875a4394529 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.md index c925b363f56..ff2b7cc7800 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.39/qiskit.circuit.Instruction.md index f434ec27069..46d2dd2aba0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.md index 8f14d9abdaa..4347a91797f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -116,7 +116,7 @@ c0: 2/══════╩══╩═╡ 0x2 ╞╡ c0_0=0x1 ╞ -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Operation.md b/docs/api/qiskit/0.39/qiskit.circuit.Operation.md index 05e8c74cd55..432abea1ceb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/operation.py "view source code") +`Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/operation.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.39/qiskit.circuit.Parameter.md index d2ed389b456..8d4892d0106 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -206,7 +206,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.md index 9eac8f9f61b..8aaf73d7baf 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -106,7 +106,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -118,7 +118,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -126,7 +126,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -134,7 +134,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -154,7 +154,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -162,7 +162,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -170,7 +170,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -178,7 +178,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -204,7 +204,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -218,7 +218,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.md index d262cec7eaa..98448de6cee 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.md index 6fb0076c466..fc25451aecd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -127,7 +127,7 @@ ancilla: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -139,7 +139,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -162,7 +162,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -174,7 +174,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -204,7 +204,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -308,7 +308,7 @@ q_1: ────────────┤ Rx(P[1]) ├ -`QuantumCircuit.barrier(*qargs, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -329,7 +329,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -358,7 +358,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -382,7 +382,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -394,7 +394,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -414,7 +414,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -439,7 +439,7 @@ A handle to the instructions created. -`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). @@ -465,7 +465,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -490,7 +490,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -504,7 +504,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -516,7 +516,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -528,7 +528,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -557,7 +557,7 @@ A handle to the instructions created. -`QuantumCircuit.combine(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.combine(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Returns rhs appended to self if self contains compatible registers. @@ -585,7 +585,7 @@ Returns a new QuantumCircuit object -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -641,7 +641,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -665,7 +665,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -691,7 +691,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -711,7 +711,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -737,7 +737,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -753,7 +753,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -779,7 +779,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -805,7 +805,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -831,7 +831,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -857,7 +857,7 @@ A handle to the instructions created. -`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). @@ -882,7 +882,7 @@ A handle to the instructions created. -`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). @@ -907,7 +907,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -933,7 +933,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -958,7 +958,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -987,7 +987,7 @@ A handle to the instructions created. -`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). @@ -1013,7 +1013,7 @@ A handle to the instructions created. -`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). @@ -1041,7 +1041,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -1066,7 +1066,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -1091,7 +1091,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -1116,7 +1116,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1139,7 +1139,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1160,7 +1160,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1186,7 +1186,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1237,7 +1237,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1312,7 +1312,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1335,7 +1335,7 @@ A handle to the instructions created. -`QuantumCircuit.extend(rhs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.extend(rhs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. @@ -1363,7 +1363,7 @@ Returns this QuantumCircuit object (which has been modified) -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1394,7 +1394,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1449,7 +1449,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1477,7 +1477,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1497,7 +1497,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1517,7 +1517,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1537,7 +1537,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1567,7 +1567,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1575,7 +1575,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1595,7 +1595,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1617,7 +1617,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1643,7 +1643,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1689,7 +1689,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1865,7 +1865,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1967,7 +1967,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1990,7 +1990,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -2076,7 +2076,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2117,7 +2117,7 @@ A handle to the instructions created. -`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcu1(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply `MCU1Gate`. @@ -2141,7 +2141,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2178,7 +2178,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2203,7 +2203,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2225,7 +2225,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2254,7 +2254,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2277,7 +2277,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2297,7 +2297,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2311,7 +2311,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2327,7 +2327,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2339,7 +2339,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2362,7 +2362,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2383,7 +2383,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2523,7 +2523,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2550,7 +2550,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2570,7 +2570,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2590,7 +2590,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2617,7 +2617,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2644,7 +2644,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2668,7 +2668,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2693,7 +2693,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2717,7 +2717,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2739,7 +2739,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2759,7 +2759,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2779,7 +2779,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2833,7 +2833,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2873,7 +2873,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2900,7 +2900,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2924,7 +2924,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2948,7 +2948,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2972,7 +2972,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2996,7 +2996,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -3019,7 +3019,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -3043,7 +3043,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -3067,7 +3067,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3479,7 +3479,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3647,7 +3647,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3725,7 +3725,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3748,7 +3748,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3770,7 +3770,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3792,7 +3792,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3814,7 +3814,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3836,7 +3836,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3889,7 +3889,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3910,7 +3910,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3931,7 +3931,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3959,7 +3959,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3984,7 +3984,7 @@ A handle to the instructions created. -`QuantumCircuit.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). @@ -4007,7 +4007,7 @@ A handle to the instructions created. -`QuantumCircuit.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). @@ -4031,7 +4031,7 @@ A handle to the instructions created. -`QuantumCircuit.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). @@ -4191,7 +4191,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -4236,7 +4236,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -4252,7 +4252,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4275,7 +4275,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4297,7 +4297,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.md index 5d8c3972c72..071959d21f4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.39/qiskit.circuit.Qubit.md index 1d167e37f91..381750a3823 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.md index 97b93cfb9be..b1cd46d7fa1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.md index 6603250934b..3ca56e2d63c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.md index eb63b5c4f00..46e49a15a5d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 8069cca8285..66f9c7c51e6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 655a3fd7473..fb0a7622c4b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.39/qiskit.circuit.library.AND.md index 54598819c3a..ada1942e886 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.md index 7eb26e903b4..df45041cde5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -49,7 +49,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -70,7 +70,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -104,7 +104,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.md index e585ed10374..67186ae619d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.md index d8f485adfb6..e0de5deb4b1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.md index 74d61e25fdd..3eddf51233b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.md index b7c73510911..3dd512fa958 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.md index 22e45f5f8b9..e6f08dd8b74 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`CCZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`CCZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -57,7 +57,7 @@ Create new CCZ gate. -`CCZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`CCZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CCZ gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.md index 588fc9d2226..05e88867b44 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.md index 669c44e9ac8..fe18a3a7f24 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.md index a7196bca601..592dca2c20a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.md index 0a1ab06305e..747626c7ab5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.md index f1d258a728a..026048ea233 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.md index ef5cde23b50..04057512e36 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.md index 321940d523c..d37c49e93aa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`CSGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -48,7 +48,7 @@ Create new CS gate. -`CSGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of CSGate (CSdgGate). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.md index 6435d01b93f..3316524a6a4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.md index f89afc41ff2..69c714d649d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`CSdgGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSdgGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -48,7 +48,7 @@ Create new CSdg gate. -`CSdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of CSdgGate (CSGate). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.md index 47566109ff5..d681a349733 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.md index 2630a818480..9509b19fd75 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.md index 87dbc5d1250..26ed48dc7ee 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.md index 39d634c9760..70ae7306f68 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.md index 13b304db52a..9f7e7924f61 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.md index ff9f8be53f3..02e81f237d4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.md index 7405568d1ae..65d81d23bcd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.md index a17180dcbd5..c02e7486ab1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.md index 718b42edf86..34ac08bc406 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.md index 09b1b177729..b935e91fc47 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.md index 1b8822d29b6..e2b3fe8ed62 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.md index 4da907dcefd..da224c69131 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 7880dce15d2..08d1ef166e2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.md index 6b17caccaf5..250eedaf1be 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.md index 52a5133009c..72d80eeb75e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.md index 07501ad6bef..b6805aa8c9f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.md index 2835a658e6a..a4cdd029ccb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.md index 2f5aace6940..29ba9341dab 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GR.md index 0709537aabe..2928e3363d2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.md index 88fbef12a6f..29feecc1188 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.md index 74c466237f3..f49cfab719d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.md index d663e1b5c2c..68f4d5c89d9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.md index 8e9417a93a4..1445cc9250a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.md index 95fd6f0fa58..d56000e309d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.md index 4434444f515..2533c70eb5b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.md index a8afb53dff7..e99346cfc82 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.md index 44cb2854655..9a4570b1086 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.md index d2495628bfd..3113e8662b6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.md index d0b06eb63cb..ea2be5b0b44 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.md index eef386accba..7101caa42cd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.md index b9e4fdb1df5..d9d90d4fdbf 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.md index 991cc36d857..2fd45bcbf76 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.md index 55e08d2df89..4a17715f1ed 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.md index 97786b4e24d..2f1ca986325 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.md index 7c2cb36a72e..628e7af1ff2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -53,7 +53,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -61,7 +61,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.md index 661ff61509b..ab2ab8b2f30 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -75,7 +75,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.md index e835cf81f88..2c5042c5e02 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.md index 8db8efe54a4..aa0c46368b9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.md index 97a3c465c42..6a333a2b507 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.md index fd12194dc95..84a29bb0c01 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.md index aff2a542158..4b84661950a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.md index 9b7089fff71..6d7d5b2a6ba 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.md index cff6c919ab4..64f9c247116 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.md index e3e4e8e9e84..7c596325673 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -75,7 +75,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -101,7 +101,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -123,7 +123,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -155,7 +155,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -171,7 +171,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.39/qiskit.circuit.library.OR.md index df414a962f6..269b54dcfda 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.md index e6ad539f924..2e7bd347c56 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.md index 8b182c38fcd..82898c3dd51 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.md index af30c95204a..06e7641b304 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.md index 513716adbb6..0315d0ddcac 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.md index a3b232eda8a..cbdf48a488e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.md index 34d921f6baa..0082d364607 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.md index 00931f51df4..c6ecd06633a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.md index 738258e31de..95872c739de 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.md index e58bd9166de..a2f9aed12b2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 90003521d20..0c4f7c5d1f5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index d9604ad1903..a7bb7d9960f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.md index f31f0cbba81..1b7521f7a21 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.md index d2bbd8c152d..aaeb3c40b82 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.md index 052fd59c42f..91321f92b8e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -49,7 +49,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -65,7 +65,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.md index 64c83121316..4e11f583b9a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.md index b34abc2a7a4..702064de4b0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.md index 4136449b632..1e4c2a449d3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.md index cfd13e1ac72..10058a10ba3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.md index 8a13ab98219..60dfc1d70a7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.md index 65acf9d3e59..a516350fe66 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.md index 0845666cc2a..e3f183e84cb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.md index 12ead87b25d..a68bf1a5159 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.md index 4b3612dc3cf..640618dafa9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.md index 92bb1e32186..21c2bdc3393 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.md index 8c8559c9e3c..15742d4ff45 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.md index d975264b92b..e4a618f19c7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.md index c9ecccf43a1..edbe481b7e4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.md index 95241a6c25c..1e8f6ba5807 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.md index 8e9b88a2db0..ff13cdd4cf2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.md index 227448c5686..c25bb98afb9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.md index 13c5f2b937b..5ccdfebf9d5 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.md index 79ae42dfa5e..8299293fbe4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.md index ee033666370..478958a3ccc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.md index 80d0ff1b00e..df8b0f5a261 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.md index 549f86ebb13..766e3b044a4 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.md index 6fec2357643..f8b11e30b6e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.md index edc3caca2eb..0be621f0471 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.md index f8968067573..82fe3e82cbd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.md index d2894fa46d8..8b039bb5efa 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -134,7 +134,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.md index 80d2cfa9007..151f513692e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -83,7 +83,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -105,7 +105,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.md index f91c5e6d682..999959f4a1e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.md index 4c94b3b8de9..f4aa658cd82 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -96,7 +96,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.md index 726535d83bb..b604ff3ae2c 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.md index aa81cc4feb4..0ec23b66159 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.md index 27570e0b340..563fb229706 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.md index 218018de13d..96255348e5e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.md index ca928ed26c9..9c9eb6c4ae9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.md index e14d1b5d1ed..1f38539b443 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.md index f6f66a3186f..37afe36093d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.md index defc56babdb..1082978f11f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.md index 6e6e4ba48cb..016d560f201 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.md index 40e429e6d75..f03479fe755 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.md index efe18053bac..3081ffc4af1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_1.md index 401ebadea5e..4435fc51a2d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_2.md index 0a30c348026..c654b94051d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_3.md index a162dc9ae67..10c4f80c337 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_4.md index 18c1d634903..5533933a2cd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_3_1.md index e73457e505c..cc3a4d4dc79 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_1.md index 6c7c0cd03fc..ddb791f4967 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_2.md index 8ded5564b15..da646836b63 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_3.md index 45c3ca2f8db..1010002fb2b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_4.md index 266da3584f3..bbfbdd17868 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_5_1.md index 7ffd3a062ac..991c2529e10 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_1.md index 61dbcb59655..d291aeafac7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_2.md index ca5ef0166e9..b918ce64641 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_3.md index bb9597993ba..4b33a5b92cd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_4.md index 007cbfa241e..7f7a3951eda 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_5.md index 2d730b6ffaa..b0ec96b4a82 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_1.md index 8d43aee6e26..752d484ac22 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_2.md index ffbbb47e419..5fd66975705 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_3.md index c20cd9abf00..ad9574b1909 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.md index fb53b41d1fb..47e659882eb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_cy.md index 60c7fd9a16c..e26968574bb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_xz.md index 2281ef1ab35..fe16428dca1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_yz.md index 91d9c1cf7cb..32ed8cc7893 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz1.md index 4a1fdb108a4..d2f0a0b19cd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz2.md index c3b6263b2ca..e194e5c8041 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz3.md index d532980cba6..d78584f3e22 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index da178ceb395..544fde82554 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index ac570d64ecf..c86f93cdcb7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 35649ceb972..604b3b3688b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 71df3a386a9..eebc8780b1f 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index dd95f78bf58..c5cbd8ba718 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index 9c97c2975e5..efce0ecc71a 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 957c760a184..e84faad7f06 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 234fa93879e..77b216d0ca3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 06f7db98feb..2b576c06d22 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index ac43332c183..8d9c8844cac 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 07881396d6a..fcaf2c6938b 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index 3a8a1c712ad..80c0492d193 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 681a8249d45..0f037802aa7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 2eb74a89c89..47198d82217 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 649af1ee208..8ed01d62225 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 10f82d21bf8..b1b250d58e9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index a9234ca2c16..a8408d99739 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index cc179acbec5..31346226611 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index c002d1cdf23..fbf3023e24d 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 212509bee17..5a8d0c79ffd 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 2acee04499c..37e20e63a48 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index a8653e073af..c74ad708114 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index f17dcbd1476..71a75cb82e3 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index cd4a719a3a3..b989634f2f1 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index d1fad227024..3da95d40035 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index a808e5bafeb..edab7eb178e 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index fd0d3dfa530..0aad6ba79a2 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 94304743395..90e18262812 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 1c03ff854a1..22a5e3a82b6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 1b134dcb2b4..586359213f7 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 634b433390f..a3a2bac2748 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 11fcaab9497..1d4a9d1e2d9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 85f568431bd..2ab37c2aba0 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 58a611bd92e..fa2f799e3ae 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 92258332cf8..819d063d5ee 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 59827564a5e..f75ae4fb7f9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 73c38e6eb69..43fcaf713fb 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 2732cb26717..887ecf18095 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index e9224e12327..140181b5cef 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index f43e7726c37..27f9cf42329 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index d153a66e846..82344716d59 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 0043984c5b6..a5ed1cddb14 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 7f2d461a96d..adbc0c823fc 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 8dbc3ef1ea1..6c94639cf68 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index e791e331192..7ca4a23acd6 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index e32edb892f9..fb56cbc38b9 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index dd8587f774d..b9d7fc65136 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.39/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.39/qiskit.circuit.random.random_circuit.md index e4a8eb92317..385d2b397cf 100644 --- a/docs/api/qiskit/0.39/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.39/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.39/qiskit.compiler.assemble.md b/docs/api/qiskit/0.39/qiskit.compiler.assemble.md index 47219f502cd..328b3de90d8 100644 --- a/docs/api/qiskit/0.39/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.39/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.39/qiskit.compiler.schedule.md b/docs/api/qiskit/0.39/qiskit.compiler.schedule.md index 752210f0e0c..875e17f815b 100644 --- a/docs/api/qiskit/0.39/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.39/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.39/qiskit.compiler.sequence.md b/docs/api/qiskit/0.39/qiskit.compiler.sequence.md index 5a9f5aff4e6..684e8199887 100644 --- a/docs/api/qiskit/0.39/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.39/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.39/qiskit.compiler.transpile.md b/docs/api/qiskit/0.39/qiskit.compiler.transpile.md index 0120531aee6..21f86b86f95 100644 --- a/docs/api/qiskit/0.39/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.39/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.39/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.39/qiskit.converters.ast_to_dag.md index bff1d9e549f..91385babc5d 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.39/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dag.md index cd1b5a5bc3c..8c508ff5a57 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dagdependency.md index 85b1f52ce4e..3017fca8cdf 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_gate.md index f2a05de66fa..1a99c887101 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_instruction.md index 857af24ae71..6f8135ecbbe 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.39/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.39/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.39/qiskit.converters.dag_to_circuit.md index cd0cb0130f4..99af3fd1e3b 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.39/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.39/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.39/qiskit.converters.dag_to_dagdependency.md index 34920400328..233cc137b9c 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.39/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_circuit.md index 0e03c714103..2cf7e0527ee 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_dag.md index 30015d77a82..e6880ef6e4c 100644 --- a/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.39/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.md index eab17357a4b..5f5c9b6bc5e 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops(*, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops(*, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -248,7 +248,7 @@ Mapping\[str, int] -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -258,7 +258,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be staticly known. @@ -283,7 +283,7 @@ int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -291,7 +291,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -315,7 +315,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -337,7 +337,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`classmethod DAGCircuit.from_networkx(graph)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`classmethod DAGCircuit.from_networkx(graph)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Take a networkx MultiDigraph and create a new DAGCircuit. @@ -364,7 +364,7 @@ MultiDiGraph. -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -372,7 +372,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -388,7 +388,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -396,7 +396,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -416,7 +416,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -424,7 +424,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -432,7 +432,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -446,7 +446,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -454,7 +454,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -462,7 +462,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -470,7 +470,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -478,7 +478,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -498,7 +498,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -510,7 +510,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -531,7 +531,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -539,7 +539,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -547,7 +547,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -555,7 +555,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -576,7 +576,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -584,7 +584,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -592,7 +592,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -600,7 +600,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -608,7 +608,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -616,7 +616,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -624,7 +624,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -640,7 +640,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -653,7 +653,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -661,7 +661,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -669,7 +669,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -677,7 +677,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -687,7 +687,7 @@ Add edges from predecessors to successors. -`DAGCircuit.remove_qregs(*qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qregs(*qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -700,7 +700,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_qubits(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qubits(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Remove quantum bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -716,7 +716,7 @@ Remove quantum bits from the circuit. All bits MUST be idle. Any registers with -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single. @@ -737,7 +737,7 @@ This is used to consolidate a block of DAGOpNodes into a single operation. A typ -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -753,7 +753,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -763,7 +763,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be statically known. @@ -787,7 +787,7 @@ int -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction. @@ -814,7 +814,7 @@ the new node containing the added instruction. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -841,7 +841,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -849,7 +849,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Returns a copy of the DAGCircuit in networkx format. @@ -857,7 +857,7 @@ Returns a copy of the DAGCircuit in networkx format. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -877,7 +877,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -899,7 +899,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -907,7 +907,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.md index 1a244ffd558..fb9bee2c938 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.md index 0c04f16227b..be8af35ab2f 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.md index 541a556cb77..e39dcd5d233 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -311,7 +311,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -331,7 +331,7 @@ List -`DAGDependency.to_networkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_networkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Returns a copy of the DAGDependency in networkx format. @@ -339,7 +339,7 @@ Returns a copy of the DAGDependency in networkx format. -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -347,7 +347,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.md index 9b7e7a5b715..7539af22073 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.md index 8b7afca5092..80685d2cc34 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.md index 964d58fe75b..4ea8b66e865 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.md index ed8c31807f8..b34b5986205 100644 --- a/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.39/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.md index 585d6e80f99..fc42133974e 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.39/qiskit.extensions.Initialize.md index 77e6cf5d91e..a9f0f2481db 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.md index fdc85f1caee..456edcdc5fa 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.md index 16a936d6e3a..b564a92dd2c 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.md index d190311673a..e9788b26344 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.md index 4072328ab4e..f680a3909e6 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.md index 5c26ed9d2d1..1af4337c035 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.md index bcc90d00574..6854aa1b779 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.md index d999f741e7a..7184a20ecb0 100644 --- a/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.39/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.md index dfd95c6cbc1..6e9b7e9af32 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.md index b00dcb5f852..c8717e0d474 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.39/qiskit.opflow.anti_commutator.md index ff889e3ac8c..b897955e987 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.commutator.md b/docs/api/qiskit/0.39/qiskit.opflow.commutator.md index f0b5eb5a22d..97ee496f5b6 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.md index ce6da5fdf87..9b84a3e59c6 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.md index ffa02fcf7e0..48cd4e2d34b 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.md index 7f224652e43..59dd51b319a 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.md index 501ad09c78b..f10a4feb0c9 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.md index bae66c13c6b..a73d0b8bfc7 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.md index b8bc0d580b3..7427fc459b4 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.39/qiskit.opflow.double_commutator.md index b23de4afb36..f416827888e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.md index 7796c61bb1b..608fe7bd441 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.md index 68fb4d818e2..0caecff8c65 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.md index 09e0aa7d5d5..1204c6597ad 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.md index f138a7b5c13..af8936f11b4 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.md index b07cc67ca64..a9c4bb40692 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.md index b25c55e2de8..9b3fefba7ea 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.md index 550583541f8..bd1c1df2ce6 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.md index c417c1d222b..faf5bdcea76 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.md index be219effe58..f564e18bbb3 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.md index b6d0f47a2f9..19416663c88 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.md index 7773c02a03e..a21860bef5c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.md index aff315b180f..baf56465bf0 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.md index 263ba67b1ba..d3aaee8762c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.md index 8cb27d91c1f..f69ef1023d3 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.md index 2de9e41965f..1e6fa7c9f84 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.md index 319c1c4e650..6cf5d665cc0 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.md index e38711f3b19..68c7959fb51 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.md index 8285c44a56e..36abc525f21 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.md index 671cb2ea2d1..090d172e0c6 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.md index b2f6f406a26..45fee7120e4 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.md index 8b509e25600..b64a93334c5 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.md index 4a79a162fb0..7913d8bd51d 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.md index 687005ceb41..dbdd15a8628 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.md index 5da46952682..182c55cf86c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.md index 3b39821aac7..e4d64ad16ec 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.md index ad6fe3eb84b..cc81996e423 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.md index c4531303703..02849c57243 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.md index 94cb983d1b4..677ba0f308e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.md index d5f321dec00..0cbd5295c5e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.md index 9b17b1dc31b..877c76b084c 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.md index 07793af4d71..9e746d8b01e 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.md index 56a8848756a..b1b541ad372 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.md index 2fba745a677..898608f459d 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.md index acc9d600d8b..feac7913907 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -171,7 +171,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -181,7 +181,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -193,7 +193,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -215,7 +215,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -235,7 +235,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -259,7 +259,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -275,7 +275,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -296,7 +296,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.md index e6242d82c93..05c65c8cb34 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index ea3b47480f4..fd5fdfe8238 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.md index 79ab43aca6a..681dfc220b6 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.convert_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -82,7 +82,7 @@ This method operates the first part of the tapering. It converts the operator by -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -90,7 +90,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -106,7 +106,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -114,7 +114,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -142,7 +142,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.opflow.primitive_ops.Z2Symmetries#convert_clifford "qiskit.opflow.primitive_ops.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.md index f6e7b6b6a1f..6a98f193a87 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.md index 9fe56d875da..0fea13fbb04 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.md index ab057301c9c..58ced54e684 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.md index 5e0360a3695..56206e8f0dd 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.md index 2bc8caa6e8f..dd04224d534 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.md index 0d833362557..dcc5a3be7bc 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.md index b8145bb33cb..b0c32cac5aa 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.md index f1fc4ccf1cf..fb30556287f 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -96,7 +96,7 @@ Set options values for the estimator. -`BackendEstimator.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_estimator.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.md index 2c6e15f8d1d..122f2f08b43 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -79,7 +79,7 @@ Set options values for the estimator. -`BackendSampler.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/backend_sampler.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.md index 5af94a21727..334243da593 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_estimator.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_estimator.py "view source code") Close the session and free resources @@ -45,7 +45,7 @@ Close the session and free resources -`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_estimator.py "view source code") Run the job of the estimation of expectation value(s). diff --git a/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.md index d022d7a737e..35ab696d009 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_sampler.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -34,7 +34,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_sampler.py "view source code") Close the session and free resources @@ -42,7 +42,7 @@ Close the session and free resources -`BaseSampler.run(circuits, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.run(circuits, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/base_sampler.py "view source code") Run the job of the sampling of bitstrings. diff --git a/docs/api/qiskit/0.39/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.39/qiskit.primitives.Estimator.md index 7c47860a99a..d3fd54daced 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -38,7 +38,7 @@ Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "q -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.md index a78309bf731..c9ac4f5c181 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/estimator_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.39/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.39/qiskit.primitives.Sampler.md index b6541d4d898..39714fdf429 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -39,7 +39,7 @@ Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.md index c08425c9f17..8f84772e74c 100644 --- a/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.39/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/primitives/base/sampler_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.39/qiskit.providers.Backend.md b/docs/api/qiskit/0.39/qiskit.providers.Backend.md index 459b2c2f2ac..89a0698cc7a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.39/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.md index fe069bda1d8..4e079736d5e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.39/qiskit.providers.BackendV1.md index b2f9c4d6ffe..3ba4fdca6b0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.39/qiskit.providers.BackendV2.md index e805cbfb61e..6c73cca0fba 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -45,7 +45,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -67,7 +67,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -95,7 +95,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -117,7 +117,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -139,7 +139,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -165,7 +165,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Run on the backend. @@ -188,7 +188,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.md index 556b3848e82..88bba2e2e8a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.39/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`BackendV2Converter(backend, name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter(backend, name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -32,7 +32,7 @@ Initialize a BackendV2 converter instance based on a BackendV1 instance. -`BackendV2Converter.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Return the acquisition channel for the given qubit. @@ -54,7 +54,7 @@ The Qubit measurement acquisition line. -`BackendV2Converter.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Return the secondary drive channel for the given qubit @@ -82,7 +82,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2Converter.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Return the drive channel for the given qubit. @@ -104,7 +104,7 @@ The Qubit drive channel -`BackendV2Converter.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Return the measure stimulus channel for the given qubit. @@ -152,7 +152,7 @@ qubit\_properties -`BackendV2Converter.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.Job.md b/docs/api/qiskit/0.39/qiskit.providers.Job.md index 033d6ed886f..e3a35a45309 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.39/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobError.md b/docs/api/qiskit/0.39/qiskit.providers.JobError.md index 506f3bf4dd1..921789a6fe1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.39/qiskit.providers.JobStatus.md index 8ac33e45625..d2259ffbbfd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.39/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.md index 51ca936711e..9c37c0f387c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.39/qiskit.providers.JobV1.md b/docs/api/qiskit/0.39/qiskit.providers.JobV1.md index 292726bc5ed..519f36ce7dd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.39/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.39/qiskit.providers.Options.md b/docs/api/qiskit/0.39/qiskit.providers.Options.md index a170c981c25..707d9811d7c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.39/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.39/qiskit.providers.Provider.md b/docs/api/qiskit/0.39/qiskit.providers.Provider.md index cc533c417f1..2e4fe16e982 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.39/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.md index bf2a06d4df4..fe371a6d04f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.md index 35b9666a1bf..684fabf11c8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.md index 96af272c625..2871816f455 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.39/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.md index 955a8fad392..41231751d62 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.md index abb9524de74..0c3f833ed01 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.md index e68bc0da9de..bd7bbee6e32 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.md index f44640d9a40..68c6fe74b74 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 2220eee6018..c62b4e66e81 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.md index e022a5fa35d..1c2e98dd208 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.39/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.39/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.39/qiskit.providers.convert_to_target.md index 5028f1a1953..1de07942fc1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.39/qiskit.providers.convert_to_target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.convert_to_target -`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") +`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 82d0f60a199..0535303324b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.md index bd226401f39..bb7908477ea 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.md index ffdef1b5b51..c6e3f3f4dce 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.md index 3620afbe897..b70a12355b8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.md index 6cfc81a3435..b07c29e6982 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.md index e822d28fbe9..5a91420c70a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.md index f1dc3972d30..28f0fb8b94a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.md index 921821a9ce9..58c035d1b03 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.md index bd285412072..6b8b39a0c4d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.md index e6b191a1068..d6aa228e386 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.md index 8460a7c2c6b..a696a2667b9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.md index d6948318e87..ee22ecec129 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.md index 5da8d47598d..bd37d6f672a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.md index 14d51447469..12d4b4af01a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 6a95d558bba..160492c0163 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.md index b1688b70a0f..e1483371c81 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.md index 090d761801f..af8a029292e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.md index 26c2f1cb6e8..0f0cd18ac69 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.md index 418a5e1abd2..fc0c471e8b0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.md index 38030aff25e..91f788b4cbe 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.md index 8d32ca15333..2fbac48865a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.md index 7a0765b00fa..6f77173fb4f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.md index 1cc6681cdd2..c326208a149 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.md index 71838987746..424b769e2ff 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.md index 9bade416d8a..124551263e2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.md index 561b84ea708..bca3f33c925 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.md index ed81b9f42a9..392b904d5fb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.md index 7c60f9be002..fe971dc0f9e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.md index 138a5f612ce..8604bc49f24 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.md index e202ef0d38a..5a4c1d93ad5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.md index 6dd83843e05..bc6ada655ae 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.md index c88bd2fd4de..f1bded3b785 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.md index 32d7c2ffec1..bcab54eaa5e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.md index e2f0bcc6b5f..0c812a73b50 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.md index 9f2413f8166..b1d496775f3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.md index f7f096cc86f..e9ddf4751e6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.md index 5cf707aa316..78df08090ab 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.md index 5c7181b42bb..0442ef588c8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.md index 4280240a907..089514b1180 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.md index e6ed4a99957..d84345d9f19 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.md index 7aa0b33d20e..24b3c5464f9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.md index 4371d6f167c..5fb7afd9920 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.md index 1eed77f780b..f490e325eae 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.md index 4d9d5df3258..77e5fb3f029 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.md index b34526c23a5..7aa0b37a7cd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.md index 395b747503a..78d001b03a6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.md index b50a55a49f6..71ed8c718c0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.md index 1a8acfe41aa..54b003eec88 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.md index 17bc851d10d..964a8665f31 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.md index 05ea550d854..f929b9b5df0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.md index cf10172ab8f..76b9ac39fee 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.md index b4432fb7337..60759f3dc1b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.md index af9e9ab7d70..26874413773 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.md index 92bbd4e60af..cf9b5fecc25 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.md index 479574b171f..ff26ab56ad6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index de46e9b4669..4654a7438a1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.md index cb081194429..26ffab0ede3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.md index eca2620ed52..4ee9b8cae7d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.md index 268da607caf..7cdacaeb141 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index a6a0dc6cea0..487a9e5f951 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index 7bac06d23b4..520808b0243 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.md index e0ff39a2870..d9501647b69 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.md index 20e41a2c597..55f9ff69da0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.md index 567697245a0..8bca94dcfe5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.md index 104c7de145a..2995a8968ae 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.md index 94384efb92c..b44de70f41f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.md index 1ea8f7f8fb1..207617fde74 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.md index 6cb3fc0bc91..968e159a5f2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 9c206bf039c..82f348706a8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.md index 1175e616a41..d713d1dbfcc 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index 665b2c041bc..ec00055d2fd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.md index 57b49bce727..56b50bbb357 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.md index 253dbf0784a..bd4c6ea6a63 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.md index df739b4f302..c8e3974e83c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.md index 7a083f028d8..addbe9b0c7b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.md index 8149185a802..407fa4c3b03 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.md index e14890bd8a5..5705d4e317d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.md index 821e484380f..6817d841497 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.md index d0b86c2cd03..d16c35d8377 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.md index 0779c002834..fd4d8ce9fec 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.md index f534125c5f7..b1e1533d691 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.md index 76ca3f67d52..8da7e40be98 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.md index c0ba6edf72a..8123b58868e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.md index fc72a0f18d7..6ef49410c29 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.md index 38c0f5a6b60..1b5eea83833 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.md index f658e7b4062..8ba5c836504 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.md index 30f2fd4b4a2..1e8f049469a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.md index 2479ffa1a63..77a7fbaca61 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.md index 90e4afb7283..a9cc664661c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.md index 3944a4680fb..1c665608168 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.md index aa99db2ab22..05651c89c9d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.md index 44cb70d087d..ead12907795 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.md index 20929237413..8e1b9344040 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.md index 5448708352e..5ed1073f8d4 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.md index e20b2dc82d9..ca03f10fb23 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.md index f2e40ae5abf..3aa8e06a3f1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.md index fcb80f91d77..c1189ca83ce 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.39/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.md index ac2bb7e4984..d83cba70594 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.md index 9e2f72144f4..5696933d4a8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index d3d7859b636..d986df37b1e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 5645c4c24bd..7040b5ff883 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 2b79453f6ba..f4ce04dc5bb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index ea748b6719a..09a93e6b81f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.md index 3fab47b9099..82186cac087 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 4ffadf8c93c..4a17d4d7b0a 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.md index 66605916fec..3334bb4a3c2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -477,7 +477,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.md index 8f76680a706..1b44a08e8a0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index d2954ec6fb0..fd69b6ed1dc 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.md index f68ab861049..68cc2afa143 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.md index 3cdb81cf57a..b8da8734015 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -140,7 +140,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -209,7 +209,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -225,7 +225,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.md index a38a76dfdee..b3a3cd933dc 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.md index 362fb52745c..0b711755a2f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.md index 0f765703d8d..9a6fb649ae6 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.md index b52b29d66b0..de434cd2de8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.md index 4b446849cc4..814bfa0dfc9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.md index fde38e8edaf..0d0b5413ec2 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.md index 211e69d3a91..3703893d197 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 856cff72d1e..6235546f8ec 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 869e3725218..b3a235e13fc 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.md index bebdde0ac5f..9091dcf1e63 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 7f6e3e60997..35d375720a5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c753b9b03fd..0a5ff1c030d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.md index 0e16c129460..4119853fe38 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.md index c0ec62197bf..3abd0382d49 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.md index 0e98ceffabb..3890486708b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.md index 4a087d3fd82..543fb587672 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.md index c7d560a66e7..d3bfa9ccd14 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.md index 0626db0120a..3fd71c70852 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 8ea40cf804d..74ebff3e9fa 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 57a7fc6c085..5d38a428320 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 0481fda1214..2fd9874cefb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.md index 45b63ccd381..ab9a3314315 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.job_monitor.md index 4b7ee67e901..e407a59be71 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.least_busy.md index 29174c48477..9b045aec80e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.md index 9a198d26d89..ddbd2a9b158 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index a6b662fe102..64cce88e50c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 4006a3d0d4e..11e52eaec09 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 4e299221dae..57f826b9283 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index b19ab743224..02872ed993e 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index be41ee3b213..4e0a432bb6d 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 8f1556fcdd5..36bcff386f5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.md index 08ad74c3867..e9c1ab44d0b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.md index ff5b8bf3438..4665b7e9bf3 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.md index 873c7251ec2..8a4f3f1a245 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 916b4476630..99613bad810 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 045bf20ddc8..892a734ebd4 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.md index 7feeaf688d5..be445fbb65c 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9188f764070..dd32329888f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a0885b06940..d5400ad6165 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index b9a1da51d6b..69290448ca5 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.md index 869f5fc84c1..418963c5efc 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 942dc83ad8f..03707eaa300 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 91ca5ee1f15..1220a71e9cd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.md index f95d6bd4118..0dea489a2d1 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.seconds_to_duration.md index 1f138559be6..f005d414fbe 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.to_python_identifier.md index ad186c83b90..fe8ecb9ffe9 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.update_qobj_config.md index 3e2e6e9a4cc..a51e8c95919 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.utc_to_local.md index 161e29c2551..8cfe310b9f8 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.validate_job_tags.md index 6ef795cb48d..4c562c2a072 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.39/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.md index f74880c8220..5e49666dd42 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.md index 73cad19f28c..88409107f0b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.md index 04bb2860d24..a0ea3279ceb 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.Command.md b/docs/api/qiskit/0.39/qiskit.providers.models.Command.md index 8fee73fd018..fa567f7001f 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.md index 25e0412d18b..11005933480 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.md index 8a4bd5e2b87..6a1f6d4f214 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.md index edcec6a6ab9..8f81e03c95b 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.md index aba3828296b..5aa988a69dd 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.md index b952e0a6c02..a1995142bb0 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.md index 3f16f6567e4..d8fa2c45895 100644 --- a/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.39/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.md index fec9e2b94c7..2304c9cbb6d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -105,7 +105,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -126,7 +126,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -159,7 +159,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -182,7 +182,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -204,7 +204,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -228,7 +228,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.39/qiskit.pulse.Schedule.md index 19fea3a5724..c2f6ff04c70 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.md index d0696e4bb15..c1f7cba3bf1 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -178,7 +178,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -204,7 +204,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -229,7 +229,7 @@ Schedule with updated parameters. -`ScheduleBlock.assign_references(subroutine_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_references(subroutine_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Assign schedules to references. @@ -289,7 +289,7 @@ Schedule block with assigned subroutine. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -351,7 +351,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -384,7 +384,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -415,7 +415,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -455,7 +455,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -480,7 +480,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -492,7 +492,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_referenced()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_referenced()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return True iff the current schedule block contains reference to subroutine. @@ -504,7 +504,7 @@ Return True iff the current schedule block contains reference to subroutine. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -516,7 +516,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -538,7 +538,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.scoped_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.scoped_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Return unassigned parameters with scoped names. @@ -554,7 +554,7 @@ Return unassigned parameters with scoped names. -`ScheduleBlock.search_parameters(parameter_regex)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.search_parameters(parameter_regex)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/schedule.py "view source code") Search parameter with regular expression. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire.md index 4202d91b790..6fdb2575898 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire_channel.md index 3edb71f577b..30a0add57e6 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.active_backend.md index 3892f7e1255..014e7db2d1d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.active_circuit_scheduler_settings.md index d886d71299a..2941ebd887b 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.active_transpiler_settings.md index 7d1f533aeee..84241a71354 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_equispaced.md index 6eea6c5849a..c9eb60bd28e 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_func.md index 8cc97ad1141..35957de8bb4 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_left.md index 492b25acd5c..bc1a31828b8 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_right.md index 6a2cbd47652..d39dfd0f72f 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_sequential.md index b476c89fd73..6d475cf382d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.barrier.md index 29e86065c75..41bb54d2248 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.build.md index 77b532bf217..26732ccd3bf 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.call.md index 400d1e86ef4..e3fa17f26b1 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.circuit_scheduler_settings.md index 74b4be42bd4..f3a8afedb11 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.control_channels.md index 0bc9c1b2223..203fe98ed37 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.cx.md index 61ca40f877f..c0912058e32 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.delay.md index b62c4eb05f0..960ef24c08e 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.delay_qubits.md index c00283c34da..718923c14a9 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.drive_channel.md index 5b05329547e..389f0f431f1 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.frequency_offset.md index c5d1f656c32..b211e582901 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.measure.md index ae8042c2af3..2c37afa74f0 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_all.md index 172ad543036..fc676a6fa20 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_channel.md index 7a22ee5f66d..2fcd159e1d4 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.num_qubits.md index a1942499c33..58dd21f07be 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.phase_offset.md index 909870bb658..8e891c4dcbb 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.play.md index 65e327f7dfa..586c49de127 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.qubit_channels.md index aae6dd7112c..eb7b138e507 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.reference.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.reference.md index 510117d5dfd..536e322c67a 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.reference.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.reference -`reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.samples_to_seconds.md index b1cecd62629..4e3aeb494a7 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.seconds_to_samples.md index 26370d4ea4e..3c90ac09af9 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.set_frequency.md index 1714f31cf2b..bb4b70419e4 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.set_phase.md index 2a9af9f89c6..cf4336b42c6 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_frequency.md index 1ae6551c227..f7f6e52ba5d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_phase.md index 10cac21ebd6..fdababc1fdb 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.snapshot.md index 534011cddf6..ccb04fc52ad 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.transpiler_settings.md index f4cb2bf729e..143b24f6e40 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.u1.md index 3aea3c335a0..abdc5a12ec7 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.u2.md index 31bf942f262..1f10cb51cf9 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.u3.md index 6acc1f29f21..33f2e3723f4 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.39/qiskit.pulse.builder.x.md index c6913285854..bcd21fd04be 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.md index 014bb2582c8..c1ccf7601d8 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.md index 5e42d4658d2..cb6de083037 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.md index 3fc1d36b343..d67b73c91bf 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.md index 3bfcd4b8e78..f6b163da408 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.md index 8d4482de056..83ba0979691 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.ClassicalIOChannel`](pulse#qiskit.pulse.channels.ClassicalIOChannel "qiskit.pulse.channels.ClassicalIOChannel") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.md index 70a61e83838..2668ad7b6f3 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.ClassicalIOChannel`](pulse#qiskit.pulse.channels.ClassicalIOChannel "qiskit.pulse.channels.ClassicalIOChannel") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.md index 3c01e852ea6..f9795d81554 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.ClassicalIOChannel`](pulse#qiskit.pulse.channels.ClassicalIOChannel "qiskit.pulse.channels.ClassicalIOChannel") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.md index a369cd533c4..695cd54d132 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.md index 2eb20f54323..32b0c4d31a5 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.md index 7247b3b5748..6363772eebd 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.md index defd89a97e2..e3a91af5e75 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.md index c56a69e0a40..5b004a3142a 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/reference.py "view source code") +`Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/reference.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.md index 9519e6893c5..b6e7760b2ad 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.md index fdeffe88e52..ce69413d0a5 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.md index 90683a3b8a3..c138d5e183e 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.md index bbcc4d84743..279a197bd79 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.md index 3a204c47ab0..62b5924a550 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.md index be4131ad5ba..273e147760f 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.md index fdd1d2c1a9e..20a234e0696 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.md index c5397a33d29..cd365b4ef6b 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.md index d96c6aa1c58..f4c0fff2a12 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.md index 1fd1bafff5c..e5856fcbbb6 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.md index d626100816d..d5de4a44450 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -158,7 +158,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -185,7 +185,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -197,7 +197,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.md index aa548dfa372..e185de4533d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.39/qiskit.pulse.library.cos.md index e54aca09ad1..a7793381874 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.cos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_deriv.md index ef752d9fa7a..47d00235664 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_square.md index d32ff028f8b..ee950a5107e 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.gaussian_square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.39/qiskit.pulse.library.sawtooth.md index 26a22ab8f04..dbedd9edc11 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.sawtooth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.39/qiskit.pulse.library.sech.md index e52d65dd1a6..1f000924817 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.sech.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.39/qiskit.pulse.library.sech_deriv.md index 3dafebab218..16e0869deee 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.sech_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.39/qiskit.pulse.library.sin.md index 480aba72e17..7138c3dc72a 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.sin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.square.md b/docs/api/qiskit/0.39/qiskit.pulse.library.square.md index 2a9a7a00f28..ab5bbc38728 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.39/qiskit.pulse.library.triangle.md index 6bff17916cb..af5bc547fca 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.triangle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.39/qiskit.pulse.library.zero.md index f4d768bfb33..1dc62b37b92 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.library.zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.md index cb389a0bcae..ed744972219 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.md index 3cd26cb5b2c..ecbd26fbf09 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.md index 8ed8a666211..385a9bb191d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.md index 7a281f7484e..547ab4b0af2 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.md index 30adb49eed4..9eedc742ff9 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.add_implicit_acquires.md index 2e09012817d..d90a7190684 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.align_measures.md index 4e68193be65..32b3bbd545c 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_dag.md index c15c066c655..cee73cfec01 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_schedule.md index 164941fdf4c..8535a7fef8f 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.compress_pulses.md index 612f3090efb..dfd0e0365f5 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.flatten.md index 914e58f4b7f..c289be93a2d 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.inline_subroutines.md index a4ec7dc1469..d09a7276f08 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.pad.md index a19f3350c08..f4a89a5503c 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_directives.md index 405e4387774..cff9bdae964 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_trivial_barriers.md index 37c8b465bff..78d094ec507 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.39/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.39/qiskit.pulse.transforms.target_qobj_transform.md index 3be18fc88d5..2b632de306a 100644 --- a/docs/api/qiskit/0.39/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.39/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.md index 4ce1124fc69..46bb10c1eb2 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.39/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.39/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.39/qiskit.qasm.Qasm.md index 80ab744c147..ca057c5ca0c 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.39/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.39/qiskit.qasm.QasmError.md index aa2bf2c47ee..02ba34b1e0e 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.39/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.md index a84195ec058..a03b8119294 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.39/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.md index d4209dedbf4..0f1efb19736 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.39/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.md b/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.md index bc2cf4735e5..1cd31778fb0 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.md +++ b/docs/api/qiskit/0.39/qiskit.qasm3.Exporter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.Exporter -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/exporter.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ QASM3 exporter main class. -`Exporter.dump(circuit, stream)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/exporter.py "view source code") +`Exporter.dump(circuit, stream)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, dumping the result to a file or text stream. @@ -38,7 +38,7 @@ Convert the circuit to QASM 3, dumping the result to a file or text stream. -`Exporter.dumps(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/exporter.py "view source code") +`Exporter.dumps(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/exporter.py "view source code") Convert the circuit to QASM 3, returning the result as a string. diff --git a/docs/api/qiskit/0.39/qiskit.qasm3.dump.md b/docs/api/qiskit/0.39/qiskit.qasm3.dump.md index a1952689d50..86ca43efe96 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm3.dump.md +++ b/docs/api/qiskit/0.39/qiskit.qasm3.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dump -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. diff --git a/docs/api/qiskit/0.39/qiskit.qasm3.dumps.md b/docs/api/qiskit/0.39/qiskit.qasm3.dumps.md index b2c1fa35778..c8a967b94ec 100644 --- a/docs/api/qiskit/0.39/qiskit.qasm3.dumps.md +++ b/docs/api/qiskit/0.39/qiskit.qasm3.dumps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm3.dumps -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.md index 44dfcfc4da7..c5b1c1fc3fe 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.md index 9299bac37df..369de69aa61 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.md index cdf052749ac..847445e4c71 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.md index dac51fca6a7..71b1a171b42 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.md index 9f7d25c0b54..0926bf2d396 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.md index 6f438d011f6..ff21af58d10 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.md index 1ef984e0409..c866891ac2e 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.md index 21378b2e171..bd38e2740c6 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.md index 28fdfe2ae95..e9436158343 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.md index c83098c430a..d023cff5d12 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.md index 37318f3ecd0..a42f02f75d7 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.md index 2f73b62e358..04607f0b4b4 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.md index 164024b29ff..3aabab41026 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.39/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.39/qiskit.qobj.Qobj.md index bff1c2d8d82..2a438a2af9d 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.md index 175afbee7fd..5dd51d42660 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.md index 0c55bc710d0..d5b5f4d1d55 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.md index 3fe4c7d2d88..2bd22b75eef 100644 --- a/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.39/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.39/qiskit.qpy.dump.md b/docs/api/qiskit/0.39/qiskit.qpy.dump.md index 2a6b272fcee..e3315d02595 100644 --- a/docs/api/qiskit/0.39/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.39/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.39/qiskit.qpy.load.md b/docs/api/qiskit/0.39/qiskit.qpy.load.md index e6e07beeb2d..9f92cf6473f 100644 --- a/docs/api/qiskit/0.39/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.39/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.md index 4944d0b703e..83c127aa037 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.md index d7e4a5e3f81..bf41d53ea61 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.md index cf84568cf10..8d9301d941a 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.md index 0ce0ee6f149..fad3d9a3731 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin`, [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`classmethod Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_labels(array=False, mode='B')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_labels(array=False, mode='B')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert a Clifford to a list Pauli (de)stabilizer string labels. @@ -437,7 +437,7 @@ list or array -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -445,7 +445,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -453,7 +453,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.md index 2ccaeda5553..166a240facd 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -595,7 +595,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -603,7 +603,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -630,7 +630,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.md index 103614cdb2a..eb3e6c82ed3 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.md index bed0fb1370e..462a919e61f 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -71,7 +71,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.md index 81c55698927..62286dab0d9 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -201,7 +201,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -237,7 +237,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -253,7 +253,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -303,7 +303,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -321,7 +321,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -347,7 +347,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -355,7 +355,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -363,7 +363,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.md index 7dfcfd52ed6..561669036a0 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.md index 0e6f93dd608..dc4d021caf5 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.md index ab2b9f217de..4644c46a750 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.md index bed717bf8fd..e6303303df6 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -573,7 +573,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -613,7 +613,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -642,7 +642,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -672,7 +672,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -680,7 +680,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.md index 908829de28c..f0976e90e8c 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.md index 7abd5f320e2..f5e2b9e26e9 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.md index fb71d9107b1..f206d3265bd 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -74,7 +74,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -82,7 +82,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return indices for sorting the rows of the table. @@ -152,7 +152,7 @@ array -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -176,7 +176,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -208,7 +208,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -249,7 +249,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -270,7 +270,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -292,7 +292,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -330,7 +330,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -358,7 +358,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -405,7 +405,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -448,7 +448,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -469,7 +469,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -487,7 +487,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -567,7 +567,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -588,7 +588,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sort the rows of the table. @@ -661,7 +661,7 @@ a sorted copy of the original table. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -689,7 +689,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -715,7 +715,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -737,7 +737,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -757,7 +757,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -765,7 +765,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.md index 54b9517d614..f702a57752e 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.md index e965201bb06..8f52565c78a 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -620,7 +620,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -660,7 +660,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -693,7 +693,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -735,7 +735,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.md index 06fefecbce5..1a17ff5a498 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ $$ -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.md index 29187806e5a..ef2da262b05 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.md index 60606b240ed..81560742bbb 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 6bb781d775c..6ccbe8ecae6 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.md index 433bd2f3bcc..9da0f14031c 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.39/qiskit.quantum_info.average_gate_fidelity.md index dff09271df8..6c9106bfb6a 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.39/qiskit.quantum_info.concurrence.md index 208e3934dca..9178ce36b45 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.39/qiskit.quantum_info.decompose_clifford.md index 28fde943909..63b5985e021 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.39/qiskit.quantum_info.diamond_norm.md index 52263c50dfe..e177a720cab 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.39/qiskit.quantum_info.entanglement_of_formation.md index c0b7249eb70..a60dd162239 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.39/qiskit.quantum_info.entropy.md index a6b1257cb45..f24ed3cf6c2 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.39/qiskit.quantum_info.gate_error.md index 63d19e7eb9e..f373f5aa92f 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_distance.md index f339d8c48e9..8c0984b16f8 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_fidelity.md index 797e3db0174..99a53348192 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.39/qiskit.quantum_info.mutual_information.md index 825686d1148..11157a57890 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.39/qiskit.quantum_info.partial_trace.md index 7bd83d1e61e..b023de306f1 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.39/qiskit.quantum_info.pauli_basis.md index 6b815ad38b2..bd4dda2083c 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.39/qiskit.quantum_info.process_fidelity.md index b22e67a64d9..322a737f674 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.39/qiskit.quantum_info.purity.md index 03a39483106..c98882fe6a4 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_clifford.md index 35f8d4b8ccc..c524e10ee3f 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_cnotdihedral.md index 4530d92ae37..0cb374c768a 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_density_matrix.md index ec088b74c1f..2cd2c1657b0 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_hermitian.md index 851a9d0be4a..024de699dc0 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli.md index ad237740408..c12ba58aced 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_list.md index 0a71f4d00dd..ef9e4f826ae 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_table.md index d1d7fe820ea..13d5d056215 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_quantum_channel.md index 75b470cdfd2..42361814792 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_stabilizer_table.md index e77e13ddc1f..0c60c480880 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_statevector.md index 25b9cf4927a..9377b7a4d7a 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.39/qiskit.quantum_info.random_unitary.md index 9006b415f5a..1a03367323d 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.39/qiskit.quantum_info.shannon_entropy.md index 38a042969e6..42d32d2a20b 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.39/qiskit.quantum_info.state_fidelity.md index 7362c5e2d5f..00f84c2ef37 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.md index 00c6d95790b..ec95e0c09f5 100644 --- a/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.39/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.md index 52f1a78b332..9a044c3637a 100644 --- a/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.39/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.39/qiskit.result.Counts.md b/docs/api/qiskit/0.39/qiskit.result.Counts.md index 4ddee0c352f..0198dc8c6c0 100644 --- a/docs/api/qiskit/0.39/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.39/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.md index d465779ec86..50bb2e00f00 100644 --- a/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.39/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.md index 17a4a1aed54..0b9c5efb1c1 100644 --- a/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.39/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.md index e3bc0f9579a..b2e3b8d0837 100644 --- a/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.39/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.39/qiskit.result.Result.md b/docs/api/qiskit/0.39/qiskit.result.Result.md index 1f8a35f8d35..c5114fbee84 100644 --- a/docs/api/qiskit/0.39/qiskit.result.Result.md +++ b/docs/api/qiskit/0.39/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.39/qiskit.result.ResultError.md b/docs/api/qiskit/0.39/qiskit.result.ResultError.md index 0d2aac5b0fd..8a12705efc3 100644 --- a/docs/api/qiskit/0.39/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.39/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.39/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.39/qiskit.result.marginal_counts.md index d37186fa6e2..1216de88c14 100644 --- a/docs/api/qiskit/0.39/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.39/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.39/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.39/qiskit.result.marginal_distribution.md index 38970125f9c..ae171c5b373 100644 --- a/docs/api/qiskit/0.39/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.39/qiskit.result.marginal_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.39/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.39/qiskit.result.marginal_memory.md index 2259fcb2e11..fd6dd37bf95 100644 --- a/docs/api/qiskit/0.39/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.39/qiskit.result.marginal_memory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.39/qiskit.result.sampled_expectation_value.md b/docs/api/qiskit/0.39/qiskit.result.sampled_expectation_value.md index 19763faa107..8e358ce73a3 100644 --- a/docs/api/qiskit/0.39/qiskit.result.sampled_expectation_value.md +++ b/docs/api/qiskit/0.39/qiskit.result.sampled_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.sampled_expectation_value -`sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/sampled_expval.py "view source code") +`sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.md index 07bea39db63..7349ee48f51 100644 --- a/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.md index 96b5e815398..b6777a04542 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.39/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.md index 7ee8443160f..d85873cbbe3 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.39/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.md index f8cb89b9a64..b5267c78ef0 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.39/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.md index 0ba0eaf835b..35d55f73dc9 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.39/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.md index 49ae957768b..c848068c5b8 100644 --- a/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.39/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.39/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.39/qiskit.tools.backend_monitor.md index 448b97866ad..75dd1dbd2c2 100644 --- a/docs/api/qiskit/0.39/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.39/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.39/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.39/qiskit.tools.backend_overview.md index 4515ad10f75..42cb73e5464 100644 --- a/docs/api/qiskit/0.39/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.39/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.39/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.39/qiskit.tools.job_monitor.md index d1beac06c21..9eec5f69166 100644 --- a/docs/api/qiskit/0.39/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.39/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.39/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.39/qiskit.tools.parallel_map.md index 899c50ff14b..0d15dd87144 100644 --- a/docs/api/qiskit/0.39/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.39/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.md index ea4a48e6a9c..3b76983693e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.md index ea68321593f..889319f39d8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.md index 092ebb2a756..8dda9b8ed27 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -108,7 +108,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -120,7 +120,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -132,7 +132,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -157,7 +157,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -182,7 +182,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -204,7 +204,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -216,7 +216,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -228,7 +228,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -244,7 +244,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -254,7 +254,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -262,7 +262,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -270,7 +270,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -280,7 +280,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -304,7 +304,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -329,7 +329,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -337,7 +337,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.md index 66b0b9ff2b8..3a1a5619be4 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.md index e398036f88b..e0e4a15f289 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.md index 36a7e51d066..0b38ad08cb5 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.md index dbe03cd11ad..1d5fd256bbe 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.md index e3c8521c454..114be16605a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.md index 11c1e72b495..71e12ad1f97 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.39/qiskit.transpiler.Layout.md index 8e350ec81e1..b06a73edea1 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit. @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.md index d1e86c214ba..668d54c4791 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. @@ -194,7 +194,7 @@ The transformed circuit(s). -`PassManager.to_flow_controller()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`PassManager.to_flow_controller()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Linearize this manager into a single [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController"), so that it can be nested inside another [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.md index 1292ab2182e..16ac03c2b84 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.md index 633cd3ef137..348a51cdda3 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.md index 635044ff7b9..1187da7ba49 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.Target.md b/docs/api/qiskit/0.39/qiskit.transpiler.Target.md index 8de45787afb..024594ffda5 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -136,7 +136,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -165,7 +165,7 @@ for this target. If there are no connectivity constraints in the target this wil -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -189,7 +189,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -211,7 +211,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -251,7 +251,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -267,7 +267,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -308,19 +308,19 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -340,7 +340,7 @@ The Instruction instance corresponding to the name. This also can also be the cl -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -364,7 +364,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -388,7 +388,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -408,7 +408,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -424,7 +424,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -463,7 +463,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -481,7 +481,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.md index 910a79bff81..df34cbd9de6 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.md index 5f80149292f..17d7f338c31 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.md index fdbdc50eec8..b01a56fceef 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.md index 79bade81929..f0ee25efffd 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 4572507caf5..3c76bff4c78 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.md index efcd9bc3518..782515e6fe0 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 65eda0476f4..2714052b96c 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.md index 34ab106700a..4a46098a231 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.md index d5900fd713e..e8c858e79f4 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.md index 40bdc2d7844..f33324f9951 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index eac14c9848c..9eadd935b25 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.md index d15a236b1da..a44f3ed0e60 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.md index 02125970e09..297fb5cc138 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.md index 37b071786c7..8ebcf63ede9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.md index 35417b6c41a..0531264e866 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.md index 632290a28b3..46fa4d5bc70 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.md index bbf9531d868..6faef2e09e1 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.md index 3e44ce27b3d..f3833107482 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.md index 164ffb1c7fe..8627738ffcc 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.md index 10228c5d28b..55496daff73 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.md index 358377826c7..612c1d62bd5 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.md index 7345aeb648f..e4445fb1e1b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CollectLinearFunctions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Run the CollectLinearFunctions pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.md index c722c26416d..047c388b71b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.md index aa019aecd33..9a7fea51d10 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.md index 61717d0ffef..a255e51766d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 02431c8fc54..770b50801f0 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CommutativeInverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Run the CommutativeInverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.md index c87a06bf5ef..ca180c54fdf 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -92,7 +92,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -118,7 +118,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.md index 08d61eed27b..cb86dfc5c2f 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.md index 138d18f745a..accae797050 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.md index 844fced87f1..3c03462829d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(instruction_name, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(instruction_name, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index c7d1b327500..9430284e019 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ConvertConditionsToIfOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.md index 296ded67b9d..dd5fccac7c8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.md index 029627da4d5..6d482124a92 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index fc498bac4a7..34ccb833022 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.md index 76cb470e920..2382aca315d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.md index 6a4c7bdeb8d..80998a9a18b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.md index 8695ac6e54a..85c9921e849 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gate=None, gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gate=None, gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.md index 8766efcd9ec..58f8d43cfda 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.md index 78558943e3d..afa662a6b9c 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.md index 10a2b74a409..a5bc7e7f6cf 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -99,7 +99,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 00d0baee8de..13f8d69d619 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.md index 3878b369570..08687ea0200 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.md index a6a8d3d8acd..6d935786292 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.md index 363ff818b90..8105e727d81 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.md index 7f69e1c5891..d2f0dd778f4 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.md index 76f55fc3fe3..77c5ee3abe7 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.md index 4a009f00529..74d146236e9 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HLSConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HLSConfig -`HLSConfig(use_default_on_unspecified=True, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HLSConfig(use_default_on_unspecified=True, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Creates a high-level-synthesis config. -`HLSConfig.set_methods(hls_name, hls_methods)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HLSConfig.set_methods(hls_name, hls_methods)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Sets the list of synthesis methods for a given higher-level-object. This overwrites the lists of methods if also set previously. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.md index 7c5568293b1..812ca1c4a2e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`HighLevelSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run the HighLevelSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.md index 352fbb69d29..5eb1f1f784b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.md index 3f60bcb930d..51b2e0ee244 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.md index 5785512eee5..ec92c0ed60a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.md index 1b65115d8b0..b5613c5f00d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index 078c7cd3997..9d35dfc7e79 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 7c0a87c177e..f6ed3714211 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.md index 75c397d9e2f..6ff40b4b21d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 147fb09ed15..b6a50bc43e2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index c85ef4a70be..cfffdca4ba8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.md index 2ced5a9efef..f5381147baf 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.md index ae8e90511e7..a0ebe58ae26 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 9b2fce123ed..2d44d1d3504 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 27dca95f5e7..2b487cacfee 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.md index e2013ac139e..38b25337884 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`OptimizeCliffords.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Run the OptimizeCliffords pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.md index 3c0b3d342ee..71a3e76ed11 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 7b525e989ff..8258d1cd298 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.md index beac47265bc..fb6e5d1bbce 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 3ec6e491493..c222cd48919 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -69,7 +69,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") **Parameters** @@ -115,7 +115,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index f2beca0fbd8..be062db77ce 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.md index abe7376e003..0ead932a057 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 95796f3dfc0..a3f5d1c4baa 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 2f216ea5751..0b0ed817ee4 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.md index 77896f7c5d4..7b58fd27edc 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 41a3815a983..7e937f0d5e2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ResetAfterMeasureSimplification.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Run the pass on a dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.md index 622fe619ec3..7dc646048e5 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -52,7 +52,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.md index 73d23d3b023..877642e179c 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -90,7 +90,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.md index 20aaa7a3637..91f102d9aec 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.md index fae7f0cbf7b..44dde325ad2 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.md index db88fb704c5..67a55393b4f 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.md index 7c95321f7d6..7782d622957 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.md index 31c9692a05e..61f7c1d6c42 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.md index 4dd7cfcc775..8bede7dfabd 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.md index afa4a8dd68b..af2d3ed0415 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.md index c9272901ee4..3d828e23c00 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.md index b2a4da64858..18e99b57b23 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.md index e51b30b3201..09d1bc9dc7a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.md index 1efc51e25cc..9b882487682 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.md index ba712511059..9996e465ca3 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.md index 94a138aa1e0..b243b60e407 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -54,7 +54,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.md index 162892a1763..776ed75c5b1 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.md index 833e3e27763..f5828b73c38 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 42eb4bb3f48..716c346404b 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for high-level synthesis plugins. -`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given Operation. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index 8e3e56bb53a..244b4d2112f 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Class tracking the installed high-level-synthesis plugins. -`HighLevelSynthesisPluginManager.method(op_name, method_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method(op_name, method_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns the plugin for `op_name` and `method_name`. @@ -30,7 +30,7 @@ Returns the plugin for `op_name` and `method_name`. -`HighLevelSynthesisPluginManager.method_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns plugin methods for op\_name. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index a32887bfd25..bedd99c2873 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 810ea7d5b9a..2073bf94e80 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index ef1a8ef5fa3..718983fae30 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 59ec39a8766..6869d753f5a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index 356c9a4f3be..e2945504e6c 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index bf4fed558cf..8a296b3aae4 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index dc926227c12..bc8a067617d 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 2803d24083f..4d58c8698e7 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index c86727b18e6..e90f9ff5fd5 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ A `PassManagerStagePlugin` object can be added to an external package and integr -`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index bfdd20d8822..fade34de54e 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Manager class for preset pass manager stage plugins. -`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a stage diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md index d0031f2759b..9384c432e59 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins -`list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.md index 257e8a52a10..e7816eaa78a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index ee08b35df23..5f73dfc7e48 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index 267fd6e5fb5..c22cb49b6ec 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index c38cc8c75dc..276778d3a2a 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 8045609da1a..5d156317aad 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index e75467486f1..49edb7a3bc8 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 2bb9906939e..fbe8c2f8473 100644 --- a/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.39/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.md index 10be9a51746..429be1f3b80 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.39/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.39/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.39/qiskit.utils.apply_prefix.md index f04136e5ba2..073a1c44e35 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.39/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.39/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.39/qiskit.utils.deprecate_arguments.md index b3cfd39466a..a46fb1c5457 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.39/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.39/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.39/qiskit.utils.deprecate_function.md index 77b679013c1..affb3104e26 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.39/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.39/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.39/qiskit.utils.detach_prefix.md index 5c8d8064a29..991da283d80 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.39/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.39/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.39/qiskit.utils.get_entangler_map.md index 2b8c965cb05..a4377d6dcc7 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.39/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.39/qiskit.utils.has_aer.md b/docs/api/qiskit/0.39/qiskit.utils.has_aer.md index ef3917b1088..5a1b45915cf 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.39/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.39/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.39/qiskit.utils.has_ibmq.md index ce8cc59b25b..c3456f081c1 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.39/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.39/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.39/qiskit.utils.is_main_process.md index 1dd824f7ec2..9be7b4bf3ef 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.39/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.39/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.39/qiskit.utils.local_hardware_info.md index 0be54f4606a..505b28f6bf0 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.39/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.md index ecba76bab52..8b492c7115b 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.39/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.md index e566302e20d..b815ac6c500 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.39/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. @@ -81,7 +81,7 @@ The on-diagonal elements of the calibration matrices are the probabilities of me -`TensoredMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.39/qiskit.utils.name_args.md b/docs/api/qiskit/0.39/qiskit.utils.name_args.md index 8a5085fe801..b55187505a7 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.39/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.39/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.39/qiskit.utils.summarize_circuits.md index 8d96b46fde5..55db23b71fa 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.39/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.39/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.39/qiskit.utils.validate_entangler_map.md index 739c99b8637..02fe8517100 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.39/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.39/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.39/qiskit.utils.wrap_method.md index a1b380047b6..3759e783f08 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.39/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.md index 3e0129b065b..9a093845c77 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.39/qiskit.visualization.array_to_latex.md index 3785cae46c7..692d831c4d3 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.39/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.39/qiskit.visualization.circuit_drawer.md index 2ac9872502d..d0948b5dc23 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.39/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.39/qiskit.visualization.dag_drawer.md index fce98961ee4..6909624018e 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.39/qiskit.visualization.pass_manager_drawer.md index 0992e7a8c12..8ba1efaf05c 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_multivector.md index e2695844fe3..c2dba4974a6 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_vector.md index 2ecf6b571bf..5b468ff0dc2 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_circuit_layout.md index 50034f4cf64..74fd2c26e7f 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_coupling_map.md index cb8cf411fce..55e63e43819 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_distribution.md index c0e7417f5e7..4f90683fb5e 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_distribution -`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/counts_visualization.py "view source code") +`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_error_map.md index 6aa7067800e..469c29031b6 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_gate_map.md index 490d1b1d986..e1b252d2f60 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_histogram.md index 71497c49764..5173dad6b66 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_city.md index 16007f6989c..5e7aa696540 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_hinton.md index 3bae12c2ad8..cd97d6e9157 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_paulivec.md index 997f378f122..d4fb4306259 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_qsphere.md index 1245680b9b4..42b033964a8 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.md b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.md index 0272afde881..90bcb97316f 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.md b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.md index 18c39131ae9..1c87355ad5e 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.md b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.md index 4139ca36698..aedc1da84ea 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.draw.md index 1767b1ce0da..be6c7119cd8 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.pulse_v2.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse_v2.draw -`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/interface.py "view source code") +`draw(program, style=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/pulse_v2/interface.py "view source code") Generate visualization data for pulse programs. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.md index 8cfbb785153..8dfc121688d 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/circuit/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.39/qiskit.visualization.timeline.draw.md b/docs/api/qiskit/0.39/qiskit.visualization.timeline.draw.md index 6a8293a2068..75c46481e22 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.timeline.draw.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.timeline.draw -`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/timeline/interface.py "view source code") +`draw(program, style=None, time_range=None, disable_bits=None, show_clbits=None, show_idle=None, show_barriers=None, show_delays=None, show_labels=True, plotter='mpl', axis=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/timeline/interface.py "view source code") Generate visualization data for scheduled circuit programs. diff --git a/docs/api/qiskit/0.39/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.39/qiskit.visualization.visualize_transition.md index 520fb56d28d..63a00b32c34 100644 --- a/docs/api/qiskit/0.39/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.39/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.39/qiskit_aer.AerError.md b/docs/api/qiskit/0.39/qiskit_aer.AerError.md index 5f4c2607a79..91244a10699 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.AerError.md +++ b/docs/api/qiskit/0.39/qiskit_aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.39/qiskit_aer.AerProvider.md b/docs/api/qiskit/0.39/qiskit_aer.AerProvider.md index 4f6b0e4db92..77c9fa9340c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.AerProvider.md +++ b/docs/api/qiskit/0.39/qiskit_aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.md b/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.md index 47bc8a665dc..9cde92150bd 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.md +++ b/docs/api/qiskit/0.39/qiskit_aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -205,7 +205,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -213,7 +213,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -263,7 +263,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -271,7 +271,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -359,7 +359,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.md b/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.md index 7fcf1526bba..3d25707435b 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.md +++ b/docs/api/qiskit/0.39/qiskit_aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.md b/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.md index 41467bd0e1c..8f2f21730ab 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.md +++ b/docs/api/qiskit/0.39/qiskit_aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.md b/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.md index 32eeaabdfc3..d59c192ceaf 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.39/qiskit_aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.md b/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.md index 1f06420d096..c87ff1ea1f7 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.39/qiskit_aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.md b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.md index db313fa15b5..cdf53e9e60e 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.md b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.md index 36f087d4664..6249b146be1 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.39/qiskit_aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.md index a6a3c1ee847..3457e924414 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.md index dbe9b362161..b16ed6fca93 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.md index 61c035747e2..a553e3e4af3 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.md index a97970dec60..68c04471132 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.md index 4f170429cb8..fbbc9be197e 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.md index b65cc654c01..f601397e76f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.md index ff45c0c06ee..10cfc651eec 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.md index 750f4dfb595..8509eeeea01 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.md index 24aaefbd1fd..3863e28f4ab 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.md index 9e4d612450f..a74c3cc3d87 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.md index cb8857d14a2..3f8b64809d4 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.md index 323c863b155..bc75412a401 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.md index aa18c03bbdf..2526eefb249 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.md index d9ad2d95fc5..455d9f2e07c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.md b/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.md index da93367d185..1a2a5efa681 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.md index f3fc262661e..4f540720c71 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.md index 095d26f3275..538b8e1ce0c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.md b/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.md index 26b4d86aeea..a0fec10f158 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.md b/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.md index b79415d8eb7..565a4c97f7a 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.md b/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.md index a1818ec75a6..c373d432109 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.md b/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.md index 590a0694967..de590aa0a79 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes.md index 390115a92e8..ec1b668c7c4 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes_squared.md index c6e631fd67a..82d8c10578c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_clifford.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_clifford.md index a15ce90d970..3545ea80cb0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_clifford.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_density_matrix.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_density_matrix.md index c5bf046d92e..2afcf6cbd81 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value.md index 83f3756753a..4eb728318a6 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value_variance.md index e0c48040e8b..06e3e06dc46 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_matrix_product_state.md index fc4efa9230c..3ec3e9646c5 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities.md index 3f917fa6387..95c6cffa69a 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities_dict.md index d554184bcd8..d6cb284ec4e 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_stabilizer.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_stabilizer.md index 012a26267e4..e0cb79acf70 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_state.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_state.md index b58f26be497..6254b7409a8 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_state.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector.md index f6638818b12..d8bd261964f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector_dict.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector_dict.md index 9b4deb5fb70..010dcaf80d0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_superop.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_superop.md index 4bed5d00e43..ef47af6761f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_superop.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.save_unitary.md b/docs/api/qiskit/0.39/qiskit_aer.library.save_unitary.md index fd8a0373bab..ded625276b0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.save_unitary.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.set_density_matrix.md b/docs/api/qiskit/0.39/qiskit_aer.library.set_density_matrix.md index 2938daa4809..6fedfb63299 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.39/qiskit_aer.library.set_matrix_product_state.md index a8c1135644e..ba41900f2b0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.set_stabilizer.md b/docs/api/qiskit/0.39/qiskit_aer.library.set_stabilizer.md index 690a1072521..f291fd9fa05 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.set_statevector.md b/docs/api/qiskit/0.39/qiskit_aer.library.set_statevector.md index 41e1bce3a7c..91728cb7f66 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.set_statevector.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.set_superop.md b/docs/api/qiskit/0.39/qiskit_aer.library.set_superop.md index 48988d8ec8c..fcbccc6a02f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.set_superop.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.library.set_unitary.md b/docs/api/qiskit/0.39/qiskit_aer.library.set_unitary.md index e6f8fd9c84e..c3a15022d7e 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.library.set_unitary.md +++ b/docs/api/qiskit/0.39/qiskit_aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.md index c1b8d94266e..50ecacefd0b 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.md b/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.md index 5308b0b88e6..99e942aa604 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -263,7 +263,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -287,7 +287,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -295,7 +295,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Reset the noise model. @@ -303,7 +303,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.md b/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.md index c81f1308985..1db3c8d7e4b 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -129,7 +129,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -154,7 +154,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -176,7 +176,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -250,7 +250,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -258,7 +258,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -266,7 +266,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -292,7 +292,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -300,7 +300,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -308,7 +308,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.md b/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.md index 473f00da065..bf79429206c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.md index cf2c6e6cba9..b983d9d944c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.amplitude_damping_error.md index 060dec129a3..4feddbe5752 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.coherent_unitary_error.md index f90a1a068c5..5f375e4118e 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.depolarizing_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.depolarizing_error.md index 682b4c35050..1a855f9520d 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_gate_errors.md index 49fe31e638b..bc466816714 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return QuantumErrors derived from a devices BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_readout_errors.md index 036856d7afc..5ec67050a9a 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return readout error parameters from either of device Target or BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_error_values.md index 995c5adf824..4e229d33a5a 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_length_values.md index c7985d8a231..5adc8d2bc1d 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_param_values.md index 9a03c869835..4b68d14dcb0 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.readout_error_values.md index 9e7cd14a25f..54ed50271bf 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.39/qiskit_aer.noise.device.thermal_relaxation_values.md index 4315386aea1..9a514b55877 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.kraus_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.kraus_error.md index 1d5fb16a3df..2c1fd8347bb 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.mixed_unitary_error.md index 134d564711e..fade2783f7b 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.pauli_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.pauli_error.md index b4e9f01faec..75a2282158c 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.phase_amplitude_damping_error.md index 70ced555d78..930337b8f4f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.phase_damping_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.phase_damping_error.md index 2dadfc13527..c686b920614 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.reset_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.reset_error.md index 955de63ad01..68b38e7ce57 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.reset_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.39/qiskit_aer.noise.thermal_relaxation_error.md index 52d4dc7edcd..a131331ef50 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.md b/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.md index 4489cebea06..e2b2b5baea9 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.md +++ b/docs/api/qiskit/0.39/qiskit_aer.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -49,7 +49,7 @@ Aer implmentation of Estimator. -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.md b/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.md index 1a3544818de..6a6e3073af1 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.md +++ b/docs/api/qiskit/0.39/qiskit_aer.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -45,7 +45,7 @@ Aer implementation of Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.md index 1f9c2bb1d0c..3df65cca226 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.39/qiskit_aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.39/qiskit_aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.39/qiskit_aer.pulse.duffing_system_model.md index ea9d60c65fd..7bd6f1f4889 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.39/qiskit_aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.md b/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.md index d85fd4a11e8..ce366add298 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.md +++ b/docs/api/qiskit/0.39/qiskit_aer.quantum_info.AerStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector -`AerStatevector(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector(data, dims=None, **configs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") @@ -38,7 +38,7 @@ The `dims` kwarg is used to `Statevector` constructor. -`AerStatevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the conjugate of the operator. @@ -212,7 +212,7 @@ complex -`classmethod AerStatevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the output statevector of an instruction. @@ -238,7 +238,7 @@ The final statevector. -`static AerStatevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`static AerStatevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a computational basis statevector. @@ -266,7 +266,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerStatevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -355,7 +355,7 @@ tuple -`AerStatevector.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.metadata()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return result metadata of an operation that executed lastly. @@ -538,7 +538,7 @@ Additional Information: -`AerStatevector.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.md index 19ae0afd358..1bc6ad231e2 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_noise_model.md index fb3f3841a0a..a55bd1cde5f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_quantum_error.md index b11ed875e94..34cea362496 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.insert_noise.md b/docs/api/qiskit/0.39/qiskit_aer.utils.insert_noise.md index 4a76436e647..781c8172b8d 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.remap_noise_model.md b/docs/api/qiskit/0.39/qiskit_aer.utils.remap_noise_model.md index c299cda8af2..33d73b14a5f 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.transform_noise_model.md b/docs/api/qiskit/0.39/qiskit_aer.utils.transform_noise_model.md index d7301f5f544..f5fb8849045 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_noise_model.md index 4fd8ade1fe4..f1c17a64b81 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_quantum_error.md index 0e89f33a58f..accabb93593 100644 --- a/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.39/qiskit_aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.39/synthesis_aqc.md b/docs/api/qiskit/0.39/synthesis_aqc.md index 15ca87b3a57..18a3ac68df3 100644 --- a/docs/api/qiskit/0.39/synthesis_aqc.md +++ b/docs/api/qiskit/0.39/synthesis_aqc.md @@ -127,7 +127,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.39/utils.md b/docs/api/qiskit/0.39/utils.md index 28784506226..e2f42997aa5 100644 --- a/docs/api/qiskit/0.39/utils.md +++ b/docs/api/qiskit/0.39/utils.md @@ -110,7 +110,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -231,7 +231,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -245,7 +245,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From 23e3bc7738b34ae40ec7715ac9c125bf8f1a26c3 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:49:55 +0100 Subject: [PATCH 20/41] Regenerate qiskit 0.40.0 --- docs/api/qiskit/0.40/execute.md | 2 +- docs/api/qiskit/0.40/pulse.md | 8 +- docs/api/qiskit/0.40/qasm3.md | 14 +- .../0.40/qiskit.algorithms.AlgorithmError.md | 2 +- .../0.40/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.40/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.40/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.40/qiskit.algorithms.Grover.md | 8 +- .../0.40/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../api/qiskit/0.40/qiskit.algorithms.PVQD.md | 8 +- .../0.40/qiskit.algorithms.PVQDResult.md | 2 +- .../0.40/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.40/qiskit.algorithms.QAOA.md | 2 +- .../0.40/qiskit.algorithms.RealEvolver.md | 4 +- .../0.40/qiskit.algorithms.RealTimeEvolver.md | 4 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 4 +- .../qiskit.algorithms.SciPyRealEvolver.md | 4 +- .../api/qiskit/0.40/qiskit.algorithms.Shor.md | 8 +- .../0.40/qiskit.algorithms.ShorResult.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 4 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.40/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.40/qiskit.algorithms.VQD.md | 14 +- .../0.40/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.40/qiskit.algorithms.VQE.md | 14 +- .../qiskit/0.40/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.40/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 6 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 6 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 6 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- .../qiskit.algorithms.estimate_observables.md | 2 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 6 +- .../qiskit.algorithms.gradients.BaseQGT.md | 6 +- ...lgorithms.gradients.BaseSamplerGradient.md | 6 +- ...kit.algorithms.gradients.DerivativeType.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.40/qiskit.algorithms.gradients.QFI.md | 6 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 10 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 6 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 6 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 6 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 6 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 6 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 6 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.40/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.40/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.40/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.40/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.40/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.40/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 16 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.40/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.40/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- ...lgorithms.optimizers.SteppableOptimizer.md | 18 +- .../0.40/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.40/qiskit.algorithms.optimizers.UMDA.md | 6 +- ...optimizers.optimizer_utils.LearningRate.md | 6 +- ...thms.state_fidelities.BaseStateFidelity.md | 6 +- ...ithms.state_fidelities.ComputeUncompute.md | 6 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 6 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 4 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 4 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 6 +- .../qiskit/0.40/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.40/qiskit.assembler.disassemble.md | 2 +- .../0.40/qiskit.circuit.AncillaQubit.md | 2 +- .../0.40/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.40/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.40/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.40/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.40/qiskit.circuit.Clbit.md | 2 +- .../0.40/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.40/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.40/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.40/qiskit.circuit.Delay.md | 12 +- .../0.40/qiskit.circuit.EquivalenceLibrary.md | 16 +- .../qiskit/0.40/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.40/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.40/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.40/qiskit.circuit.Instruction.md | 26 +- .../0.40/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.40/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.40/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.40/qiskit.circuit.ParameterVector.md | 6 +- .../0.40/qiskit.circuit.QuantumCircuit.md | 222 +++++++++--------- .../0.40/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.40/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.40/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.AND.md | 2 +- .../0.40/qiskit.circuit.library.Barrier.md | 8 +- .../0.40/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.40/qiskit.circuit.library.C3XGate.md | 6 +- .../0.40/qiskit.circuit.library.C4XGate.md | 6 +- .../0.40/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.40/qiskit.circuit.library.CHGate.md | 4 +- .../0.40/qiskit.circuit.library.CPhaseGate.md | 8 +- .../0.40/qiskit.circuit.library.CRXGate.md | 4 +- .../0.40/qiskit.circuit.library.CRYGate.md | 4 +- .../0.40/qiskit.circuit.library.CRZGate.md | 4 +- .../0.40/qiskit.circuit.library.CSXGate.md | 2 +- .../0.40/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.40/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.40/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.40/qiskit.circuit.library.CUGate.md | 4 +- .../0.40/qiskit.circuit.library.CXGate.md | 6 +- .../0.40/qiskit.circuit.library.CYGate.md | 4 +- .../0.40/qiskit.circuit.library.CZGate.md | 4 +- .../0.40/qiskit.circuit.library.DCXGate.md | 2 +- .../0.40/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.40/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.GRZ.md | 2 +- .../0.40/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.40/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.40/qiskit.circuit.library.IGate.md | 6 +- .../qiskit/0.40/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.40/qiskit.circuit.library.MCMT.md | 6 +- .../0.40/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.40/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.40/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.40/qiskit.circuit.library.MSGate.md | 2 +- .../0.40/qiskit.circuit.library.Measure.md | 4 +- .../0.40/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.40/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.40/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 8 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.40/qiskit.circuit.library.PhaseGate.md | 8 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.40/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.40/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.40/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.40/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.40/qiskit.circuit.library.RGate.md | 6 +- .../0.40/qiskit.circuit.library.RVGate.md | 6 +- .../0.40/qiskit.circuit.library.RXGate.md | 8 +- .../0.40/qiskit.circuit.library.RXXGate.md | 6 +- .../0.40/qiskit.circuit.library.RYGate.md | 8 +- .../0.40/qiskit.circuit.library.RYYGate.md | 6 +- .../0.40/qiskit.circuit.library.RZGate.md | 8 +- .../0.40/qiskit.circuit.library.RZXGate.md | 6 +- .../0.40/qiskit.circuit.library.RZZGate.md | 6 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.40/qiskit.circuit.library.Reset.md | 4 +- .../0.40/qiskit.circuit.library.SGate.md | 6 +- .../0.40/qiskit.circuit.library.SXGate.md | 6 +- .../0.40/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.40/qiskit.circuit.library.SdgGate.md | 6 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.40/qiskit.circuit.library.SwapGate.md | 6 +- .../0.40/qiskit.circuit.library.TGate.md | 6 +- .../0.40/qiskit.circuit.library.TdgGate.md | 6 +- .../0.40/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.40/qiskit.circuit.library.U1Gate.md | 6 +- .../0.40/qiskit.circuit.library.U2Gate.md | 4 +- .../0.40/qiskit.circuit.library.U3Gate.md | 6 +- .../0.40/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.40/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.40/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 6 +- .../qiskit.circuit.library.XXPlusYYGate.md | 6 +- .../0.40/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.40/qiskit.circuit.library.ZGate.md | 8 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.40/qiskit.circuit.library.iSwapGate.md | 4 +- .../0.40/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.40/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.40/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.40/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.40/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.40/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.40/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.40/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.40/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.40/qiskit.compiler.transpile.md | 2 +- .../0.40/qiskit.converters.ast_to_dag.md | 2 +- .../0.40/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.40/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.40/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.40/qiskit.dagcircuit.BlockCollapser.md | 4 +- .../0.40/qiskit.dagcircuit.BlockCollector.md | 6 +- .../0.40/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.40/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.40/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.40/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.40/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.40/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.40/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.40/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.40/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.40/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.40/qiskit.extensions.Snapshot.md | 8 +- .../0.40/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.40/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.40/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.40/qiskit.extensions.UCRZGate.md | 2 +- .../0.40/qiskit.extensions.UnitaryGate.md | 16 +- .../qiskit/0.40/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.40/qiskit.opflow.OpflowError.md | 2 +- .../0.40/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.40/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.40/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.40/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.40/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.40/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.40/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.40/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.40/qiskit.opflow.gradients.QFI.md | 4 +- .../0.40/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.40/qiskit.opflow.list_ops.ComposedOp.md | 16 +- .../0.40/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.40/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.40/qiskit.opflow.list_ops.TensoredOp.md | 12 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 16 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.40/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../qiskit.primitives.BackendEstimator.md | 4 +- .../0.40/qiskit.primitives.BackendSampler.md | 4 +- .../0.40/qiskit.primitives.BaseEstimator.md | 6 +- .../0.40/qiskit.primitives.BaseSampler.md | 6 +- .../0.40/qiskit.primitives.Estimator.md | 4 +- .../0.40/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.40/qiskit.primitives.Sampler.md | 4 +- .../0.40/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.40/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.40/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.40/qiskit.providers.BackendV2.md | 16 +- .../qiskit.providers.BackendV2Converter.md | 12 +- docs/api/qiskit/0.40/qiskit.providers.Job.md | 2 +- .../qiskit/0.40/qiskit.providers.JobError.md | 2 +- .../qiskit/0.40/qiskit.providers.JobStatus.md | 2 +- .../0.40/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.40/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.40/qiskit.providers.Options.md | 8 +- .../qiskit/0.40/qiskit.providers.Provider.md | 2 +- .../0.40/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.40/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.40/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.40/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.40/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.40/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.40/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.40/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.40/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.40/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.40/qiskit.pulse.ScheduleBlock.md | 30 +-- .../0.40/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.40/qiskit.pulse.builder.align_func.md | 2 +- .../0.40/qiskit.pulse.builder.align_left.md | 2 +- .../0.40/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.40/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.delay.md | 2 +- .../0.40/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.40/qiskit.pulse.builder.measure.md | 2 +- .../0.40/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.40/qiskit.pulse.builder.num_qubits.md | 2 +- .../0.40/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- .../0.40/qiskit.pulse.builder.reference.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.40/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.40/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.40/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.40/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.40/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.40/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.40/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.40/qiskit.pulse.instructions.Call.md | 4 +- .../0.40/qiskit.pulse.instructions.Delay.md | 2 +- .../0.40/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- .../0.40/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.40/qiskit.pulse.library.Drag.md | 2 +- .../0.40/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- ...kit.pulse.library.ScalableSymbolicPulse.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- .../0.40/qiskit.pulse.library.Waveform.md | 4 +- .../qiskit/0.40/qiskit.pulse.library.cos.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.40/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.40/qiskit.pulse.library.sech.md | 2 +- .../0.40/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.40/qiskit.pulse.library.sin.md | 2 +- .../0.40/qiskit.pulse.library.square.md | 2 +- .../0.40/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.40/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.40/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.40/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.40/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.40/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.40/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.40/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.40/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.40/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.40/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.40/qiskit.qobj.GateCalibration.md | 6 +- .../0.40/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.md | 6 +- .../0.40/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.40/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.40/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.40/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.40/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.40/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.40/qiskit.qobj.Qobj.md | 2 +- .../0.40/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.40/qiskit.qobj.QobjHeader.md | 2 +- .../0.40/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.40/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.40/qiskit.qpy.load.md | 2 +- .../0.40/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.40/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.40/qiskit.quantum_info.Choi.md | 12 +- .../0.40/qiskit.quantum_info.Clifford.md | 36 +-- .../0.40/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.40/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 8 +- .../0.40/qiskit.quantum_info.Operator.md | 30 +-- .../qiskit/0.40/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.40/qiskit.quantum_info.Pauli.md | 38 +-- .../0.40/qiskit.quantum_info.PauliList.md | 54 ++--- .../0.40/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.40/qiskit.quantum_info.Quaternion.md | 14 +- .../0.40/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.40/qiskit.quantum_info.SparsePauliOp.md | 46 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.40/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.40/qiskit.quantum_info.Stinespring.md | 14 +- .../0.40/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.40/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.40/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.40/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.40/qiskit.quantum_info.entropy.md | 2 +- .../0.40/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.40/qiskit.quantum_info.partial_trace.md | 2 +- .../0.40/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.40/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.40/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.40/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.40/qiskit.result.ProbDistribution.md | 6 +- .../0.40/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.40/qiskit.result.Result.md | 16 +- .../qiskit/0.40/qiskit.result.ResultError.md | 2 +- .../0.40/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.40/qiskit.result.marginal_memory.md | 2 +- ...qiskit.result.sampled_expectation_value.md | 2 +- .../0.40/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.40/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.40/qiskit.synthesis.ProductFormula.md | 2 +- ...it.synthesis.SolovayKitaevDecomposition.md | 8 +- .../0.40/qiskit.synthesis.SuzukiTrotter.md | 4 +- .../qiskit.synthesis.synth_clifford_ag.md | 2 +- .../qiskit.synthesis.synth_clifford_bm.md | 2 +- .../qiskit.synthesis.synth_clifford_full.md | 2 +- .../qiskit.synthesis.synth_clifford_greedy.md | 2 +- .../qiskit.synthesis.synth_clifford_layers.md | 2 +- ...kit.synthesis.synth_cnot_count_full_pmh.md | 2 +- ...kit.synthesis.synth_cnot_depth_line_kms.md | 2 +- ...iskit.synthesis.synth_cnotdihedral_full.md | 2 +- ...it.synthesis.synth_cnotdihedral_general.md | 2 +- ...synthesis.synth_cnotdihedral_two_qubits.md | 2 +- .../qiskit.synthesis.synth_permutation_acg.md | 2 +- ...iskit.synthesis.synth_permutation_basic.md | 2 +- ...nthesis.synth_permutation_depth_lnn_kms.md | 2 +- .../0.40/qiskit.tools.backend_monitor.md | 2 +- .../0.40/qiskit.tools.backend_overview.md | 2 +- .../qiskit.tools.events.TextProgressBar.md | 6 +- .../qiskit/0.40/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.40/qiskit.tools.parallel_map.md | 2 +- .../0.40/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.40/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.40/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.40/qiskit.transpiler.Layout.md | 30 +-- .../0.40/qiskit.transpiler.PassManager.md | 16 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.40/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 12 +- .../qiskit/0.40/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.40/qiskit.transpiler.TranspilerError.md | 2 +- ...anspiler.passes.ACGSynthesisPermutation.md | 4 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...spiler.passes.BasicSynthesisPermutation.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.40/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...it.transpiler.passes.CollectAndCollapse.md | 4 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...r.passes.CommutativeInverseCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 4 +- .../0.40/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.40/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...it.transpiler.passes.HighLevelSynthesis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...anspiler.passes.KMSSynthesisPermutation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- ...kit.transpiler.passes.OptimizeCliffords.md | 4 +- .../0.40/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- ....passes.ResetAfterMeasureSimplification.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.40/qiskit.transpiler.passes.Size.md | 4 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 4 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- ...iler.passes.TranslateParameterizedGates.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.40/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.40/qiskit.transpiler.passes.Width.md | 4 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 4 +- ....plugin.HighLevelSynthesisPluginManager.md | 6 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...mon.generate_control_flow_options_check.md | 2 +- ...agers.common.generate_embed_passmanager.md | 2 +- ...s.common.generate_error_on_control_flow.md | 2 +- ...gers.common.generate_pre_op_passmanager.md | 2 +- ...ers.common.generate_routing_passmanager.md | 2 +- ...passmanagers.common.generate_scheduling.md | 2 +- ...common.generate_translation_passmanager.md | 2 +- ..._passmanagers.common.generate_unroll_3q.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 4 +- ...rs.plugin.PassManagerStagePluginManager.md | 4 +- ..._passmanagers.plugin.list_stage_plugins.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- ...ler.synthesis.aqc.FastCNOTUnitObjective.md | 6 +- .../0.40/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.40/qiskit.utils.apply_prefix.md | 2 +- .../0.40/qiskit.utils.deprecate_arguments.md | 2 +- .../0.40/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.40/qiskit.utils.detach_prefix.md | 2 +- .../0.40/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.40/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.40/qiskit.utils.has_ibmq.md | 2 +- .../0.40/qiskit.utils.is_main_process.md | 2 +- .../0.40/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 8 +- .../api/qiskit/0.40/qiskit.utils.name_args.md | 2 +- .../0.40/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.40/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.40/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.40/qiskit_aer.AerError.md | 2 +- .../api/qiskit/0.40/qiskit_aer.AerProvider.md | 6 +- .../qiskit/0.40/qiskit_aer.AerSimulator.md | 14 +- .../qiskit/0.40/qiskit_aer.PulseSimulator.md | 8 +- .../qiskit/0.40/qiskit_aer.QasmSimulator.md | 12 +- .../0.40/qiskit_aer.StatevectorSimulator.md | 8 +- .../0.40/qiskit_aer.UnitarySimulator.md | 8 +- .../api/qiskit/0.40/qiskit_aer.jobs.AerJob.md | 16 +- .../qiskit/0.40/qiskit_aer.jobs.AerJobSet.md | 20 +- .../0.40/qiskit_aer.library.SaveAmplitudes.md | 2 +- ...iskit_aer.library.SaveAmplitudesSquared.md | 2 +- .../0.40/qiskit_aer.library.SaveClifford.md | 2 +- .../qiskit_aer.library.SaveDensityMatrix.md | 2 +- ...qiskit_aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...skit_aer.library.SaveMatrixProductState.md | 2 +- .../qiskit_aer.library.SaveProbabilities.md | 2 +- ...iskit_aer.library.SaveProbabilitiesDict.md | 2 +- .../0.40/qiskit_aer.library.SaveStabilizer.md | 2 +- .../0.40/qiskit_aer.library.SaveState.md | 2 +- .../qiskit_aer.library.SaveStatevector.md | 2 +- .../qiskit_aer.library.SaveStatevectorDict.md | 2 +- .../0.40/qiskit_aer.library.SaveSuperOp.md | 2 +- .../0.40/qiskit_aer.library.SaveUnitary.md | 2 +- .../qiskit_aer.library.SetDensityMatrix.md | 2 +- ...iskit_aer.library.SetMatrixProductState.md | 2 +- .../0.40/qiskit_aer.library.SetStabilizer.md | 2 +- .../0.40/qiskit_aer.library.SetStatevector.md | 2 +- .../0.40/qiskit_aer.library.SetSuperOp.md | 2 +- .../0.40/qiskit_aer.library.SetUnitary.md | 2 +- .../qiskit_aer.library.save_amplitudes.md | 2 +- ...kit_aer.library.save_amplitudes_squared.md | 2 +- .../0.40/qiskit_aer.library.save_clifford.md | 2 +- .../qiskit_aer.library.save_density_matrix.md | 2 +- ...skit_aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...t_aer.library.save_matrix_product_state.md | 2 +- .../qiskit_aer.library.save_probabilities.md | 2 +- ...kit_aer.library.save_probabilities_dict.md | 2 +- .../qiskit_aer.library.save_stabilizer.md | 2 +- .../0.40/qiskit_aer.library.save_state.md | 2 +- .../qiskit_aer.library.save_statevector.md | 2 +- ...iskit_aer.library.save_statevector_dict.md | 2 +- .../0.40/qiskit_aer.library.save_superop.md | 2 +- .../0.40/qiskit_aer.library.save_unitary.md | 2 +- .../qiskit_aer.library.set_density_matrix.md | 2 +- ...it_aer.library.set_matrix_product_state.md | 2 +- .../0.40/qiskit_aer.library.set_stabilizer.md | 2 +- .../qiskit_aer.library.set_statevector.md | 2 +- .../0.40/qiskit_aer.library.set_superop.md | 2 +- .../0.40/qiskit_aer.library.set_unitary.md | 2 +- .../0.40/qiskit_aer.noise.LocalNoisePass.md | 4 +- .../0.40/qiskit_aer.noise.NoiseModel.md | 24 +- .../0.40/qiskit_aer.noise.QuantumError.md | 24 +- .../0.40/qiskit_aer.noise.ReadoutError.md | 24 +- .../qiskit_aer.noise.RelaxationNoisePass.md | 2 +- ...iskit_aer.noise.amplitude_damping_error.md | 2 +- ...qiskit_aer.noise.coherent_unitary_error.md | 2 +- .../qiskit_aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...skit_aer.noise.device.gate_error_values.md | 2 +- ...kit_aer.noise.device.gate_length_values.md | 2 +- ...skit_aer.noise.device.gate_param_values.md | 2 +- ...t_aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../0.40/qiskit_aer.noise.kraus_error.md | 2 +- .../qiskit_aer.noise.mixed_unitary_error.md | 2 +- .../0.40/qiskit_aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- .../qiskit_aer.noise.phase_damping_error.md | 2 +- .../0.40/qiskit_aer.noise.reset_error.md | 2 +- ...skit_aer.noise.thermal_relaxation_error.md | 2 +- .../0.40/qiskit_aer.primitives.Estimator.md | 4 +- .../0.40/qiskit_aer.primitives.Sampler.md | 4 +- .../0.40/qiskit_aer.pulse.PulseSystemModel.md | 10 +- .../qiskit_aer.pulse.duffing_system_model.md | 2 +- .../qiskit_aer.quantum_info.AerStatevector.md | 16 +- .../0.40/qiskit_aer.utils.NoiseTransformer.md | 36 +-- ...iskit_aer.utils.approximate_noise_model.md | 2 +- ...kit_aer.utils.approximate_quantum_error.md | 2 +- .../0.40/qiskit_aer.utils.insert_noise.md | 2 +- .../qiskit_aer.utils.remap_noise_model.md | 2 +- .../qiskit_aer.utils.transform_noise_model.md | 2 +- .../qiskit_aer.utils.transpile_noise_model.md | 2 +- ...iskit_aer.utils.transpile_quantum_error.md | 2 +- docs/api/qiskit/0.40/synthesis_aqc.md | 2 +- docs/api/qiskit/0.40/utils.md | 6 +- 1127 files changed, 3004 insertions(+), 3004 deletions(-) diff --git a/docs/api/qiskit/0.40/execute.md b/docs/api/qiskit/0.40/execute.md index 1af24c354fa..b5c71060410 100644 --- a/docs/api/qiskit/0.40/execute.md +++ b/docs/api/qiskit/0.40/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.40/pulse.md b/docs/api/qiskit/0.40/pulse.md index a733189053d..daa0249c2d6 100644 --- a/docs/api/qiskit/0.40/pulse.md +++ b/docs/api/qiskit/0.40/pulse.md @@ -69,7 +69,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -228,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -687,7 +687,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.40/qasm3.md b/docs/api/qiskit/0.40/qasm3.md index 394223527e4..f4b254e4656 100644 --- a/docs/api/qiskit/0.40/qasm3.md +++ b/docs/api/qiskit/0.40/qasm3.md @@ -26,7 +26,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. @@ -44,7 +44,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. @@ -65,7 +65,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -99,7 +99,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") +`QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -123,7 +123,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -147,7 +147,7 @@ a circuit representation of the OpenQASM 3 program. -`loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -173,7 +173,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") +`QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.md index 78d413acdf9..c3761d68fa1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.md index 877b84bd5c5..0deb3cd1025 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") +`AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") Bases: `qiskit.primitives.primitive_job.PrimitiveJob` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.md index c93e4539d10..8924b380bfa 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.md index 650136dfd86..3b3fcf59e4c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.md index b18f288a597..b1ffb856422 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -77,7 +77,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -98,7 +98,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -119,7 +119,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -145,7 +145,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.md index 89ca764cc51..0f7fc6e086c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.md index 763f10c1313..d7867df6ad9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.md index 3ba8931a981..35bb6180bc7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.md index 9f532a0eb3e..a92b676db72 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.md index 3b79806ee73..062e3b285e4 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.md index 15f2762b928..59da2bff4c8 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.md index afa2803134e..a1f4169c641 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -40,7 +40,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.md index 44ee65ffc1b..8b2d71c0234 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.md index 52e16421b70..1a2c1c0a0d6 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -52,7 +52,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -72,7 +72,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.md index a24a7e8db42..ac3b3104b4a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.40/qiskit.algorithms.Grover.md index f1a2f489f12..b5744c34d1e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -94,7 +94,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -121,7 +121,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -147,7 +147,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.md index 1548fe84ce2..5aa0bdf654b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.md index cc4125d774e..6b398bc454e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -58,7 +58,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index e93c2502e25..5a66e8a074a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.md index 4e0f4a06b45..0c2e3fc4ca9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The ImaginaryEvolver interface has been superseded by the `qiskit.algorithms.tim -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.md index b86e703ec7f..14ca5760295 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`abstract ImaginaryTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.md index b530d014975..8522722c7d3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -78,7 +78,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 527767991ec..c039cf888b7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.md index 69e3582f8db..bddf50b7ad9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -39,7 +39,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -65,7 +65,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 16fce9b98f9..80135fef84a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -45,7 +45,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -71,7 +71,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -92,7 +92,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -109,7 +109,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 2d71e1a6ca5..5916b5d8e2c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.md index 0020b51c82f..4fa91d25968 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.md index 15dd2cf53ec..3d3c03ae2d9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.md index 58331e05214..4f12f5875ae 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -56,7 +56,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.md index b78d86e7509..54713ce4978 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -28,7 +28,7 @@ The NumPyMinimumEigensolver class has been superseded by the [`qiskit.algorithms -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -49,7 +49,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.md index e5b8219fbc8..098f7a15695 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -158,7 +158,7 @@ quantum algorithm for the time evolution of parameterized circuits, [Quantum 5, -`PVQD.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. @@ -185,7 +185,7 @@ A result object containing the evolution information and evaluated observables. -`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Get a function to evaluate the infidelity between Trotter step and ansatz. @@ -210,7 +210,7 @@ a second callable to evaluate the gradient of the infidelity. -`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform a single time step. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.md index 56eee3c3568..c1ff31b71c0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.md index 097d4191465..5fef067cefa 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -66,7 +66,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -80,7 +80,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -101,7 +101,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.md index c592522c411..21a0baf2d04 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.md index 64ccc36c8ba..aa2d9ad251b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.md index d94ee5a35ee..6a7b5abc0a1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.md index 649a122e127..41b1ab9f2d5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The RealEvolver interface has been superseded by the `qiskit.algorithms.time_evo -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.md index d75806df219..6c6fe22213f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`abstract RealTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.md index 5aa6b449e68..502935bf7d0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau = it$ under -`SciPyImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.md index d68a5b94634..20c9e7c1ecc 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, -`SciPyRealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.40/qiskit.algorithms.Shor.md index 8982999aaa8..7414d023a88 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -56,7 +56,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -84,7 +84,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.md index 88b1cf000ca..f9597830863 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.md index e8bcb2be6d2..bd83a89aa09 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: `object` @@ -98,7 +98,7 @@ dict\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), complex] -`TimeEvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.md index d74532b8e54..4cde25ca282 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.md index 020d37c6b6b..762b3487bbc 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -51,7 +51,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -80,7 +80,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.40/qiskit.algorithms.VQD.md index 2380e565403..91ab36ee909 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -48,7 +48,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -69,7 +69,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -90,7 +90,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -117,7 +117,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -147,7 +147,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -163,7 +163,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.md index fb1fd772701..16b061feef0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.40/qiskit.algorithms.VQE.md index dd580044bc0..23a6a3c17ef 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -76,7 +76,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -97,7 +97,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -118,7 +118,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -145,7 +145,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -172,7 +172,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -188,7 +188,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.md index 16289e5c6f3..4d3a5e339a4 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.md index ea75c10fd8f..fe8d99c0706 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.md index e31d73991b4..65de4e6c96a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ An eigensolver result. -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.md index 06b2f7194a9..21b76befa46 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index caf05a725be..2cc8d0c96f6 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -33,7 +33,7 @@ The NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valu -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -54,7 +54,7 @@ An eigensolver result. -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index dbc5510a9a8..14915b9cedf 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.md index 3ed7f69b21c..d8e32ec02d5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -144,7 +144,7 @@ An eigensolver result. -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.md index f6f4dabd863..54c15655a22 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.estimate_observables.md b/docs/api/qiskit/0.40/qiskit.algorithms.estimate_observables.md index c689df56ba5..e10c285076d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.estimate_observables.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.estimate_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.estimate_observables -`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") +`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.40/qiskit.algorithms.eval_observables.md index cad0372fb98..8cb4a944be0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") Pending deprecation: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 5e4df6bfa86..6d16d0cfc89 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Bases: `abc.ABC` @@ -38,7 +38,7 @@ Base class for an `EstimatorGradient` to compute the gradients of the expectatio -`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Run the job of the estimator gradient on the given circuits. @@ -62,7 +62,7 @@ The job object of the gradients of the expectation values. The i-th result corre -`BaseEstimatorGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.md index f94dec0097b..a551921aa07 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Bases: `abc.ABC` @@ -60,7 +60,7 @@ $$ -`BaseQGT.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Run the job of the QGTs on the given circuits. @@ -83,7 +83,7 @@ The job object of the QGTs of the expectation values. The i-th result correspond -`BaseQGT.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.md index 2d22d7a7754..b0079fba151 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Bases: `abc.ABC` @@ -27,7 +27,7 @@ Base class for a `SamplerGradient` to compute the gradients of the sampling prob -`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Run the job of the sampler gradient on the given circuits. @@ -50,7 +50,7 @@ The job object of the gradients of the sampling probability. The i-th result cor -`BaseSamplerGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.md index 98ef0803fe6..5596a747443 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType -`DerivativeType(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") +`DerivativeType(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.md index a2fca87a37f..2db8bda34a0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") +`EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 7a3ea6bbff5..81798050b1d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") +`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index 4aa3b6cf615..666d81628d5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") +`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index bf3595aec0c..553c40197f9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") +`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.md index 8bc161d035f..94dccf227f1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") +`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.md index d2551d95342..b0b9a347927 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") +`LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 4a835296c52..cd0fd8a953e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") +`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 254b6f2ac6b..92258893f5a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") +`ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.md index ce591d94d0b..84f42ebbb1f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Bases: `abc.ABC` @@ -32,7 +32,7 @@ $$ -`QFI.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Run the job of the QFIs on the given circuits. @@ -51,7 +51,7 @@ The job object of the QFIs of the expectation values. The i-th result correspond -`QFI.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.md index ec72cc7bf99..cea3bda19d5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") +`QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.md index a5d30dc28b7..9af58c1857f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") +`QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index b5a3a460fc4..93b455adf4c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") +`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.md index 1c7d04f66f2..a3dd4ffa498 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") +`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 08a3c462dde..479523cfd8d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") +`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.md index bac2f7cb3d4..e2f4c3c4c15 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") +`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.md index aeeb3337e8c..dd9af027763 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") +`SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 10705143ab1..55e45e718ed 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage -`AbsoluteAverage`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -57,7 +57,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -77,7 +77,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -97,7 +97,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -117,7 +117,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.md index a0baa6474aa..7a770a3c061 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -73,7 +73,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -101,7 +101,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.md index 3eac543ee0c..d1dd3f779c3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.md index 05b6cc4c8e8..12f581d3ba4 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index b29b9b8b516..9e58f4498e0 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -495,7 +495,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1148,7 +1148,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2147,7 +2147,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index 307eb9c7133..aae97f9a273 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 496e1c64d28..e9c64b1e1a5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -72,7 +72,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -92,7 +92,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -112,7 +112,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -132,7 +132,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index 6023d2b249c..89358514c13 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -47,7 +47,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.md index 0d8d5b9e1bc..28be67c2cbd 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -517,7 +517,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1170,7 +1170,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1679,7 +1679,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2169,7 +2169,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index b9d2b07a9d2..43d840d6e2b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -530,7 +530,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1183,7 +1183,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1692,7 +1692,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2182,7 +2182,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 2cd666de64a..20cf2c34781 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -69,7 +69,7 @@ the maximum number of iterations for the adaptive loop. If `None`, the algorithm -`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Computes the minimum eigenvalue. @@ -95,7 +95,7 @@ An [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qis -`classmethod AdaptVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`classmethod AdaptVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 50d105cc089..b77bf184696 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 8b4b8f60845..59d55485770 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ A minimum eigensolver result. -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 8fd386db895..13c0d8084ea 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 49b0154d470..e18b53e8a8f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -26,7 +26,7 @@ The NumPy minimum eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -47,7 +47,7 @@ A minimum eigensolver result. -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 6007ad2d4b9..8fa5658edaf 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.md index df54e147abd..bc1a5a6637c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 05bf7bf2539..b4c2ea54232 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Sampling Minimum Eigensolver Interface. -`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -43,7 +43,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`classmethod SamplingMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 1eba5396f4a..853df6d0b3f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 9dcfac32cdd..a4739f6d797 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -144,7 +144,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`classmethod SamplingVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index 85ed351378f..e73687f4d06 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.md index 51bf986c188..829aed79ca4 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -129,7 +129,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -150,7 +150,7 @@ A minimum eigensolver result. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 4d9492dc3d8..c4986cff3bc 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.md index 8382dd05279..3b5421e71e5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.md index 8bd87981fe0..3377a2c813d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.md index b28d6820b9e..ddd9860012b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.md index ec722dfbbe3..f3201b4dd31 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.md index b92f3958c08..d86bc22153c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.md index 417ca0bc042..cfd378cb04e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.md index 044cdd62086..f589c4181c5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.md index 0a48df3a05e..57feb623f52 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index e87f0d2c37d..6d42e2ffa78 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.md index 0015cb6720e..ac18b7b2f8b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.md index 011adfd6903..72ac2fd2b09 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.md index 0be0e52fb2d..ffc9edff2c1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") @@ -141,7 +141,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`GradientDescent.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Returns an object with the data needed to evaluate the gradient. @@ -155,7 +155,7 @@ If this object contains a gradient function the gradient can be evaluated direct -`GradientDescent.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Condition that indicates the optimization process should come to an end. @@ -173,7 +173,7 @@ When the stepsize is smaller than the tolerance, the optimization process is con -`GradientDescent.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Creates a result of the optimization process. @@ -191,7 +191,7 @@ The result of the optimization process. -`GradientDescent.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Evaluates the gradient. @@ -213,7 +213,7 @@ The data containing the gradient evaluation. -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -299,7 +299,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`GradientDescent.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -332,7 +332,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.GradientDescent#ask -`GradientDescent.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Updates `x` by an ammount proportional to the learning rate and value of the gradient at that point. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.md index 8263430eb27..1f19abc74de 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.md index 4c26cf619a9..67a1ae55613 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.md index a6338965582..814df68ba9b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.md index f4d82e90623..d93d62b858a 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.md index 07fd105ce15..980b1156bf2 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.md index 9107ba9826f..12ab5513ba4 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.md index ca1e1e26ccb..d88a7e979e8 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.md index 8fd99c5dcc5..8d0d4450bb7 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.md index 5bc94cce554..2dc47e03463 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.md index 363ed8aede2..983a4f7b20f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index ae26bc6fc6c..6d2436a94be 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.md index b18066d10e8..33d5d3f7ce2 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.md index c3711e8b04f..9477a3db93d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.md index 5368bdd57cb..700006b7a0c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -154,7 +154,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.md index a407ac6e76b..e4eb2fe2943 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.md index 764a5be40db..f20b3e0a764 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -38,7 +38,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -69,7 +69,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.md index 7e5b2a878af..2e73e27179d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.md index 6ee56a70440..acd8ef6a35b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.md index b0dbd71a103..81fa839d152 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -77,7 +77,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`SteppableOptimizer.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Ask the optimizer for a set of points to evaluate. @@ -95,7 +95,7 @@ An object containing the data needed to make the funciton evaluation to advance -`SteppableOptimizer.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Condition that indicates the optimization process should continue. @@ -111,7 +111,7 @@ Condition that indicates the optimization process should continue. -`abstract SteppableOptimizer.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Returns the result of the optimization. @@ -129,7 +129,7 @@ The result of the optimization process. -`abstract SteppableOptimizer.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Evaluates the function according to the instructions contained in `ask_data`. @@ -182,7 +182,7 @@ grad -`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Minimizes the function. @@ -237,7 +237,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -256,7 +256,7 @@ Populates the state of the optimizer with the data provided and sets all the cou -`SteppableOptimizer.step()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.step()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Performs one step in the optimization process. @@ -270,7 +270,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#a -`SteppableOptimizer.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Updates the optimization state using the results of the function evaluation. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.md index 75cfef2dfa7..60fca8692f9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.md index ac914eef91d..3cb175e90b5 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.md index d54be830117..49e880bce02 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 99399f21d71..10677c3234c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: `Generator` @@ -34,7 +34,7 @@ Raise GeneratorExit inside generator. -`LearningRate.send(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.send(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Send a value into the generator. Return next yielded value or raise StopIteration. @@ -42,7 +42,7 @@ Send a value into the generator. Return next yielded value or raise StopIteratio -`LearningRate.throw(typ, val=None, tb=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.throw(typ, val=None, tb=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Raise an exception in the generator. Return next yielded value or raise StopIteration. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index bbd9988735a..e94d8adc07b 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: `abc.ABC` @@ -28,7 +28,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. @@ -49,7 +49,7 @@ The fidelity quantum circuit corresponding to `circuit_1` and `circuit_2`. -`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.md index f10a6de0474..7c548640817 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`ComputeUncompute(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") @@ -39,7 +39,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Combines `circuit_1` and `circuit_2` to create the fidelity circuit following the compute-uncompute method. @@ -80,7 +80,7 @@ Primitive job for the fidelity calculation. The job’s result is an instance of -`ComputeUncompute.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Update the fidelity’s default options setting. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.md index ae599eaaa77..09f7ada9ad9 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index d052f200f6a..24c45c3ff12 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`TrotterQRTE(product_formula=None, estimator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, estimator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using an estimator primitive provided. @@ -78,7 +78,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index ea3308b2971..3b615abcd7f 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `scipy.integrate._ivp.base.OdeSolver` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index a5b45defcee..443bf02d1c1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") @@ -31,7 +31,7 @@ Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize -`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index 6cc04edc73a..6b2675e483c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index 7ad673b1f5a..e9c506af13e 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") @@ -31,7 +31,7 @@ Class for a Real McLachlan’s Variational Principle. It aims to minimize the di -`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 47d8c8abc79..d8cdb9e2edf 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 040fe82af2f..0be6a279966 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: `abc.ABC` @@ -47,7 +47,7 @@ Instance of a class used to compute the state gradient. -`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. @@ -66,7 +66,7 @@ An evolution gradient. -`VariationalPrinciple.metric_tensor(ansatz, param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple.metric_tensor(ansatz, param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates a metric tensor according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.md index 4f87ece860a..90f39a8920b 100644 --- a/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.40/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.40/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.40/qiskit.assembler.assemble_circuits.md index 987eaf598a7..1c6e57ff275 100644 --- a/docs/api/qiskit/0.40/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.40/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.40/qiskit.assembler.assemble_schedules.md index adae82eadb2..7329ed3cc99 100644 --- a/docs/api/qiskit/0.40/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.40/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.40/qiskit.assembler.disassemble.md index 8a6722e2d6d..a5aa312d43a 100644 --- a/docs/api/qiskit/0.40/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.40/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.md index 8fa12e98d6a..90e7b731604 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.md index be136708f35..ef5f5d2b60c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.md index d7fecec8d82..88ad59b9cd0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.md index 11f7c25eb70..2b314ec5d74 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.md index 632218f035e..29499d3d0fc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.40/qiskit.circuit.Clbit.md index 43a47cbe1b3..ac503293d5f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.md index 804ed3e332b..84e5e12c1eb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.md index c3a59f63e36..12045265b61 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.md index b1e3f395b89..217dcf88ea3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -210,7 +210,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Delay.md b/docs/api/qiskit/0.40/qiskit.circuit.Delay.md index da2e5d5f610..2bf5a2abfad 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.md index a3d0b4660a3..d323cabefa6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.keys()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.keys()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return list of keys to key to node index map. @@ -133,7 +133,7 @@ List -`EquivalenceLibrary.node_index(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.node_index(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return node index for a given key. @@ -153,7 +153,7 @@ Int -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.md index 929aa14ed46..c80eaf2a074 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Gate.md b/docs/api/qiskit/0.40/qiskit.circuit.Gate.md index 080a24edfc7..8d3ae99783d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.md index a7d5e571f02..683b99898d6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.40/qiskit.circuit.Instruction.md index de74c5a2202..09f911b5f24 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.md index 3de0e6dab77..f1ce0614298 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -109,7 +109,7 @@ qc.draw('mpl') -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Operation.md b/docs/api/qiskit/0.40/qiskit.circuit.Operation.md index d7689abd058..54a0fa255c6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") +`Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.40/qiskit.circuit.Parameter.md index 1cfec4d759a..b576bfb07c5 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -209,7 +209,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.md index b7cd30b40f0..4567d7c54b2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -107,7 +107,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -119,7 +119,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -127,7 +127,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -135,7 +135,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -155,7 +155,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -163,7 +163,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -171,7 +171,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -179,7 +179,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -206,7 +206,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -220,7 +220,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.md index 8ebdbd000e6..5a8df333eb9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.md index c41d9ebd2b6..b3f02e5843e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -111,7 +111,7 @@ qc.draw('mpl') -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -123,7 +123,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -146,7 +146,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -158,7 +158,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -188,7 +188,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -272,7 +272,7 @@ Fig. 9 ([png](qiskit-circuit-QuantumCircuit-assign_parameters-2_01.png), [hires. -`QuantumCircuit.barrier(*qargs, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -293,7 +293,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -322,7 +322,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -346,7 +346,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -358,7 +358,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -378,7 +378,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -403,7 +403,7 @@ A handle to the instructions created. -`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CCZGate`. @@ -429,7 +429,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -454,7 +454,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -468,7 +468,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -480,7 +480,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -492,7 +492,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -521,7 +521,7 @@ A handle to the instructions created. -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -577,7 +577,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -601,7 +601,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -627,7 +627,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -647,7 +647,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -673,7 +673,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -689,7 +689,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -715,7 +715,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -741,7 +741,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -767,7 +767,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -793,7 +793,7 @@ A handle to the instructions created. -`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSGate`. @@ -818,7 +818,7 @@ A handle to the instructions created. -`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSdgGate`. @@ -843,7 +843,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -869,7 +869,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -894,7 +894,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -923,7 +923,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -948,7 +948,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -973,7 +973,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -998,7 +998,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1021,7 +1021,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1042,7 +1042,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1068,7 +1068,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1119,7 +1119,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1195,7 +1195,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1218,7 +1218,7 @@ A handle to the instructions created. -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1249,7 +1249,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1304,7 +1304,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1332,7 +1332,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Construct a circuit from an iterable of CircuitInstructions. @@ -1353,7 +1353,7 @@ The quantum circuit. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1373,7 +1373,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1393,7 +1393,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1413,7 +1413,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1443,7 +1443,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1451,7 +1451,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1471,7 +1471,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1493,7 +1493,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1519,7 +1519,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1565,7 +1565,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1719,7 +1719,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1821,7 +1821,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1844,7 +1844,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1930,7 +1930,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1971,7 +1971,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2008,7 +2008,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2033,7 +2033,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2055,7 +2055,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2084,7 +2084,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2107,7 +2107,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2127,7 +2127,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2141,7 +2141,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2157,7 +2157,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2169,7 +2169,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2192,7 +2192,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2213,7 +2213,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2339,7 +2339,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2366,7 +2366,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2386,7 +2386,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2406,7 +2406,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2433,7 +2433,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2460,7 +2460,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2484,7 +2484,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2509,7 +2509,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2533,7 +2533,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2555,7 +2555,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2575,7 +2575,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2595,7 +2595,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2649,7 +2649,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2689,7 +2689,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2716,7 +2716,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2740,7 +2740,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2764,7 +2764,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2788,7 +2788,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2812,7 +2812,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2835,7 +2835,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2859,7 +2859,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2883,7 +2883,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3295,7 +3295,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3463,7 +3463,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3541,7 +3541,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3564,7 +3564,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3586,7 +3586,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3608,7 +3608,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3630,7 +3630,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3652,7 +3652,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3699,7 +3699,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3720,7 +3720,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3741,7 +3741,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3769,7 +3769,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3929,7 +3929,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -3974,7 +3974,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -3990,7 +3990,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4013,7 +4013,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4035,7 +4035,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.md index 2ac761afe77..00d6daedbf2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.40/qiskit.circuit.Qubit.md index 522275d2040..860a3cfc84a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.md index a180e949bc9..c10dc8311ef 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.md index 077e093cc1a..670a65f545c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.md index da86a0d15d6..3ecdf9a61cf 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 08daec4fe67..825facd3392 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index e4ebbf0cbda..b173b304429 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.40/qiskit.circuit.library.AND.md index 79dc0352176..7495768fd06 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.md index 75d4412b54c..a21c742a4d3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -51,7 +51,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -72,7 +72,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -106,7 +106,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.md index 446be7cb24d..103a07a58fd 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.md index c2978779dee..941370a632d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.md index a0430dcd9ef..6c120c7dcb1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.md index 71dd510e909..4bbab0696b8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.md index da04c66e850..410308ef9d7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.md index 9361f395f57..1c1153df13a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.md index 59e02db96b0..b9aa451a4d8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) @@ -83,7 +83,7 @@ Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) -`CPhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.md index 39e9e2fc093..e6c10b2b426 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.md index 22a65b6ca0e..40a4f74d7fa 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.md index 289d94ce27a..332447959c1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.md index 3e628baa9b6..815296abd27 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.md index 8e1f38635f4..f8a85f8b357 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.md index 3a34cf79725..14b9925ec37 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.md index b1967837ce1..74c5337eddb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.md index 31adfab3941..12ac1e77bd8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.md index 4bf901fe96e..f415506b93f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.md index 61e42f333e3..00083d95736 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.md index d49aef13e1c..413a1686833 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.md index 32af862167c..8611dd455f1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.md index 86021bf9051..4576fd194da 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.md index 4ef019e97ab..ba7c1080106 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.md index 86c6f9aa0bf..a30265302c1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.md index d72166b9d23..5596cb2eaa0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.md index e159d1439a1..013a980fd32 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.md index 461f37f2d75..76209050901 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.md index 190fba134ea..0c43aec3a3c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.md index d975fbaab2c..486b1c0afac 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.md index 0f438cafd6a..077fd8c5b30 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.md index 734342ef996..b2245be6b71 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GR.md index cd807d74040..1ed9af83522 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.md index 628202837bb..fcb2a0fcd51 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.md index 6b144f0dc23..e5ab30a6b1c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.md index 4710970cbcf..b5e3710d429 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.md index 8ee02500ec3..3c5ed9ac5bc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.md index 8a24ed45b81..a97b58002eb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.md index 8469bf47116..dfd5f7c9b4f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.md index 621a3a9823c..2d1490a19a0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.md index 89e4c0e7bcf..5ac46bf6bea 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.md index f7424870926..b9ca4f45aa2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. @@ -53,7 +53,7 @@ Invert this gate. -`IGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.md index cbd8f9c0102..78c08604074 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.md index 04f5c997676..b9a2ee0a5d0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.md index 182377d157b..037f41277f2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.md index 7fa6c8976e1..e2644f9a996 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.md index e622abff0a2..a9520684b76 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.md index 3aaacd1c7e6..14c8db8b921 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.md index 81b0a8f5b93..4ce42bea92f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -52,7 +52,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -60,7 +60,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.md index 582dc4ff886..373c86baed4 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -78,7 +78,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.md index 0183c097408..f5cd6fb1f61 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.md index dd69b71ebf0..31850e6f71d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.md index a7da7d059ce..01760a4ec17 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.md index 9f1cde91398..323a6144c55 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.md index d8759215a46..6d8cf59c276 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.md index b51b1906508..8c0c4d6dfb3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.md index f03c9d89380..85ff760e5b0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.md index 2f28caef69f..a6e62ca45fc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -74,7 +74,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -100,7 +100,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -122,7 +122,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -165,7 +165,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -181,7 +181,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.40/qiskit.circuit.library.OR.md index 00c7b480434..ac800813aa7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.md index 3297045e664..0506be6a25a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.md index 2b5b2d9ae93..3a980429089 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.md index 3fc6b245319..26db9ea5c75 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.md index 93a8698f6a7..af62e8b16a4 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.md index 98e17b1215c..82fa42f379a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.md index f21c9ffff15..8aa1b9307c3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Return a permutation gate. -`PermutationGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Returns the inverse of the permutation. @@ -52,7 +52,7 @@ Returns the inverse of the permutation. -`PermutationGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") The qasm for a permutation. @@ -60,7 +60,7 @@ The qasm for a permutation. -`PermutationGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Parameter validation. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.md index d4b959d8a95..46b605c108c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.md index edac42d9b58..8d788b173c1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) @@ -100,7 +100,7 @@ Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) -`PhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.md index 16c6b6f11e5..538601eb06a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.md index 5ffbfe93c03..8e06a0b4b5e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 62ab5a23725..8ddb7842e91 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index ee2b49cd727..fc705d1613e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.md index 50f7b097cba..ebba6afdb53 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.md index 2abdeeac506..2e943840a51 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.md index 3cd0d146a50..eeb7f9395ec 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -61,7 +61,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -77,7 +77,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.md index b680691ac07..379fd259318 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.md index 026fc62ac89..ec69d517483 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.md index 81a343498b6..4a3cd3df13c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.md index 14ba96a8aa1..236ac3929de 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.md index 9c42ecef7c6..d5cc25468e6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.md index 0de358c93c6..de354d4a3d8 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. @@ -54,7 +54,7 @@ r(θ, φ)^dagger = r(-θ, φ) -`RGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.md index e4dbcee741a..487259ed54d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.md index 87c03d6b6f2..2a1c7493394 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. @@ -76,7 +76,7 @@ $RX(\lambda)^{\dagger} = RX(-\lambda)$ -`RXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.md index cfd9f8b60d0..e99913091f3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RXX gate (i.e. with the negative rotation angle). -`RXXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.md index e74136d5b85..44137c5143c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. @@ -76,7 +76,7 @@ $RY(\lambda){\dagger} = RY(-\lambda)$ -`RYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.md index c8de5d40a44..f47d3e76177 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RYY gate (i.e. with the negative rotation angle). -`RYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.md index 85fa328b294..13d82090db2 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate @@ -88,7 +88,7 @@ $RZ(\lambda){\dagger} = RZ(-\lambda)$ -`RZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.md index f5ed86678ae..cd5cf462943 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). @@ -116,7 +116,7 @@ Return inverse RZX gate (i.e. with the negative rotation angle). -`RZXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.md index ac5b92a837e..f85e86c8254 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). @@ -90,7 +90,7 @@ Return inverse RZZ gate (i.e. with the negative rotation angle). -`RZZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.md index b36f8033189..81f80b57077 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.md index 6205e0ff1b1..84c1f90d196 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.md index 39dafb99cf8..5af27cad582 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). @@ -57,7 +57,7 @@ Return inverse of S (SdgGate). -`SGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.md index 1ee0a76c765..c681575c30a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.md index ebdf3a8770e..9aa7eef2187 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.md index dd7732f601d..36e9d20daf1 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). @@ -57,7 +57,7 @@ Return inverse of Sdg (SGate). -`SdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.md index 7b5aa7feaa8..cba0ca71181 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.md index e700f960e4d..db3eea03411 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.md index bbddfdff0f2..907f7e0dfc0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). @@ -57,7 +57,7 @@ Return inverse T gate (i.e. Tdg). -`TGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.md index ce83234bf4b..e3824566ebe 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). @@ -57,7 +57,7 @@ Return inverse Tdg gate (i.e. T). -`TdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.md index a5d96e8a5e9..804685d06d9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -134,7 +134,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.md index 0fcc929f76b..6be66dd79ee 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -83,7 +83,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -105,7 +105,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.md index 8dbe6a07d67..dbf69d179b6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.md index a69aa7d5aed..6863f9effda 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -96,7 +96,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.md index 16f8b8d2daf..a588af243bb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.md index 1b9f73aff20..2b108204043 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.md index b98465321d9..d626977ec8d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.md index d6e2b1195cf..a86240373b7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.md index f62a5f4ba5c..dc50e0e1e22 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.md index d378f67a9b6..9bc00161206 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. @@ -86,7 +86,7 @@ Inverse gate. -`XXMinusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.md index ac25436d40a..337f31ce50a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). @@ -86,7 +86,7 @@ Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase -`XXPlusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.md index 8f4f8a2e5f7..94eb7049d04 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.md index 17a3fcc3e75..fc34f2146af 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.md index bcc47dc0d31..ed03feca04b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). @@ -96,7 +96,7 @@ Return inverted Z gate (itself). -`ZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.md index 989b9cf71fa..690da90d393 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_1.md index 537a2592732..39d5df7239a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_2.md index cbc054b1f73..fe878c0871d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_3.md index 4067d4099cf..0e7fe5a15f9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_4.md index df5a5b13f6a..6dcce274813 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_3_1.md index d6dab2fc07a..b03a3035831 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_1.md index e5cb97250c1..9c83ff85b38 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_2.md index 57c4ffbdf9b..59dbbef3dbf 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_3.md index 11c7d5cd0e2..059587c2863 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_4.md index 5eafc0a0abe..b1801eac2e6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_5_1.md index 4838b2afc26..97eec849606 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_1.md index 0f730a0a850..750f27c8414 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_2.md index 32481500c09..4305b9c7d6f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_3.md index f4c16715bca..37c3a2a9eb7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_4.md index f13175b19b8..5030945f812 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_5.md index b4e83cd6f30..b565c707a8f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_1.md index 5db991f3aaa..80f71d0ee14 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_2.md index 3509d7227e8..ce5beb27a8c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_3.md index 92a08eaa2a4..e5f385d315d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.md index 4d3b6311a5f..39307cb702b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -77,7 +77,7 @@ Create new iSwap gate. -`iSwapGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_cy.md index 2e7c58db696..34cbda2bf44 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_xz.md index dc512e4fad5..d1993b9377d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_yz.md index b430c7c7605..8ebf514777c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz1.md index f6d631f440c..960e560d2c3 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz2.md index 8ddfd743be2..ec227cc0cfa 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz3.md index 4658b8ba613..84a2697df98 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 411cc2785bd..3dbe2fbb715 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index d4658054174..1ec00ffbadc 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 523b9ca1ee1..dc5e045b707 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index ba9d086e738..547fda45d28 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 97efbb86e96..71c1fa7cf2b 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index dcfb88a2083..f17a3a11589 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index eb681b27915..7977d0ecfe6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 7716596b8c7..3b7c4b401e9 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 2030aff311c..f07d7360644 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 4f995a87f7e..ee854c45e50 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 63d67446d01..9bcd5b661f7 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index d3feffedd4a..6bc79299d26 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index d5df5a4840d..ead2358ed20 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index f6ceda17a34..ca8f1e625e6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 3c69aeb9710..ac504aaf766 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 28c6c50f977..10a09d46fad 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index e9ace7e9516..46dc1c8cd4f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index a7b7b028d63..501c28a359f 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 101eb025fac..6bb70c6426a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 0b99372f4f1..116c8706000 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 063a1019dd8..eec5c1da56e 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index a9450c13fb0..4003eb8e2aa 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 57f5f89602e..3d99e9884a6 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 7add567d79f..b436afdb0e0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 4d21f1ecea0..36aef9e7525 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 912f691818a..8c2be8ce09c 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index b14c7c34ad1..12ac7737910 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 190aaf00371..058d34cc91a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 6d8196a357f..a4bff248d51 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 6e8b04ad1e3..5db881bee9a 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index cb3aae6bda2..a3886765e61 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 1a502f14d60..55e9f2a4172 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 01cbe2f3259..8713945b288 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 55191519877..a389764e230 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 3e604d8aae5..b3af7d6f6b4 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index d755e41e8c5..7cc9126971d 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 7db3309ec76..bfd297827eb 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 640bdd2e40b..f90983de338 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 4f16e108b89..13585ff1724 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index 95efa766d85..13f091ff347 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 9547a53343c..e408b3b3527 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 230d5ad3387..9213072f884 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 9e2d4cbe7e4..ebc28a69c32 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index cf0ffb26b11..c704a176587 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index b59fe428856..599696c96e0 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index f05dbd7d8b5..0b9ad3ae335 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index da1c5d8c7d5..8337f735b16 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.40/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.40/qiskit.circuit.random.random_circuit.md index 6b347fed212..d841ed21429 100644 --- a/docs/api/qiskit/0.40/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.40/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.40/qiskit.compiler.assemble.md b/docs/api/qiskit/0.40/qiskit.compiler.assemble.md index 7e6785ebf9b..cfcd3d0bf51 100644 --- a/docs/api/qiskit/0.40/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.40/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.40/qiskit.compiler.schedule.md b/docs/api/qiskit/0.40/qiskit.compiler.schedule.md index 2a8358979da..0ad32ddd7a7 100644 --- a/docs/api/qiskit/0.40/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.40/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.40/qiskit.compiler.sequence.md b/docs/api/qiskit/0.40/qiskit.compiler.sequence.md index 46db9f61083..b63196cd566 100644 --- a/docs/api/qiskit/0.40/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.40/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.40/qiskit.compiler.transpile.md b/docs/api/qiskit/0.40/qiskit.compiler.transpile.md index 0e4a3bcc7d8..2af172819a9 100644 --- a/docs/api/qiskit/0.40/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.40/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.40/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.40/qiskit.converters.ast_to_dag.md index 2aad366d4d2..d69383bf5a9 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.40/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dag.md index 4feea0a45a9..b0de4e02014 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dagdependency.md index 1e567ee1a25..46a0891af60 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_gate.md index dca1b2e68d8..beb2948c541 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_instruction.md index 30931b78b80..4ba61af4d1a 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.40/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.40/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.40/qiskit.converters.dag_to_circuit.md index f13a420f7b3..f8e856ddab8 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.40/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.40/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.40/qiskit.converters.dag_to_dagdependency.md index 647d2503827..b5d5955a010 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.40/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_circuit.md index cdb6a6fe1f2..b40d7999104 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_dag.md index d9b24a128f4..64f03ce9732 100644 --- a/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.40/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.md index ff178b6d025..70bff723d32 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollapser.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser -`BlockCollapser(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollapser(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class implements various strategies of consolidating blocks of nodes in a D -`BlockCollapser.collapse_to_operation(blocks, collapse_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollapser.collapse_to_operation(blocks, collapse_fn)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") For each block, constructs a quantum circuit containing instructions in the block, then uses collapse\_fn to collapse this circuit into a single operation. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.md index 0ea27eb7ae8..0f480a78d4f 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.BlockCollector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector -`BlockCollector(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ In general, there are multiple ways to collect maximal blocks. The approaches us -`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Collects all blocks that match a given filtering function filter\_fn. @@ -50,7 +50,7 @@ Returns the list of matching blocks only. -`BlockCollector.collect_matching_block(filter_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector.collect_matching_block(filter_fn)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Iteratively collects the largest block of input nodes diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.md index 13bc803029a..d25d21dff6d 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops(*, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops(*, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -248,7 +248,7 @@ Mapping\[str, int] -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -258,7 +258,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be staticly known. @@ -283,7 +283,7 @@ int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -291,7 +291,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -315,7 +315,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -337,7 +337,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -345,7 +345,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -361,7 +361,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -369,7 +369,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -389,7 +389,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -397,7 +397,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -405,7 +405,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -419,7 +419,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -427,7 +427,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -435,7 +435,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -443,7 +443,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -451,7 +451,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -471,7 +471,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -483,7 +483,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -504,7 +504,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -512,7 +512,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -520,7 +520,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -528,7 +528,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -549,7 +549,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -557,7 +557,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -565,7 +565,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -573,7 +573,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -581,7 +581,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -589,7 +589,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -597,7 +597,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -613,7 +613,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -626,7 +626,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -634,7 +634,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -642,7 +642,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -650,7 +650,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -660,7 +660,7 @@ Add edges from predecessors to successors. -`DAGCircuit.remove_qregs(*qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qregs(*qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -673,7 +673,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_qubits(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qubits(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove quantum bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -689,7 +689,7 @@ Remove quantum bits from the circuit. All bits MUST be idle. Any registers with -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single node. @@ -718,7 +718,7 @@ The op node that replaces the block. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -734,7 +734,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -744,7 +744,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be statically known. @@ -768,7 +768,7 @@ int -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single operation. qargs, cargs and conditions for the new operation will be inferred from the node to be replaced. The new operation will be checked to match the shape of the replaced operation. @@ -795,7 +795,7 @@ the new node containing the added operation. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -822,7 +822,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -830,7 +830,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -850,7 +850,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -872,7 +872,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -880,7 +880,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.md index 388202e6b04..3a66e03254b 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.md index 5f9cb4a3aa5..c4163021eed 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.md index c01ae8d158d..9d18531b26c 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Replace a block of nodes with a single node. @@ -326,7 +326,7 @@ It is important that such consolidation preserves commutativity assumptions pres -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -334,7 +334,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -354,7 +354,7 @@ List -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -362,7 +362,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.md index aa28a3cb373..f994eef6bce 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.md index 7bef1e4c88c..13c59da06cf 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.md index 7f9f85795fb..c1f117f1230 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.md index 30edf3e38a5..63e063fb756 100644 --- a/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.40/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.md index 32de719c924..a4d0a22ba25 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.40/qiskit.extensions.Initialize.md index bd56ab00cc5..88027e6ce5e 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.md index d280020ae1f..c10522473b0 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.md index 92c4998e5b8..2c487c5b8b8 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.md index 12a96968c46..8bef0385e54 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.md index 3fe670fee26..0ed8decb4ff 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.md index d9e0b5ecd18..16e1e8566e4 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.md index d6e014491de..b8538645b9e 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.md index 30a4c03baf6..c8ba837e900 100644 --- a/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.40/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.md index a7ae52d9bbe..8e9591940b5 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.md index 47086c22c0a..e1a051da997 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.40/qiskit.opflow.anti_commutator.md index e86d190e5a6..0bf60ccbede 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.commutator.md b/docs/api/qiskit/0.40/qiskit.opflow.commutator.md index 6e5fb07c794..de3db2a936b 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.md index 0456cb9f228..b50ddd6ac63 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.md index e523e883979..f69f0b8e7da 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.md index 89d850ea221..b939a7ee84c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.md index b1fd067d35a..fb4275ddb08 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.md index f8678989b8f..fb3f4c405e4 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.md index 48a26ed1dfc..0b6014ef7e3 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.40/qiskit.opflow.double_commutator.md index 49bc33b09d3..57cdee0cd5c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.md index bc2d0ec43fe..6503fc8b132 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.md index 5c1a7c4d2e4..c402166b50d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.md index 988287f5196..4c4692ea9a5 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.md index 71be240cd87..09773cd7848 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 5acd3002e0e..05d6d07b191 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.md index c24f7f74c40..00732188163 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.md index aa15f120663..a4838377415 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.md index 0d2699444e7..2d349b70ef1 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.md index be305bd5371..5d43d7a3e7e 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.md index 3236f7fc463..49b2c765949 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.md index 7ac480f3b1e..55087d2ba78 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.md index 95203092f19..8f9d3257ff2 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.md index f0dd5f714b1..55a07a1ab66 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.md index 422b0f08822..3f267c0ca7f 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.md index 3c83c73b555..655ab3ada51 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.md index c945ea94df6..1545f97490c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.md index edf49889deb..166fd5493a5 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.md index 761a18e157c..4cdfa384744 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.md index 0549fc2ae7a..ad762c30a89 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.md index 3294ac63cb5..20f5ca9281d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.md index 6b7e9407b3b..7424e36b226 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.md index 8d4591e2265..d1f2ccb708e 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.md index 808e372cdf0..ad4fcbaf95c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.md index c9f06c5223a..55fde925d2b 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.md index cbdba232293..a615691da71 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.md index debdbfbda2d..9d39541b757 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.md index 8431a1a737d..0b356164aee 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. @@ -152,7 +152,7 @@ The circuit representation of the composed operator. -`ComposedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.md index d45f5857737..6f515bf905c 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.md index 1b8544b3c88..60cd4821326 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.md index 4c517541af1..8624aea4b18 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. @@ -116,7 +116,7 @@ The circuit representation of the tensored operator. -`TensoredOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.md index 062a69e7163..3804a13b2ad 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.md index c20e731be22..e14ec072d34 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.md index 680201e9cf7..5ef1f586264 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.md index 4ecb200319a..0641d7a6840 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -172,7 +172,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -182,7 +182,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -194,7 +194,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -216,7 +216,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -236,7 +236,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -260,7 +260,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -297,7 +297,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -321,7 +321,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -333,7 +333,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -349,7 +349,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -361,7 +361,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.md index c8fec82620d..7d54734a567 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 181208b7e3d..5763f55a9b8 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.md index b7aef50f839..35d014df5cf 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.convert_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -82,7 +82,7 @@ This method operates the first part of the tapering. It converts the operator by -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -90,7 +90,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -106,7 +106,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -114,7 +114,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -142,7 +142,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.opflow.primitive_ops.Z2Symmetries#convert_clifford "qiskit.opflow.primitive_ops.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.md index 61328732ac2..43e382588be 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.md index 37207aa05e6..3d595d7ba45 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.md index c7d0ae099bc..56a45714f83 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.md index 3b9d59486b8..b0805f42fb1 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.md index b713aea4165..93c72302e73 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.md index 70a5da7a4b5..e1d2a07cd20 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.md index 4f7ff608921..e22f6cd0c1b 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.md index 2880480a49a..30014d312a3 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -96,7 +96,7 @@ Set options values for the estimator. -`BackendEstimator.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.md index d7fc0f78865..8c7184c8302 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -79,7 +79,7 @@ Set options values for the estimator. -`BackendSampler.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.md index 01c32fe8abb..7a4b72db58f 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Close the session and free resources @@ -45,7 +45,7 @@ Close the session and free resources -`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Run the job of the estimation of expectation value(s). diff --git a/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.md index 37519392c28..c897ad5dce7 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -34,7 +34,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Close the session and free resources @@ -42,7 +42,7 @@ Close the session and free resources -`BaseSampler.run(circuits, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.run(circuits, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Run the job of the sampling of bitstrings. diff --git a/docs/api/qiskit/0.40/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.40/qiskit.primitives.Estimator.md index 9aaafb990d9..a6bb0bce788 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -38,7 +38,7 @@ Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "q -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.md index e0929a1e689..0cf195db090 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.40/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.40/qiskit.primitives.Sampler.md index f14c48ceca3..6ddfb1b5ee3 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -39,7 +39,7 @@ Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.md index d07f2dc6672..2a9ca29eeea 100644 --- a/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.40/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.40/qiskit.providers.Backend.md b/docs/api/qiskit/0.40/qiskit.providers.Backend.md index 18e60ad5e81..3ea7b914146 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.40/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.md index 83a8dc76c25..e729579e73a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.40/qiskit.providers.BackendV1.md index 9563703aefa..237d5d813e6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.40/qiskit.providers.BackendV2.md index ff1ae490b38..93cd7e7a5c5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -45,7 +45,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -67,7 +67,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -95,7 +95,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -117,7 +117,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -139,7 +139,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -165,7 +165,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -188,7 +188,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.md index 5d039f69646..26e0d1dea7e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.40/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`BackendV2Converter(backend, name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter(backend, name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -32,7 +32,7 @@ Initialize a BackendV2 converter instance based on a BackendV1 instance. -`BackendV2Converter.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the acquisition channel for the given qubit. @@ -54,7 +54,7 @@ The Qubit measurement acquisition line. -`BackendV2Converter.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the secondary drive channel for the given qubit @@ -82,7 +82,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2Converter.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the drive channel for the given qubit. @@ -104,7 +104,7 @@ The Qubit drive channel -`BackendV2Converter.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the measure stimulus channel for the given qubit. @@ -152,7 +152,7 @@ qubit\_properties -`BackendV2Converter.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.Job.md b/docs/api/qiskit/0.40/qiskit.providers.Job.md index be4d4d20fee..62083094139 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.40/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobError.md b/docs/api/qiskit/0.40/qiskit.providers.JobError.md index 9f780d95c92..5c6fd2ab2dc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.40/qiskit.providers.JobStatus.md index a4b6663259e..9b26c865247 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.40/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.md index 904562b003d..9f09aa4f3a8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.40/qiskit.providers.JobV1.md b/docs/api/qiskit/0.40/qiskit.providers.JobV1.md index 9d3cffe0b57..bdc3e2b9a07 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.40/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.40/qiskit.providers.Options.md b/docs/api/qiskit/0.40/qiskit.providers.Options.md index 40dd58c566b..f7e164034bd 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.40/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.40/qiskit.providers.Provider.md b/docs/api/qiskit/0.40/qiskit.providers.Provider.md index 25a66ac2c3f..045d61a00d4 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.40/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.md index 4cb8cf018b1..67c067e829b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.md index 706d8d392e2..c011e7f8fa5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.md index 4542d93aadb..3deb7c94353 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.40/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.md index 56e1413bf32..46dd3f4e991 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.md index a39510f0233..f0dd6227064 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.md index 964d67a213e..ffd8fa17ec9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.md index 7e3f7048c76..e672d7b7cd1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 004db3ccca5..56d85bbdeed 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.md index e041336f8de..60fc64ba91a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.40/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.40/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.40/qiskit.providers.convert_to_target.md index c46def02bd9..041b625b375 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.40/qiskit.providers.convert_to_target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.convert_to_target -`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 9bbe2efd197..dc7cc2deb12 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.md index 8d594a5d8c7..67f4198c1a1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.md index 97d30fd5936..91014c4d586 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.md index 8c6a1b169dd..9c15bcedeae 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.md index d64672ed455..3e9033f8993 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.md index 593a3f6e1e9..9c773f90b7f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.md index dee5feae2ad..cc46baee0af 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.md index 066bc4f5075..5729c79fa63 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.md index c97fabc05c1..189f65c0400 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.md index 9ef203b53d3..33e6f83dcc1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.md index d7eb853cc50..d95bd1e007d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.md index 24b299479a0..79f13aba2c5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.md index c26723a5361..3c5be60acf1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.md index 22d821f3d25..426c04fae62 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 3cf34405dbc..61e9fb9434a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.md index d841c3560c8..8e691b01277 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.md index f3ea6bf178c..c746d8d770c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.md index 6bc1208ebd3..842c5272a77 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.md index 2bce1cc001b..3ad72bc071c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.md index 75df2efed43..56c46c054b5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.md index c54b5e1a37f..12d14a3736c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.md index 73dfd91f137..4ba003b7b70 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.md index 7da0caa832e..b38fc3fe5c5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.md index c2c68106766..33201891707 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.md index 56dd58ddcfa..00126d23019 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.md index 8baeffee498..afa533c41ed 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.md index 46f12132c29..c64150726b7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.md index 74585894ad8..4d353be6ea9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.md index 9d2149d7e71..64ac18f353c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.md index b334fd24c68..5a87d3ad6d6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.md index d44da06e21e..5e591ea665e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.md index 9214437bbc2..d7be337f41a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.md index 78df172b18b..cc4049a9c96 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.md index ba740afea96..0f564169bf4 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.md index 32d971597b5..a6cdeba49bc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.md index 69d32b8bf80..9c563bc6fd1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.md index 456a82ff4b1..29e7d37a07a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.md index a873bcb8334..aa5e36173e1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.md index f4f37145c8a..5cbfdd63a85 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.md index 026564eb148..c27f858e18c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.md index d1916d4c750..3a1c7448bb8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.md index ffde37f6f60..4350bd3fef5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.md index 2931b4d6e7c..333739c02e0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.md index 5fb7ac2df41..873ee9fc8fc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.md index 8c39eaef396..1108e435f8b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.md index 9d22cfbdaca..33ba9dbbebe 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.md index c349edd6143..63e84021726 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.md index 4555cafdae9..48746e3deb7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.md index e504670663e..325397b38c7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.md index 36eff58cd35..ae8be2ba3d1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.md index e1fc2030837..b7435b776fb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.md index 9821cc122fb..1288fe30eb4 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.md index 96bc87423e4..a44dd7ca968 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.md index 843cbd9b08c..3f550d15adc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.md index 9f2ee0eacbf..60934f4ff6e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index bcee926beda..6d8362d50ab 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.md index b540e939c86..143c29f005e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.md index bb93bb14f02..445be79a2d2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.md index c2b3df68f70..dc5666c7ff3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 1cdd8301ef5..177d8a5de92 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index e2bede2330b..dfb21b83e98 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.md index 8bfc3d057ad..0be75c0191d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.md index ba842fa11a0..3cdc7bdac88 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.md index adff695a4cd..0ec66a3c1fc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.md index 0008e7f2c24..c18ba2a8ee5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.md index e27a9f8070d..09b6a1ecf40 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.md index f352249466e..aea941054b9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.md index ca0e6f34384..07bb2948bcf 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 256a1bf08b1..3c59341eb30 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.md index e2c1bda1b89..1d691024550 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.md index 9fe4b563e54..d4c0500a8a2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index 857824cbe28..955888900a3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.md index 327ea9712dc..809d8828258 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.md index d7631210be5..a30f1b9b00c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.md index e3f9ab018c0..bc65c62494f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.md index 4083d8b5810..7e15127787b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.md index 3224cd37757..5d9ae3f2096 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.md index bda625625e0..bc60803db6c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.md index 07afc5080eb..374ef4f08e3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.md index 83fe3fc50a9..ec7450a3548 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.md index 0a9cda4b1b7..e020b01e98b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.md index 894541fbcd5..765cb88a8e1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.md index 9e48023d5fd..1aaf1207d98 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.md index 9dc4a0cfb9d..9f1d17b999f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.md index 2855f535d10..d57442a45f6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.md index bfd7b52a9c2..d1d29800c84 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.md index 24f19f6c7da..4e7b3691cb4 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.md index d22938870ea..c34a64ee3d2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.md index adbd05d19c8..da9a3ed0678 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.md index f822a7771d4..f5b7d826952 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.md index 9d02a92cff6..3a198a75a40 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.md index ef73876d251..c0186bce3bd 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.md index 1e3538c25c2..527002ac936 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.md index 0b1edf89806..fa7b01ac026 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.md index baf56833f21..394f4357fb6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.md index 57412e8b871..b685c2085bd 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.md index 32513514c60..1d49f3848cc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.md index 9bde741d22a..03ece87de60 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.md index fe6ece2e004..a73e7097d93 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.40/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.md index ac2bb7e4984..d83cba70594 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.AccountProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -73,7 +73,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -134,7 +134,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -158,7 +158,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -196,7 +196,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -221,7 +221,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.md index 9e2f72144f4..5696933d4a8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index d3d7859b636..d986df37b1e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 5645c4c24bd..7040b5ff883 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 2b79453f6ba..f4ce04dc5bb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index ea748b6719a..09a93e6b81f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.md index 3fab47b9099..82186cac087 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index 4ffadf8c93c..4a17d4d7b0a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.md index 66605916fec..3334bb4a3c2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -64,7 +64,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -86,7 +86,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -106,7 +106,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -128,7 +128,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -164,7 +164,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -246,7 +246,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -291,7 +291,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -317,7 +317,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -342,7 +342,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -366,7 +366,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -477,7 +477,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.md index 8f76680a706..1b44a08e8a0 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index d2954ec6fb0..fd69b6ed1dc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.md index f68ab861049..68cc2afa143 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.md index 3cdb81cf57a..b8da8734015 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -90,7 +90,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -140,7 +140,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -209,7 +209,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -225,7 +225,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.md index a38a76dfdee..b3a3cd933dc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.md index 362fb52745c..0b711755a2f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.md index 0f765703d8d..9a6fb649ae6 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -40,7 +40,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -58,7 +58,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -74,7 +74,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -119,7 +119,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -145,7 +145,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -169,7 +169,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -191,7 +191,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -232,7 +232,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -253,7 +253,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.md index b52b29d66b0..de434cd2de8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.md index 4b446849cc4..814bfa0dfc9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.RunnerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -56,7 +56,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -144,7 +144,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.md index fde38e8edaf..0d0b5413ec2 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -59,7 +59,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -71,7 +71,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.md index 211e69d3a91..3703893d197 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 856cff72d1e..6235546f8ec 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 869e3725218..b3a235e13fc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.md index bebdde0ac5f..9091dcf1e63 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 7f6e3e60997..35d375720a5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index c753b9b03fd..0a5ff1c030d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.md index 0e16c129460..4119853fe38 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.md index c0ec62197bf..3abd0382d49 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -62,7 +62,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -88,7 +88,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -154,7 +154,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -170,7 +170,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -205,7 +205,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -260,7 +260,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -292,7 +292,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -316,7 +316,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -340,7 +340,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -365,7 +365,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -389,7 +389,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -415,7 +415,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -497,7 +497,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -524,7 +524,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -546,7 +546,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -574,7 +574,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -619,7 +619,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.md index 0e98ceffabb..3890486708b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.md index 4a087d3fd82..543fb587672 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -91,7 +91,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -109,7 +109,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -145,7 +145,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -161,7 +161,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -189,7 +189,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -205,7 +205,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -233,7 +233,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -249,7 +249,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -265,7 +265,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -285,7 +285,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -305,7 +305,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -327,7 +327,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -351,7 +351,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -369,7 +369,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -431,7 +431,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -451,7 +451,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -469,7 +469,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -497,7 +497,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -517,7 +517,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -533,7 +533,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -557,7 +557,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -582,7 +582,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -622,7 +622,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.md index c7d560a66e7..d3bfa9ccd14 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.md index 0626db0120a..3fd71c70852 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 8ea40cf804d..74ebff3e9fa 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 57a7fc6c085..5d38a428320 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index 0481fda1214..2fd9874cefb 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.md index 45b63ccd381..ab9a3314315 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.job_monitor.md index 4b7ee67e901..e407a59be71 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.job.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.least_busy.md index 29174c48477..9b045aec80e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.least_busy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.md index 9a198d26d89..ddbd2a9b158 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -83,7 +83,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -103,7 +103,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -130,7 +130,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index a6b662fe102..64cce88e50c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 4006a3d0d4e..11e52eaec09 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 4e299221dae..57f826b9283 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index b19ab743224..02872ed993e 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index be41ee3b213..4e0a432bb6d 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 8f1556fcdd5..36bcff386f5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.md index 08ad74c3867..e9c1ab44d0b 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -42,7 +42,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -58,7 +58,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -74,7 +74,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -100,7 +100,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -116,7 +116,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.md index ff5b8bf3438..4665b7e9bf3 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -43,7 +43,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -61,7 +61,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -94,7 +94,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -110,7 +110,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -126,7 +126,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -142,7 +142,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -158,7 +158,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -174,7 +174,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -194,7 +194,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -241,7 +241,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -263,7 +263,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -288,7 +288,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -304,7 +304,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -320,7 +320,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -340,7 +340,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.md index 873c7251ec2..8a4f3f1a245 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -70,7 +70,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -102,7 +102,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -127,7 +127,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -152,7 +152,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -178,7 +178,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 916b4476630..99613bad810 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -94,7 +94,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -115,7 +115,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -140,7 +140,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -163,7 +163,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -181,7 +181,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -200,7 +200,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -228,7 +228,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -252,7 +252,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -291,7 +291,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -313,7 +313,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -342,7 +342,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 045bf20ddc8..892a734ebd4 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -30,7 +30,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.md index 7feeaf688d5..be445fbb65c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -122,7 +122,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.md index 9188f764070..dd32329888f 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index a0885b06940..d5400ad6165 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -42,7 +42,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index b9a1da51d6b..69290448ca5 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -40,7 +40,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.md index 869f5fc84c1..418963c5efc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -71,7 +71,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -88,7 +88,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -100,7 +100,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -116,7 +116,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -132,7 +132,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -156,7 +156,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -182,7 +182,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -198,7 +198,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -225,7 +225,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 942dc83ad8f..03707eaa300 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 91ca5ee1f15..1220a71e9cd 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -77,7 +77,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.md index f95d6bd4118..0dea489a2d1 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.seconds_to_duration.md index 1f138559be6..f005d414fbe 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.to_python_identifier.md index ad186c83b90..fe8ecb9ffe9 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.update_qobj_config.md index 3e2e6e9a4cc..a51e8c95919 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.utc_to_local.md index 161e29c2551..8cfe310b9f8 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.validate_job_tags.md index 6ef795cb48d..4c562c2a072 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.40/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.md index 03d432ab1a9..e597c938891 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.md index 23442453c57..7525fa58c41 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.md index 3e752eebd6e..a437d90d01a 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.Command.md b/docs/api/qiskit/0.40/qiskit.providers.models.Command.md index ff4919d535c..699b19574ae 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.md index d18bea2eda0..36991ea65c7 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.md index efaf5a8685d..b5cced46263 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.md index 3d2327ada84..e4998fa485c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.md index 9cec55a818d..fd21ef280ec 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.md index e11f0ae4e07..9ea71ee1fdc 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.md index ad04506ab73..6b2a53d276c 100644 --- a/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.40/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.md index 2bb3499aca8..6ba40a8b4ba 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -101,7 +101,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -122,7 +122,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -143,7 +143,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -155,7 +155,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -178,7 +178,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -200,7 +200,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -224,7 +224,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.40/qiskit.pulse.Schedule.md index b5ffc39f0ba..c4619232171 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.md index bdad0d68765..da3ee9c3efe 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -166,7 +166,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -192,7 +192,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -217,7 +217,7 @@ Schedule with updated parameters. -`ScheduleBlock.assign_references(subroutine_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_references(subroutine_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign schedules to references. @@ -277,7 +277,7 @@ Schedule block with assigned subroutine. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -339,7 +339,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -372,7 +372,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -403,7 +403,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -443,7 +443,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -468,7 +468,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -480,7 +480,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_referenced()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_referenced()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the current schedule block contains reference to subroutine. @@ -492,7 +492,7 @@ Return True iff the current schedule block contains reference to subroutine. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -504,7 +504,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -526,7 +526,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.scoped_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.scoped_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return unassigned parameters with scoped names. @@ -542,7 +542,7 @@ Return unassigned parameters with scoped names. -`ScheduleBlock.search_parameters(parameter_regex)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.search_parameters(parameter_regex)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Search parameter with regular expression. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire.md index ddea77147e4..0ebbfcbc060 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire_channel.md index 4740c15d574..314c2b2a10b 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.active_backend.md index 70f5c6b76db..b66843c6f16 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 85676e5fbe7..f5400d203e3 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.active_transpiler_settings.md index 8c050eead2a..f32e2b52cba 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_equispaced.md index 2c12f2ce4e7..ca723ee930f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_func.md index ae3661b2c88..8543947e81c 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_left.md index 46e39b38363..446ecd7ff62 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_right.md index 85ad4f1cf25..2194a18b04f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_sequential.md index 32c77294ee5..0ba2a42cf86 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.barrier.md index 7c518c47f59..a2059dfc11f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.build.md index f5a80ba9fb6..af3d3eb6c9b 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.call.md index 289f4989ed7..b8c5778cb1d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.circuit_scheduler_settings.md index 2690f31f73f..ba7787a0be2 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.control_channels.md index f8f0dec1afe..2c96ac58364 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.cx.md index 18cc9c86811..d82c5273f13 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.delay.md index 3bfc0a741ca..217759615b4 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.delay_qubits.md index b0d443000c6..1be65e269f2 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.drive_channel.md index 4cc8985420a..f17619f438a 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.frequency_offset.md index ab753bbf02d..3edc20543db 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.measure.md index 4ae5f943ab5..a36454365cd 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_all.md index 32d745d26a8..9b021c089aa 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_channel.md index b2a6a0b8364..9ccdf20d6b1 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.num_qubits.md index 64db9937675..3ccffe81655 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.phase_offset.md index 554699927d6..621cff23924 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.play.md index 84990b4aaa8..813325930c5 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.qubit_channels.md index 5538e667f20..b083ecfa413 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.reference.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.reference.md index 09565a65d28..9a820a671a5 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.reference.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.reference -`reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.samples_to_seconds.md index 64f1c6dde90..8b0e59f4ba2 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.seconds_to_samples.md index d8ac9114603..69aceaf9319 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.set_frequency.md index 6531e9ad6b4..4197c39af10 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.set_phase.md index 28764fb92a6..d218e291d9d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_frequency.md index b86679ed11d..75f229e5e46 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_phase.md index 78a344c1396..a5382fa3c11 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.snapshot.md index 459cc11755b..de5bad56d6f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.transpiler_settings.md index b86e8ce5c27..f36ee8c6f66 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.u1.md index 70b53383520..362007b9018 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.u2.md index 5689e9208c3..7e7fbc4653f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.u3.md index edd35910dd0..05b3a3e9544 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.40/qiskit.pulse.builder.x.md index 50e44d8ee87..822353f3e65 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.md index 9400a701fcc..45dbcde7a39 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.md index cd5282bfb3f..91f4190a807 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.md index 84992f7a95f..bb41895914b 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.md index e936a32c145..cfe059a17f8 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.md index db97a471ae8..2c7605d2136 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.md index 20a0d97ee87..53e159d873f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.md index 45dfe1c0bec..5b8d7c075c4 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.md index 2191c4ae4c0..8770200a38e 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.md index d3685c1768c..17af2b30b66 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.md index 6abf0349858..b52b069edf0 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.md index e81acb82b14..6d8547af3ef 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.md index 3dcba26e566..ba8067c2437 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") +`Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.md index e8cbe6f7f77..a22211e063c 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") +`RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.md index fc1bb6800f7..05633d42eea 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.md index afb67fae325..2e29282e996 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.md index 45312883111..8f45c1f5c93 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.md index d2346399342..c0fcb16d449 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.md index 9839824acd5..88308e8cb7b 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.md index 1ed2e91bdb3..d5a04eebd09 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") +`TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.md index 29561260fa0..75f005f9614 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.md index 2b6e9dca0a5..22cb3d82c92 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.md index 8a0f7d07ad4..ce0d87d056d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.md index 4a1c157da9e..005a32c32f1 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquareDrag.md index acbc560e389..9534cdce9c7 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.GaussianSquareDrag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.md index 8a9d14e75ed..78c1ab8e881 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.md b/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.md index f0070f1fa30..e2bd0ee7371 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.ScalableSymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse -`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.md index 7b331f5be65..4663901b734 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -161,7 +161,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -188,7 +188,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -200,7 +200,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.md index d2e2833ba34..baf3efa225a 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.40/qiskit.pulse.library.cos.md index 4f10e688a06..c872edb8c0c 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.cos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_deriv.md index d72fd09553d..a6cfa84e80b 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_square.md index 9443df2c001..0fbad854987 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.gaussian_square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.40/qiskit.pulse.library.sawtooth.md index 3302d2d7b3e..c635c6f98ab 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.sawtooth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.40/qiskit.pulse.library.sech.md index 2bfc83e8347..64f99a12b4a 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.sech.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.40/qiskit.pulse.library.sech_deriv.md index a1beed16e39..8170bb0fe73 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.sech_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.40/qiskit.pulse.library.sin.md index 20d23ba6db8..fe643787be3 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.sin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.square.md b/docs/api/qiskit/0.40/qiskit.pulse.library.square.md index a94da2f4f97..f2971a7bd98 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.40/qiskit.pulse.library.triangle.md index 4c3a6253e9c..99875b301f0 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.triangle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.40/qiskit.pulse.library.zero.md index 63ddb1835a4..100b3ca756f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.library.zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.md index ab37294e2c0..d6792e1d865 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.md index 3533b01d489..c0ed60a47f6 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.md index 95dc46fa569..ad052551aec 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.md index 614bbd5203d..363a87257f6 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.md index d126a129ee6..ea5c8a90d41 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.add_implicit_acquires.md index 93ac699254f..aeafc86694d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.align_measures.md index ecb1edc1670..2a797760ccc 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_dag.md index 31b1e46df66..72bf309368d 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_schedule.md index 7e27aedcf7b..c1a9f0f5793 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.compress_pulses.md index df3c3645df8..082a0982735 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.flatten.md index 26a4ecd06e3..cf86924864f 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.inline_subroutines.md index 49a462a6d7e..81572cb8a85 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.pad.md index 2646f0c9e5c..e42a68e50fd 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_directives.md index abba51e324b..89adb88b8da 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_trivial_barriers.md index cd17656eac0..5bb8a1eaa0b 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.40/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.40/qiskit.pulse.transforms.target_qobj_transform.md index f884d7f88df..8bcfb76a998 100644 --- a/docs/api/qiskit/0.40/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.40/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.md index 277a17572f0..730f35d42aa 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.40/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.40/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.40/qiskit.qasm.Qasm.md index 8b967c56cbc..9974221c41a 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.40/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.40/qiskit.qasm.QasmError.md index f46e5034371..76beddf5222 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.40/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.md index 87382e3a5ac..09de69c1c07 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.40/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.md index 28c44e92bb1..cf40a13868f 100644 --- a/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.40/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.md index 589e7c5f277..c882791084f 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.md index 2f24a336726..28a0da5e4b5 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.md index 11d6ef7a31b..57489fa5b4f 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.md index d2cf0167942..bdea2468934 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.md index 8c903a06dea..601a1532fd3 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.md index c5fbe60c869..eb81f8b2d05 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.md index b04251e571f..f2c28cffba8 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.md index d86cb15111f..ee37d0324d1 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.md index 99ccd488add..ff2b6087515 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.md index 3e51cfeecc5..37dfd6e29c9 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.md index 7c26e8cd34b..e31126b3359 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.md index 3c0e32aab9f..d4d925d48b4 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.md index ed61b696cc7..b949164483d 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.40/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.40/qiskit.qobj.Qobj.md index 3d0ab5f74d3..479ab7575c7 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.md index 798b1649b61..4b990e1c902 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.md index 4004a4d4b68..f34a4e4b725 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.md index 7d0288e4291..40c29287b13 100644 --- a/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.40/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.40/qiskit.qpy.dump.md b/docs/api/qiskit/0.40/qiskit.qpy.dump.md index fe1c9056406..c39d85fd2d8 100644 --- a/docs/api/qiskit/0.40/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.40/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.40/qiskit.qpy.load.md b/docs/api/qiskit/0.40/qiskit.qpy.load.md index 7df78086f70..52bfb57c427 100644 --- a/docs/api/qiskit/0.40/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.40/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.md index f96d196e511..10071011251 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.md index 91c327f32eb..5c3eb978bfe 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.md index d212d17052e..59f643470c3 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.md index 1ad2e9f56a4..6a31cbb379b 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin`, [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -123,7 +123,7 @@ Return the conjugate of the Clifford. -`Clifford.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Make a deep copy of current operator. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`classmethod Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_labels(array=False, mode='B')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_labels(array=False, mode='B')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert a Clifford to a list Pauli (de)stabilizer string labels. @@ -437,7 +437,7 @@ list or array -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -445,7 +445,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -453,7 +453,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.md index 50cfbc83179..cf09b1ee06f 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -600,7 +600,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -608,7 +608,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -635,7 +635,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.md index 4542b246e39..b8ebdf08ef0 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.md index 3abf9fd282e..39def6002c6 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -72,7 +72,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. @@ -92,7 +92,7 @@ tuple -`OneQubitEulerDecomposer.build_circuit(gates, global_phase)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.build_circuit(gates, global_phase)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the circuit or dag object from a list of gates. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.md index 2206cf56c8b..f93d1b2cfd8 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -202,7 +202,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -238,7 +238,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -254,7 +254,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -304,7 +304,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -322,7 +322,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -348,7 +348,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -356,7 +356,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to NumPy matrix. @@ -364,7 +364,7 @@ Convert operator to NumPy matrix. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -372,7 +372,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.md index c2e255b98af..dd8e7406ee1 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.md index 21b8cce21d7..a1fb315b744 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.md index ac85fb782f6..2c6fda58c9c 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.md index 2deff1d17db..7502b1cf412 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -582,7 +582,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -622,7 +622,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -651,7 +651,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -681,7 +681,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -689,7 +689,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.md index dadfbb98453..f5cfe627ee4 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.md index 3eb55199958..4c33d364797 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.md index 83967a82b4a..6d1dfcea294 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -74,7 +74,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -82,7 +82,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return indices for sorting the rows of the table. @@ -152,7 +152,7 @@ array -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -176,7 +176,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -208,7 +208,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -249,7 +249,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -270,7 +270,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -292,7 +292,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -330,7 +330,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -358,7 +358,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -405,7 +405,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -448,7 +448,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -469,7 +469,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -487,7 +487,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -567,7 +567,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -588,7 +588,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sort the rows of the table. @@ -661,7 +661,7 @@ a sorted copy of the original table. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -689,7 +689,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -715,7 +715,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -737,7 +737,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -757,7 +757,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -765,7 +765,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.md index 79887299f03..2e195282891 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.md index 0b597618db1..bba7aa75c71 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -632,7 +632,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -672,7 +672,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -705,7 +705,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -747,7 +747,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.md index dbdcb1b3acc..3453c8fc600 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -118,7 +118,7 @@ sv.draw(output='hinton') -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -144,7 +144,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -169,7 +169,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -193,7 +193,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -214,7 +214,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -240,7 +240,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -268,7 +268,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -301,7 +301,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -325,7 +325,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -357,7 +357,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -455,7 +455,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -463,7 +463,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -487,7 +487,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -567,7 +567,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -591,7 +591,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -662,7 +662,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -670,7 +670,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.md index dde447577d0..72ce3cba3df 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.md index 20bc3a33619..2b70ab59c54 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 2eb121a3e84..ed30b833e35 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.md index 4502672b04e..41008b55f09 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.40/qiskit.quantum_info.average_gate_fidelity.md index 68b7ee87ff1..4c634359363 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.40/qiskit.quantum_info.concurrence.md index 462b4510c77..8fbb8ebd566 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.40/qiskit.quantum_info.decompose_clifford.md index 15a58126750..a327506a102 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.40/qiskit.quantum_info.diamond_norm.md index 4936b0ed129..0a3fbe5a1d2 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.40/qiskit.quantum_info.entanglement_of_formation.md index fb3690b3339..e12c9da1c4d 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.40/qiskit.quantum_info.entropy.md index 4db0623c210..0a1ce28209c 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.40/qiskit.quantum_info.gate_error.md index bd50ef1b1f3..b0d21e55214 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_distance.md index d112e6e18eb..0b3ee96fc38 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_fidelity.md index e42f1e60347..5541b159c90 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.40/qiskit.quantum_info.mutual_information.md index 78bd05e08b2..0647dd165d7 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.40/qiskit.quantum_info.partial_trace.md index a5270830cd9..13b64aed669 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.40/qiskit.quantum_info.pauli_basis.md index 924486e0a87..ed47b8fc384 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.40/qiskit.quantum_info.process_fidelity.md index a8b83a95f9e..25f867150b4 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.40/qiskit.quantum_info.purity.md index 721d246209e..ca8b1cf76b4 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_clifford.md index d780529e235..e02d97989f7 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_cnotdihedral.md index 593d64f4d0f..77349e50bcc 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_density_matrix.md index 3ca0fd49e5d..058d667a5ce 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_hermitian.md index 84fc7189411..d16fcf9868f 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli.md index d0919d4f951..dece2d04e34 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_list.md index 6574676d30e..7354dc4c3b8 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_table.md index 72695d21f9b..80697d3de2e 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_quantum_channel.md index 8e68bd61b9f..e5576b9adf9 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_stabilizer_table.md index 0169f9727cb..2e7fefffb9d 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_statevector.md index cce3ed138ff..2fea823b9be 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.40/qiskit.quantum_info.random_unitary.md index e80e975f973..c1c9cd87c14 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.40/qiskit.quantum_info.shannon_entropy.md index 9f2d208b746..12664888216 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.40/qiskit.quantum_info.state_fidelity.md index 4d84e302629..13e96697dbe 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.md index 92980da2fff..1df3c2c2df0 100644 --- a/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.40/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.md index e90496ce5bb..045f1b24e9a 100644 --- a/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.40/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.40/qiskit.result.Counts.md b/docs/api/qiskit/0.40/qiskit.result.Counts.md index 7c496d84975..d5163fdefe4 100644 --- a/docs/api/qiskit/0.40/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.40/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.md index 3a5c5fe1cb8..107c90ab6d4 100644 --- a/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.40/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.md index 8152f25e4ab..5f43730ad42 100644 --- a/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.40/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.md index e6d5af563d4..335a080d578 100644 --- a/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.40/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.40/qiskit.result.Result.md b/docs/api/qiskit/0.40/qiskit.result.Result.md index 20b6e521d37..5f2f2755888 100644 --- a/docs/api/qiskit/0.40/qiskit.result.Result.md +++ b/docs/api/qiskit/0.40/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.40/qiskit.result.ResultError.md b/docs/api/qiskit/0.40/qiskit.result.ResultError.md index 5bdc8f10cc3..c895b528a26 100644 --- a/docs/api/qiskit/0.40/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.40/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.40/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.40/qiskit.result.marginal_counts.md index 1d92d6fa354..a00214b1d87 100644 --- a/docs/api/qiskit/0.40/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.40/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.40/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.40/qiskit.result.marginal_distribution.md index 50fc45b68a3..ab34cd0bfd6 100644 --- a/docs/api/qiskit/0.40/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.40/qiskit.result.marginal_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.40/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.40/qiskit.result.marginal_memory.md index 90da19986ed..82f3e3cbe6e 100644 --- a/docs/api/qiskit/0.40/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.40/qiskit.result.marginal_memory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.40/qiskit.result.sampled_expectation_value.md b/docs/api/qiskit/0.40/qiskit.result.sampled_expectation_value.md index 9ae734e4bf5..9f4f50b50ad 100644 --- a/docs/api/qiskit/0.40/qiskit.result.sampled_expectation_value.md +++ b/docs/api/qiskit/0.40/qiskit.result.sampled_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.sampled_expectation_value -`sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") +`sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.md index 7c9c0f199da..41a349955d8 100644 --- a/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.md index 26150641b6f..b5b75ccec28 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.md index e8c9f0fc2ef..585dea0de89 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.md index c6465577a9b..5b6cd42fe7b 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.md index a4bf83b6681..286f6aa5327 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.md index 7cc7e996aa4..2b0829e406b 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class is called recursively by the transpiler pass, which is why it is sepa -`SolovayKitaevDecomposition.find_basic_approximation(sequence)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.find_basic_approximation(sequence)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Finds gate in `self._basic_approximations` that best represents `sequence`. @@ -48,7 +48,7 @@ Gate in basic approximations that is closest to `sequence`. -`SolovayKitaevDecomposition.load_basic_approximations(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.load_basic_approximations(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Load basic approximations. @@ -72,7 +72,7 @@ A list of basic approximations as type `GateSequence`. -`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Run the algorithm. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.md index 9db1cf42d23..1d5c0ae9fc0 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_ag.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_ag.md index 7ecda249dd0..e1aaae1c985 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_ag.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_ag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_ag -`synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_bm.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_bm.md index a1d81910e85..6d3cd19f73a 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_bm.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_bm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_bm -`synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_full.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_full.md index 2c745f2343a..9e8959acf90 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_full.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_full.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_full -`synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_greedy.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_greedy.md index 194d1106e23..e32855558e8 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_greedy.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_greedy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_greedy -`synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_layers.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_layers.md index 6c2b345a32e..b0e2f450f13 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_layers.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_clifford_layers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_layers -`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of \[1]. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_count_full_pmh.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_count_full_pmh.md index 9251417036d..e86465eaed4 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_count_full_pmh.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_count_full_pmh.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnot_count_full_pmh -`synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") +`synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_depth_line_kms.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_depth_line_kms.md index 98544e67b8d..db55fc4f16c 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_depth_line_kms.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnot_depth_line_kms.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnot_depth_line_kms -`synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_full.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_full.md index 15db6e4a8a9..98c049b1a55 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_full.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_full.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_full -`synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_general.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_general.md index 24d2abc96ce..aa69990e9b1 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_general.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_general.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_general -`synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_two_qubits.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_two_qubits.md index c8537d21d00..e4bf92ecdf6 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_two_qubits.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_cnotdihedral_two_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_two_qubits -`synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_acg.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_acg.md index 81998640617..1d1c0f22a07 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_acg.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_acg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_acg -`synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_basic.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_basic.md index bfee99f7bb3..d69f554b049 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_basic.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_basic.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_basic -`synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. diff --git a/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_depth_lnn_kms.md b/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_depth_lnn_kms.md index ddbf659d603..9a3383f7897 100644 --- a/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_depth_lnn_kms.md +++ b/docs/api/qiskit/0.40/qiskit.synthesis.synth_permutation_depth_lnn_kms.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_depth_lnn_kms -`synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.40/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.40/qiskit.tools.backend_monitor.md index 8f375df262c..1ddce8a7a59 100644 --- a/docs/api/qiskit/0.40/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.40/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.40/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.40/qiskit.tools.backend_overview.md index ae943e14bf9..ac23d602074 100644 --- a/docs/api/qiskit/0.40/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.40/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.md b/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.md index 60bde9bf4f9..e18b1653f3b 100644 --- a/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.md +++ b/docs/api/qiskit/0.40/qiskit.tools.events.TextProgressBar.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.events.TextProgressBar -`TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Bases: `qiskit.tools.events.progressbar.BaseProgressBar` @@ -70,7 +70,7 @@ Run when progress bar has completed. -`TextProgressBar.start(iterations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.start(iterations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Start the progress bar. @@ -134,7 +134,7 @@ Unsubscribe a pair event-callback, so the callback will not be called anymore wh -`TextProgressBar.update(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.update(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Update status of progress bar. diff --git a/docs/api/qiskit/0.40/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.40/qiskit.tools.job_monitor.md index d5eab415f1d..71d4758982b 100644 --- a/docs/api/qiskit/0.40/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.40/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.40/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.40/qiskit.tools.parallel_map.md index 1ba7ea05678..b36d87976cc 100644 --- a/docs/api/qiskit/0.40/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.40/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.md index 01e7684f560..1c45c1a75dd 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.md index b8ed6c8a159..2d8adbffb78 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.md index c57c7beaa47..e72248e6d59 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -108,7 +108,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -120,7 +120,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -132,7 +132,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -157,7 +157,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -182,7 +182,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -204,7 +204,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -216,7 +216,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -228,7 +228,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -244,7 +244,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -254,7 +254,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -262,7 +262,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -270,7 +270,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -280,7 +280,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -304,7 +304,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -329,7 +329,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -337,7 +337,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.md index 7d7c7964781..72ec446a408 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.md index 61563412856..3bff2984c83 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.md index d1cebbf5482..e9a90ddaab3 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.md index 60c8a1ace31..a7f11da6240 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.md index 0ee681ef048..5551484296c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.md index e70f16f17b4..a85be55c5a5 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.40/qiskit.transpiler.Layout.md index aec70a2f0a1..14964a123a5 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit. @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.md index 6e348546fac..31111124cb2 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. @@ -194,7 +194,7 @@ The transformed circuit(s). -`PassManager.to_flow_controller()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.to_flow_controller()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Linearize this manager into a single [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController"), so that it can be nested inside another [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.md index 2a39e258f7f..cbf0a9d6c9d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.md index 7b3bf1e21fb..01dfb47fd6c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.md index e7bde6da268..91589b1f0fe 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.Target.md b/docs/api/qiskit/0.40/qiskit.transpiler.Target.md index 83ad12c4808..8335d4bf32a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -136,7 +136,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -165,7 +165,7 @@ for this target. If there are no connectivity constraints in the target this wil -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -189,7 +189,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -211,7 +211,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -251,7 +251,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -267,7 +267,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -308,19 +308,19 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -340,7 +340,7 @@ The Instruction instance corresponding to the name. This also can also be the cl -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -364,7 +364,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -388,7 +388,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -408,7 +408,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -424,7 +424,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -463,7 +463,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -481,7 +481,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.md index b3311265ad7..d0460a05000 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.md index 29397d4512e..e69533bbb3e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.md index b7b747e5dac..8c9e8295a97 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.md index 59f494ffa32..dbb7b9a8767 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ACGSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation -`ACGSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`ACGSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"acg: {qct.size() = }, {qct.depth() = }") -`ACGSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`ACGSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.md index 2e3b1ecf22a..e93944c4342 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index c7a5f92d706..ea147fb7acd 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.md index 46d46e4b721..6fc7ce5a907 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index f5aa9f097b4..b22f0a9ea6e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.md index 845d19175fd..b9f8c655973 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.md index 8cf3523dd09..bcf0526bd9f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.md index 32439b51fa6..693247ec22a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 69e1d864cd7..35dc0299028 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.md index 990f47be323..e342a320e18 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.md index 232c3735abe..c9b1cb0faee 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasicSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation -`BasicSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`BasicSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"basic: {qct.size() = }, {qct.depth() = }") -`BasicSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`BasicSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.md index c1903025a90..07b56710424 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.md index e1799c68b4d..b3ce0a7e154 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.md index c6da41a4cb8..8b4573e4095 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.md index 4f5b996a7bd..941a9d1df72 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.md index 6a13f74c626..18947416521 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.md index c0d427193ff..417fb39de05 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.md index 734b1c13232..95f37340c7a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.md index 96b384f9e91..48f07fb44fc 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.md index 39e06123f91..93fcd5f6b6a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.md index 28504c2a6a6..18d0192a47f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectAndCollapse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse -`CollectAndCollapse(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") +`CollectAndCollapse(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CollectAndCollapse.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") +`CollectAndCollapse.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.md index 95bfe86f3e7..143a93fe3ed 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.md index dbf672a7d46..fa2970a57c9 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.md index b00674be2b8..47f5f9b43f5 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.md index e82a960ed69..38eacf2c366 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.md index 687cceab07e..855f64ef4bb 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.md index b645f918dc1..1a630c74482 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CommutativeInverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Run the CommutativeInverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.md index 9fcde788733..086150dc013 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -92,7 +92,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -118,7 +118,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.md index ac98e454891..3ae9e41b527 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.md index b2996b923a7..6de96092f47 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.md index bb0a6a7e261..8a6f1c504e6 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(instruction_name, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(instruction_name, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 2b0445928bc..3d0fed2a85d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ConvertConditionsToIfOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.md index 24153ce7fd6..0f4823aa9a1 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.md index 82f8ffd2890..d30d7b390e1 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index d12bbe32b93..8a78c0ae9fe 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.md index ada5bb2b01f..ebf2655234e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.md index 6c031c6c758..1d62e001b9e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.md index 71a9e9e3d33..d961a155323 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.md index 67cb56d7a6b..7898f248bf4 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.md index 4090dc1b76f..dd1cc7c64d6 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.md index 5b29e1c49ac..895bf95604e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -100,7 +100,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 3b38a4c450f..57e48f3d8ec 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.md index b957cc8f92a..992916723a1 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.md index 40f2ff0ebc2..5d281273b2c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.md index 2189ad9f1a5..0e2d84bfdb6 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.md index 196c151ac92..3797351bb05 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.md index 9320420c64f..db2870a6858 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.md index c47de4326d1..c958afbfee7 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`HighLevelSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run the HighLevelSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.md index 305486d0d0f..81ff05a6a62 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.md index 0d79135232d..c139ee26726 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.md index 542209b6847..2325be9ec36 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.md index f0a0084a78d..023af163b4c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.KMSSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation -`KMSSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`KMSSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -43,7 +43,7 @@ print(f"kms: {qct.size() = }, {qct.depth() = }") -`KMSSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`KMSSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.md index ca74ca67b4e..7d16dae6a5e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index e58d7e51aa9..e0203a9fee0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 0e941d8d9e6..a4829829d5b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.md index 1864eea3199..f7c3608eb76 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 65666f25189..c230cd4e93a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index de45437444d..fd5ff86a3c3 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.md index ca00260f50d..be25890ba40 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.md index f06ef2692a9..895b23e352d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 323bb4c6971..17913f7772d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index cdb89beeeb9..078d5a08ca5 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.md index 550684b2578..6b79a03ebf0 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`OptimizeCliffords.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Run the OptimizeCliffords pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.md index 1a5fbf4d4f4..e807df0bf6d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 83dc404499b..1a08d058c80 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.md index 52516d51c0d..04bd9d6fff3 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 028009112cc..772f08f5b66 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -69,7 +69,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") A builder macro to play stretched pulse. @@ -115,7 +115,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index dc933889fd9..a08808a1d03 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.md index a8cb1ab7aa5..f04cb5d535e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index f7be66080e1..66e85cf41ed 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.md index ee3a43885ec..6fc40af2574 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.md index 44d7f6dd71b..65bfefda67d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 860f3b34919..fecd5772a73 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ResetAfterMeasureSimplification.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Run the pass on a dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.md index eb3e36b5d62..d811c9b9abf 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.md index 3d71dcb3ad1..b9d71d4197a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -90,7 +90,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.md index 465dcc939e1..146cceb5cfe 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.md index af55e1faf61..411bb0252a1 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.md index c07b8b5bc77..cccb5928bde 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.md index 96ffead8c02..98349591a9e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -107,7 +107,7 @@ Return the name of the pass. -`SolovayKitaev.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run the `SolovayKitaev` pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index da3fdb354f1..2955f9d148b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -44,7 +44,7 @@ The number of times the decomposition is recursively improved. If None, defaults -`SolovayKitaevSynthesis.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.md index 19b0f4ee58c..0f50785342a 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.md index 185337b2581..57856f53189 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.md index c4dfe0bbd72..c28e5ad4f64 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.md index 81a007a7f6b..6d62effca24 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -87,7 +87,7 @@ Return the name of the pass. -`TranslateParameterizedGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Run the transpiler pass. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.md index f1af0f14b1c..c806187a689 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.md index 3eaffbdc737..f9b5689de79 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on `dag`. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.md index c87f7fb0563..6d129e33194 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.md index fa05395e7ae..afc79925d0c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.md index 84c61bf79af..e45545cc668 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.md index 3092315c2b5..f65576eaf3f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -66,7 +66,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.md index a75552dfac1..e003368cf7c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.md index d190bc870bf..5b335b7cb06 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.md index 19873d0bd78..dbe275e60ff 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 9a52ea85f26..b01c3684350 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for high-level synthesis plugins. -`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given Operation. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index af10d36ed2c..d7415a3a075 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Class tracking the installed high-level-synthesis plugins. -`HighLevelSynthesisPluginManager.method(op_name, method_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method(op_name, method_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns the plugin for `op_name` and `method_name`. @@ -30,7 +30,7 @@ Returns the plugin for `op_name` and `method_name`. -`HighLevelSynthesisPluginManager.method_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns plugin methods for op\_name. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 2cf4289ae62..c1d11823144 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 15399e0b525..25de05436cb 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 462219d3000..d67a884247f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md index b961b11ed3d..1289536654c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_control_f -`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md index 3577f57d722..2678d3cea07 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_embed_pas -`generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md index 50b0183bcc7..8709024f9ec 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_error_on_ -`generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md index 3046853434f..63a0d72b1af 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_pre_op_pa -`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md index c857d4369c4..342cccf7247 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_routing_p -`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md index 9305e8bbe94..fd4e089c291 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_schedulin -`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md index ee1cf236416..40d90559d25 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_translati -`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md index 51818ed723a..cb58578454c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q -`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 7aea9ae57c8..60ca848fb50 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index a0dda418fd9..e0579ef614b 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 38cca4e2f22..2f1ea5e7360 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 39231c12d04..5ac56445836 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 41c2dc88a0c..ce5f111daab 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 0080a0e8f7c..5855105eb0e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ A `PassManagerStagePlugin` object can be added to an external package and integr -`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index aa63be7fc5a..a995d332298 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Manager class for preset pass manager stage plugins. -`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a stage diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md index 5a9675b4640..aa138691116 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins -`list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.md index 76d9428b676..98789b1cc3d 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 3265c21d977..4dce5d70fc7 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index aacee5eda05..4f92ba0bd5c 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 0554e706307..5890367487f 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 99c73eef2c5..b164f7cfdd5 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 1f5c277f498..32ffac2995e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 95a96991071..ff92c7f410e 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index 6771c2c1d2f..c4bb79bda70 100644 --- a/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.40/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ Implementation of objective function and gradient calculator, which is similar t -`FastCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the gradient of objective function. See description of the base class method. @@ -39,7 +39,7 @@ Computes the gradient of objective function. See description of the base class m -`FastCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. diff --git a/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.md index 13a7db21a1d..15ac8b68196 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.40/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.40/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.40/qiskit.utils.apply_prefix.md index 18e4bc1cafd..8b1ba545b00 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.40/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.40/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.40/qiskit.utils.deprecate_arguments.md index 48db8a0fa56..5dd443b550d 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.40/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.40/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.40/qiskit.utils.deprecate_function.md index 26966ec6081..23238733546 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.40/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.40/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.40/qiskit.utils.detach_prefix.md index a0c0354e4ab..7a741d8468c 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.40/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.40/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.40/qiskit.utils.get_entangler_map.md index eb57125b4f7..fc664fd00b1 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.40/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.40/qiskit.utils.has_aer.md b/docs/api/qiskit/0.40/qiskit.utils.has_aer.md index ee3848bebff..8a189fa5680 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.40/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.40/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.40/qiskit.utils.has_ibmq.md index 63a48b4f364..4b6b1df9958 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.40/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.40/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.40/qiskit.utils.is_main_process.md index a77586ad017..da0011a1c2d 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.40/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.40/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.40/qiskit.utils.local_hardware_info.md index d52fb33fc04..6243359925a 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.40/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.md index 58df10dae46..9e31829a9f8 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.40/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.md index 3652cadf5e8..72b3ee82603 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.40/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. @@ -81,7 +81,7 @@ The on-diagonal elements of the calibration matrices are the probabilities of me -`TensoredMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.40/qiskit.utils.name_args.md b/docs/api/qiskit/0.40/qiskit.utils.name_args.md index 6be1349c741..3b90eb8825c 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.40/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.40/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.40/qiskit.utils.summarize_circuits.md index 0b1d9a1e7bf..f463de57651 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.40/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.40/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.40/qiskit.utils.validate_entangler_map.md index a1e0f8b0677..bb379d3cb7d 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.40/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.40/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.40/qiskit.utils.wrap_method.md index 5fa0d0601de..e860c3ce79d 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.40/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.md index d9c3c13769e..aa7eea04a46 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.40/qiskit.visualization.array_to_latex.md index 8f5384af8ba..71527502656 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.40/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.40/qiskit.visualization.circuit_drawer.md index 94466289708..6b9965016ab 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.40/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.40/qiskit.visualization.dag_drawer.md index ac87119f4d6..6aad3c07747 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.40/qiskit.visualization.pass_manager_drawer.md index 3eeac3b5ed3..323213b421b 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_multivector.md index 980997ffed0..28bca83dccd 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_vector.md index 292a7304775..0e3cbaa6dc0 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_circuit_layout.md index 0c9eb90c141..64e5fd16951 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_coupling_map.md index 093d87c15d4..343a3ae5ec6 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_distribution.md index e394e2d266a..d486a7b12f3 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_distribution -`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") +`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_error_map.md index 8f755cbec4b..c6f123d04f6 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_gate_map.md index 6cfa17c64d9..e22b7ec0912 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_histogram.md index 80855cfddd0..12482295a0d 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_city.md index b1656f5caf2..91ced378c17 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_hinton.md index 99bd7883d98..d39afe0d7ed 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_paulivec.md index e735949b8f1..0589c4c58f7 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_qsphere.md index d1d502d3534..8766f6fa840 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.md index 4be541bcafe..10061567376 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.md index 0abf720b463..156b4f2baef 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.md index 192b14169dd..fdfbccc9883 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.md index 02cf563453c..e377904c072 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.40/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.40/qiskit.visualization.visualize_transition.md index 321fbb35f33..797171e5b42 100644 --- a/docs/api/qiskit/0.40/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.40/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.40/qiskit_aer.AerError.md b/docs/api/qiskit/0.40/qiskit_aer.AerError.md index 5f4c2607a79..91244a10699 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.AerError.md +++ b/docs/api/qiskit/0.40/qiskit_aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.40/qiskit_aer.AerProvider.md b/docs/api/qiskit/0.40/qiskit_aer.AerProvider.md index 4f6b0e4db92..77c9fa9340c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.AerProvider.md +++ b/docs/api/qiskit/0.40/qiskit_aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.md b/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.md index 47bc8a665dc..9cde92150bd 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.md +++ b/docs/api/qiskit/0.40/qiskit_aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -205,7 +205,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -213,7 +213,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -263,7 +263,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -271,7 +271,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -359,7 +359,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.md b/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.md index 7fcf1526bba..3d25707435b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.md +++ b/docs/api/qiskit/0.40/qiskit_aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.md b/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.md index 41467bd0e1c..8f2f21730ab 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.md +++ b/docs/api/qiskit/0.40/qiskit_aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.md b/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.md index 32eeaabdfc3..d59c192ceaf 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.40/qiskit_aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.md b/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.md index 1f06420d096..c87ff1ea1f7 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.40/qiskit_aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.md b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.md index db313fa15b5..cdf53e9e60e 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.md b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.md index 36f087d4664..6249b146be1 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.40/qiskit_aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.md index a6a3c1ee847..3457e924414 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.md index dbe9b362161..b16ed6fca93 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.md index 61c035747e2..a553e3e4af3 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.md index a97970dec60..68c04471132 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.md index 4f170429cb8..fbbc9be197e 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.md index b65cc654c01..f601397e76f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.md index ff45c0c06ee..10cfc651eec 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.md index 750f4dfb595..8509eeeea01 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.md index 24aaefbd1fd..3863e28f4ab 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.md index 9e4d612450f..a74c3cc3d87 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.md index cb8857d14a2..3f8b64809d4 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.md index 323c863b155..bc75412a401 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.md index aa18c03bbdf..2526eefb249 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.md index d9ad2d95fc5..455d9f2e07c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.md b/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.md index da93367d185..1a2a5efa681 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.md index f3fc262661e..4f540720c71 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.md index 095d26f3275..538b8e1ce0c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.md b/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.md index 26b4d86aeea..a0fec10f158 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.md b/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.md index b79415d8eb7..565a4c97f7a 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.md b/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.md index a1818ec75a6..c373d432109 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.md b/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.md index 590a0694967..de590aa0a79 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes.md index 390115a92e8..ec1b668c7c4 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes_squared.md index c6e631fd67a..82d8c10578c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_clifford.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_clifford.md index a15ce90d970..3545ea80cb0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_clifford.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_density_matrix.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_density_matrix.md index c5bf046d92e..2afcf6cbd81 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value.md index 83f3756753a..4eb728318a6 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value_variance.md index e0c48040e8b..06e3e06dc46 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_matrix_product_state.md index fc4efa9230c..3ec3e9646c5 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities.md index 3f917fa6387..95c6cffa69a 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities_dict.md index d554184bcd8..d6cb284ec4e 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_stabilizer.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_stabilizer.md index 012a26267e4..e0cb79acf70 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_state.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_state.md index b58f26be497..6254b7409a8 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_state.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector.md index f6638818b12..d8bd261964f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector_dict.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector_dict.md index 9b4deb5fb70..010dcaf80d0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_superop.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_superop.md index 4bed5d00e43..ef47af6761f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_superop.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.save_unitary.md b/docs/api/qiskit/0.40/qiskit_aer.library.save_unitary.md index fd8a0373bab..ded625276b0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.save_unitary.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.set_density_matrix.md b/docs/api/qiskit/0.40/qiskit_aer.library.set_density_matrix.md index 2938daa4809..6fedfb63299 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.40/qiskit_aer.library.set_matrix_product_state.md index a8c1135644e..ba41900f2b0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.set_stabilizer.md b/docs/api/qiskit/0.40/qiskit_aer.library.set_stabilizer.md index 690a1072521..f291fd9fa05 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.set_statevector.md b/docs/api/qiskit/0.40/qiskit_aer.library.set_statevector.md index 41e1bce3a7c..91728cb7f66 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.set_statevector.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.set_superop.md b/docs/api/qiskit/0.40/qiskit_aer.library.set_superop.md index 48988d8ec8c..fcbccc6a02f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.set_superop.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.library.set_unitary.md b/docs/api/qiskit/0.40/qiskit_aer.library.set_unitary.md index e6f8fd9c84e..c3a15022d7e 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.library.set_unitary.md +++ b/docs/api/qiskit/0.40/qiskit_aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.md index c1b8d94266e..50ecacefd0b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.md b/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.md index 2952b33e4f2..92dd77570e5 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -265,7 +265,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -289,7 +289,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -297,7 +297,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Reset the noise model. @@ -305,7 +305,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.md b/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.md index c81f1308985..1db3c8d7e4b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -129,7 +129,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -154,7 +154,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -176,7 +176,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -250,7 +250,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -258,7 +258,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -266,7 +266,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -292,7 +292,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -300,7 +300,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -308,7 +308,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.md b/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.md index 473f00da065..bf79429206c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.md index cf2c6e6cba9..b983d9d944c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.amplitude_damping_error.md index 060dec129a3..4feddbe5752 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.coherent_unitary_error.md index f90a1a068c5..5f375e4118e 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.depolarizing_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.depolarizing_error.md index 682b4c35050..1a855f9520d 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_gate_errors.md index bbb6ff34ecf..839935cebc7 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return QuantumErrors derived from either of a devices BackendProperties or Target. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_readout_errors.md index 036856d7afc..5ec67050a9a 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return readout error parameters from either of device Target or BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_error_values.md index 995c5adf824..4e229d33a5a 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_length_values.md index c7985d8a231..5adc8d2bc1d 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_param_values.md index 9a03c869835..4b68d14dcb0 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.readout_error_values.md index 9e7cd14a25f..54ed50271bf 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.40/qiskit_aer.noise.device.thermal_relaxation_values.md index 4315386aea1..9a514b55877 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.kraus_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.kraus_error.md index 1d5fb16a3df..2c1fd8347bb 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.mixed_unitary_error.md index 134d564711e..fade2783f7b 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.pauli_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.pauli_error.md index b4e9f01faec..75a2282158c 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.phase_amplitude_damping_error.md index 70ced555d78..930337b8f4f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.phase_damping_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.phase_damping_error.md index 2dadfc13527..c686b920614 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.reset_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.reset_error.md index 955de63ad01..68b38e7ce57 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.reset_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.40/qiskit_aer.noise.thermal_relaxation_error.md index 52d4dc7edcd..a131331ef50 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.md b/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.md index e997121e9b8..70c818af1d5 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.md +++ b/docs/api/qiskit/0.40/qiskit_aer.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -49,7 +49,7 @@ Aer implmentation of Estimator. -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.md b/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.md index 1a3544818de..6a6e3073af1 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.md +++ b/docs/api/qiskit/0.40/qiskit_aer.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -45,7 +45,7 @@ Aer implementation of Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.md index 1f9c2bb1d0c..3df65cca226 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.40/qiskit_aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.40/qiskit_aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.40/qiskit_aer.pulse.duffing_system_model.md index ea9d60c65fd..7bd6f1f4889 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.40/qiskit_aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.md b/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.md index 53242af5d60..364312a4f3a 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.md +++ b/docs/api/qiskit/0.40/qiskit_aer.quantum_info.AerStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector -`AerStatevector(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector(data, dims=None, **configs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") @@ -38,7 +38,7 @@ The `dims` kwarg is used to `Statevector` constructor. -`AerStatevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the conjugate of the operator. @@ -212,7 +212,7 @@ complex -`classmethod AerStatevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the output statevector of an instruction. @@ -238,7 +238,7 @@ The final statevector. -`static AerStatevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`static AerStatevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a computational basis statevector. @@ -266,7 +266,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerStatevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -355,7 +355,7 @@ tuple -`AerStatevector.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.metadata()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return result metadata of an operation that executed lastly. @@ -538,7 +538,7 @@ Additional Information: -`AerStatevector.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -565,7 +565,7 @@ Additional Information: -`AerStatevector.seed(value=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.seed(value=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.md index 19ae0afd358..1bc6ad231e2 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_noise_model.md index fb3f3841a0a..a55bd1cde5f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_quantum_error.md index b11ed875e94..34cea362496 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.insert_noise.md b/docs/api/qiskit/0.40/qiskit_aer.utils.insert_noise.md index 4a76436e647..781c8172b8d 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.remap_noise_model.md b/docs/api/qiskit/0.40/qiskit_aer.utils.remap_noise_model.md index c299cda8af2..33d73b14a5f 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.transform_noise_model.md b/docs/api/qiskit/0.40/qiskit_aer.utils.transform_noise_model.md index d7301f5f544..f5fb8849045 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_noise_model.md index 4fd8ade1fe4..f1c17a64b81 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_quantum_error.md index 0e89f33a58f..accabb93593 100644 --- a/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.40/qiskit_aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.40/synthesis_aqc.md b/docs/api/qiskit/0.40/synthesis_aqc.md index c80989b3801..e2d66c0a490 100644 --- a/docs/api/qiskit/0.40/synthesis_aqc.md +++ b/docs/api/qiskit/0.40/synthesis_aqc.md @@ -128,7 +128,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.40/utils.md b/docs/api/qiskit/0.40/utils.md index ba14cb76640..c8663b82d29 100644 --- a/docs/api/qiskit/0.40/utils.md +++ b/docs/api/qiskit/0.40/utils.md @@ -111,7 +111,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -232,7 +232,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -246,7 +246,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From 79b5c6eb339bbe20d1f355dc4d75acaec1f8963f Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:52:28 +0100 Subject: [PATCH 21/41] Regenerate qiskit 0.41.0 --- docs/api/qiskit/0.41/execute.md | 2 +- docs/api/qiskit/0.41/pulse.md | 8 +- docs/api/qiskit/0.41/qasm3.md | 14 +- .../0.41/qiskit.algorithms.AlgorithmError.md | 2 +- .../0.41/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.41/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.41/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.41/qiskit.algorithms.Grover.md | 8 +- .../0.41/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../api/qiskit/0.41/qiskit.algorithms.PVQD.md | 8 +- .../0.41/qiskit.algorithms.PVQDResult.md | 2 +- .../0.41/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.41/qiskit.algorithms.QAOA.md | 2 +- .../0.41/qiskit.algorithms.RealEvolver.md | 4 +- .../0.41/qiskit.algorithms.RealTimeEvolver.md | 4 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 4 +- .../qiskit.algorithms.SciPyRealEvolver.md | 4 +- .../api/qiskit/0.41/qiskit.algorithms.Shor.md | 8 +- .../0.41/qiskit.algorithms.ShorResult.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 4 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.41/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.41/qiskit.algorithms.VQD.md | 14 +- .../0.41/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.41/qiskit.algorithms.VQE.md | 14 +- .../qiskit/0.41/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.41/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 6 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 6 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 6 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- .../qiskit.algorithms.estimate_observables.md | 2 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 6 +- .../qiskit.algorithms.gradients.BaseQGT.md | 6 +- ...lgorithms.gradients.BaseSamplerGradient.md | 6 +- ...kit.algorithms.gradients.DerivativeType.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.41/qiskit.algorithms.gradients.QFI.md | 6 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 10 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 6 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 6 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 6 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 6 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 6 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 6 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.41/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.41/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.41/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.41/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.41/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.41/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 16 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.41/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.41/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- ...lgorithms.optimizers.SteppableOptimizer.md | 18 +- .../0.41/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.41/qiskit.algorithms.optimizers.UMDA.md | 6 +- ...optimizers.optimizer_utils.LearningRate.md | 6 +- ...thms.state_fidelities.BaseStateFidelity.md | 6 +- ...ithms.state_fidelities.ComputeUncompute.md | 6 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 6 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 4 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 4 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 6 +- .../qiskit/0.41/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.41/qiskit.assembler.disassemble.md | 2 +- .../0.41/qiskit.circuit.AncillaQubit.md | 2 +- .../0.41/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.41/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.41/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.41/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.41/qiskit.circuit.Clbit.md | 2 +- .../0.41/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.41/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.41/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.41/qiskit.circuit.Delay.md | 12 +- .../0.41/qiskit.circuit.EquivalenceLibrary.md | 16 +- .../qiskit/0.41/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.41/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.41/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.41/qiskit.circuit.Instruction.md | 26 +- .../0.41/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.41/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.41/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.41/qiskit.circuit.ParameterVector.md | 6 +- .../0.41/qiskit.circuit.QuantumCircuit.md | 222 +++++++++--------- .../0.41/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.41/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.41/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.AND.md | 2 +- .../0.41/qiskit.circuit.library.Barrier.md | 8 +- .../0.41/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.41/qiskit.circuit.library.C3XGate.md | 6 +- .../0.41/qiskit.circuit.library.C4XGate.md | 6 +- .../0.41/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.41/qiskit.circuit.library.CHGate.md | 4 +- .../0.41/qiskit.circuit.library.CPhaseGate.md | 8 +- .../0.41/qiskit.circuit.library.CRXGate.md | 4 +- .../0.41/qiskit.circuit.library.CRYGate.md | 4 +- .../0.41/qiskit.circuit.library.CRZGate.md | 4 +- .../0.41/qiskit.circuit.library.CSXGate.md | 2 +- .../0.41/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.41/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.41/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.41/qiskit.circuit.library.CUGate.md | 4 +- .../0.41/qiskit.circuit.library.CXGate.md | 6 +- .../0.41/qiskit.circuit.library.CYGate.md | 4 +- .../0.41/qiskit.circuit.library.CZGate.md | 4 +- .../0.41/qiskit.circuit.library.DCXGate.md | 2 +- .../0.41/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.41/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.GRZ.md | 2 +- .../0.41/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.41/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.41/qiskit.circuit.library.IGate.md | 6 +- .../qiskit/0.41/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.41/qiskit.circuit.library.MCMT.md | 6 +- .../0.41/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.41/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.41/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.41/qiskit.circuit.library.MSGate.md | 2 +- .../0.41/qiskit.circuit.library.Measure.md | 4 +- .../0.41/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.41/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.41/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 8 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.41/qiskit.circuit.library.PhaseGate.md | 8 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.41/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.41/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.41/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.41/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.41/qiskit.circuit.library.RGate.md | 6 +- .../0.41/qiskit.circuit.library.RVGate.md | 6 +- .../0.41/qiskit.circuit.library.RXGate.md | 8 +- .../0.41/qiskit.circuit.library.RXXGate.md | 6 +- .../0.41/qiskit.circuit.library.RYGate.md | 8 +- .../0.41/qiskit.circuit.library.RYYGate.md | 6 +- .../0.41/qiskit.circuit.library.RZGate.md | 8 +- .../0.41/qiskit.circuit.library.RZXGate.md | 6 +- .../0.41/qiskit.circuit.library.RZZGate.md | 6 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.41/qiskit.circuit.library.Reset.md | 4 +- .../0.41/qiskit.circuit.library.SGate.md | 6 +- .../0.41/qiskit.circuit.library.SXGate.md | 6 +- .../0.41/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.41/qiskit.circuit.library.SdgGate.md | 6 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.41/qiskit.circuit.library.SwapGate.md | 6 +- .../0.41/qiskit.circuit.library.TGate.md | 6 +- .../0.41/qiskit.circuit.library.TdgGate.md | 6 +- .../0.41/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.41/qiskit.circuit.library.U1Gate.md | 6 +- .../0.41/qiskit.circuit.library.U2Gate.md | 4 +- .../0.41/qiskit.circuit.library.U3Gate.md | 6 +- .../0.41/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.41/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.41/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 6 +- .../qiskit.circuit.library.XXPlusYYGate.md | 6 +- .../0.41/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.41/qiskit.circuit.library.ZGate.md | 8 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.41/qiskit.circuit.library.iSwapGate.md | 4 +- .../0.41/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.41/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.41/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.41/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.41/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.41/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.41/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.41/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.41/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.41/qiskit.compiler.transpile.md | 2 +- .../0.41/qiskit.converters.ast_to_dag.md | 2 +- .../0.41/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.41/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.41/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.41/qiskit.dagcircuit.BlockCollapser.md | 4 +- .../0.41/qiskit.dagcircuit.BlockCollector.md | 6 +- .../0.41/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.41/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.41/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.41/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.41/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.41/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.41/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.41/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.41/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.41/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.41/qiskit.extensions.Snapshot.md | 8 +- .../0.41/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.41/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.41/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.41/qiskit.extensions.UCRZGate.md | 2 +- .../0.41/qiskit.extensions.UnitaryGate.md | 16 +- .../qiskit/0.41/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.41/qiskit.opflow.OpflowError.md | 2 +- .../0.41/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.41/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.41/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.41/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.41/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.41/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.41/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.41/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.41/qiskit.opflow.gradients.QFI.md | 4 +- .../0.41/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.41/qiskit.opflow.list_ops.ComposedOp.md | 16 +- .../0.41/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.41/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.41/qiskit.opflow.list_ops.TensoredOp.md | 12 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 16 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.41/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../qiskit.primitives.BackendEstimator.md | 4 +- .../0.41/qiskit.primitives.BackendSampler.md | 4 +- .../0.41/qiskit.primitives.BaseEstimator.md | 6 +- .../0.41/qiskit.primitives.BaseSampler.md | 6 +- .../0.41/qiskit.primitives.Estimator.md | 4 +- .../0.41/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.41/qiskit.primitives.Sampler.md | 4 +- .../0.41/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.41/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.41/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.41/qiskit.providers.BackendV2.md | 16 +- .../qiskit.providers.BackendV2Converter.md | 12 +- docs/api/qiskit/0.41/qiskit.providers.Job.md | 2 +- .../qiskit/0.41/qiskit.providers.JobError.md | 2 +- .../qiskit/0.41/qiskit.providers.JobStatus.md | 2 +- .../0.41/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.41/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.41/qiskit.providers.Options.md | 8 +- .../qiskit/0.41/qiskit.providers.Provider.md | 2 +- .../0.41/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.41/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.41/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.41/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.41/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.41/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.41/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.41/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.41/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.41/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.41/qiskit.pulse.ScheduleBlock.md | 30 +-- .../0.41/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.41/qiskit.pulse.builder.align_func.md | 2 +- .../0.41/qiskit.pulse.builder.align_left.md | 2 +- .../0.41/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.41/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.delay.md | 2 +- .../0.41/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.41/qiskit.pulse.builder.measure.md | 2 +- .../0.41/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.41/qiskit.pulse.builder.num_qubits.md | 2 +- .../0.41/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- .../0.41/qiskit.pulse.builder.reference.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.41/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.41/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.41/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.41/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.41/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.41/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.41/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.41/qiskit.pulse.instructions.Call.md | 4 +- .../0.41/qiskit.pulse.instructions.Delay.md | 2 +- .../0.41/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- .../0.41/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.41/qiskit.pulse.library.Drag.md | 2 +- .../0.41/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- ...kit.pulse.library.ScalableSymbolicPulse.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- .../0.41/qiskit.pulse.library.Waveform.md | 4 +- .../qiskit/0.41/qiskit.pulse.library.cos.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.41/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.41/qiskit.pulse.library.sech.md | 2 +- .../0.41/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.41/qiskit.pulse.library.sin.md | 2 +- .../0.41/qiskit.pulse.library.square.md | 2 +- .../0.41/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.41/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.41/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.41/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.41/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.41/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.41/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.41/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.41/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.41/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.41/qiskit.qobj.GateCalibration.md | 6 +- .../0.41/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md | 6 +- .../0.41/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.41/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.41/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.41/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.41/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.41/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.41/qiskit.qobj.Qobj.md | 2 +- .../0.41/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.41/qiskit.qobj.QobjHeader.md | 2 +- .../0.41/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.41/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.41/qiskit.qpy.load.md | 2 +- .../0.41/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.41/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.41/qiskit.quantum_info.Choi.md | 12 +- .../0.41/qiskit.quantum_info.Clifford.md | 36 +-- .../0.41/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.41/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 8 +- .../0.41/qiskit.quantum_info.Operator.md | 30 +-- .../qiskit/0.41/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.41/qiskit.quantum_info.Pauli.md | 38 +-- .../0.41/qiskit.quantum_info.PauliList.md | 54 ++--- .../0.41/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.41/qiskit.quantum_info.Quaternion.md | 14 +- .../0.41/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.41/qiskit.quantum_info.SparsePauliOp.md | 46 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.41/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.41/qiskit.quantum_info.Stinespring.md | 14 +- .../0.41/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.41/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.41/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.41/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.41/qiskit.quantum_info.entropy.md | 2 +- .../0.41/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.41/qiskit.quantum_info.partial_trace.md | 2 +- .../0.41/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.41/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.41/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.41/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.41/qiskit.result.ProbDistribution.md | 6 +- .../0.41/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.41/qiskit.result.Result.md | 16 +- .../qiskit/0.41/qiskit.result.ResultError.md | 2 +- .../0.41/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.41/qiskit.result.marginal_memory.md | 2 +- ...qiskit.result.sampled_expectation_value.md | 2 +- .../0.41/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.41/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.41/qiskit.synthesis.ProductFormula.md | 2 +- .../qiskit/0.41/qiskit.synthesis.QDrift.md | 4 +- ...it.synthesis.SolovayKitaevDecomposition.md | 8 +- .../0.41/qiskit.synthesis.SuzukiTrotter.md | 4 +- ...synthesis.generate_basic_approximations.md | 2 +- .../qiskit.synthesis.synth_clifford_ag.md | 2 +- .../qiskit.synthesis.synth_clifford_bm.md | 2 +- .../qiskit.synthesis.synth_clifford_full.md | 2 +- .../qiskit.synthesis.synth_clifford_greedy.md | 2 +- .../qiskit.synthesis.synth_clifford_layers.md | 2 +- ...kit.synthesis.synth_cnot_count_full_pmh.md | 2 +- ...kit.synthesis.synth_cnot_depth_line_kms.md | 2 +- ...iskit.synthesis.synth_cnotdihedral_full.md | 2 +- ...it.synthesis.synth_cnotdihedral_general.md | 2 +- ...synthesis.synth_cnotdihedral_two_qubits.md | 2 +- .../qiskit.synthesis.synth_permutation_acg.md | 2 +- ...iskit.synthesis.synth_permutation_basic.md | 2 +- ...nthesis.synth_permutation_depth_lnn_kms.md | 2 +- .../0.41/qiskit.tools.backend_monitor.md | 2 +- .../0.41/qiskit.tools.backend_overview.md | 2 +- .../qiskit.tools.events.TextProgressBar.md | 6 +- .../qiskit/0.41/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.41/qiskit.tools.parallel_map.md | 2 +- .../0.41/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.41/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.41/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.41/qiskit.transpiler.Layout.md | 30 +-- .../0.41/qiskit.transpiler.PassManager.md | 16 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.41/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 12 +- .../qiskit/0.41/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.41/qiskit.transpiler.TranspilerError.md | 2 +- ...anspiler.passes.ACGSynthesisPermutation.md | 4 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...spiler.passes.BasicSynthesisPermutation.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.41/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...it.transpiler.passes.CollectAndCollapse.md | 4 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...r.passes.CommutativeInverseCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 4 +- .../0.41/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.41/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...it.transpiler.passes.HighLevelSynthesis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...anspiler.passes.KMSSynthesisPermutation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- ...kit.transpiler.passes.OptimizeCliffords.md | 4 +- .../0.41/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- ....passes.ResetAfterMeasureSimplification.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.41/qiskit.transpiler.passes.Size.md | 4 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 4 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- ...iler.passes.TranslateParameterizedGates.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.41/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.41/qiskit.transpiler.passes.Width.md | 4 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 4 +- ....plugin.HighLevelSynthesisPluginManager.md | 6 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...mon.generate_control_flow_options_check.md | 2 +- ...agers.common.generate_embed_passmanager.md | 2 +- ...s.common.generate_error_on_control_flow.md | 2 +- ...gers.common.generate_pre_op_passmanager.md | 2 +- ...ers.common.generate_routing_passmanager.md | 2 +- ...passmanagers.common.generate_scheduling.md | 2 +- ...common.generate_translation_passmanager.md | 2 +- ..._passmanagers.common.generate_unroll_3q.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 4 +- ...rs.plugin.PassManagerStagePluginManager.md | 4 +- ..._passmanagers.plugin.list_stage_plugins.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- ...ler.synthesis.aqc.FastCNOTUnitObjective.md | 6 +- .../0.41/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.41/qiskit.utils.apply_prefix.md | 2 +- .../0.41/qiskit.utils.deprecate_arguments.md | 2 +- .../0.41/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.41/qiskit.utils.detach_prefix.md | 2 +- .../0.41/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.41/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md | 2 +- .../0.41/qiskit.utils.is_main_process.md | 2 +- .../0.41/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 8 +- .../api/qiskit/0.41/qiskit.utils.name_args.md | 2 +- .../0.41/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.41/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.41/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.41/qiskit_aer.AerError.md | 2 +- .../api/qiskit/0.41/qiskit_aer.AerProvider.md | 6 +- .../qiskit/0.41/qiskit_aer.AerSimulator.md | 14 +- .../qiskit/0.41/qiskit_aer.PulseSimulator.md | 8 +- .../qiskit/0.41/qiskit_aer.QasmSimulator.md | 12 +- .../0.41/qiskit_aer.StatevectorSimulator.md | 8 +- .../0.41/qiskit_aer.UnitarySimulator.md | 8 +- .../api/qiskit/0.41/qiskit_aer.jobs.AerJob.md | 16 +- .../qiskit/0.41/qiskit_aer.jobs.AerJobSet.md | 20 +- .../0.41/qiskit_aer.library.SaveAmplitudes.md | 2 +- ...iskit_aer.library.SaveAmplitudesSquared.md | 2 +- .../0.41/qiskit_aer.library.SaveClifford.md | 2 +- .../qiskit_aer.library.SaveDensityMatrix.md | 2 +- ...qiskit_aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...skit_aer.library.SaveMatrixProductState.md | 2 +- .../qiskit_aer.library.SaveProbabilities.md | 2 +- ...iskit_aer.library.SaveProbabilitiesDict.md | 2 +- .../0.41/qiskit_aer.library.SaveStabilizer.md | 2 +- .../0.41/qiskit_aer.library.SaveState.md | 2 +- .../qiskit_aer.library.SaveStatevector.md | 2 +- .../qiskit_aer.library.SaveStatevectorDict.md | 2 +- .../0.41/qiskit_aer.library.SaveSuperOp.md | 2 +- .../0.41/qiskit_aer.library.SaveUnitary.md | 2 +- .../qiskit_aer.library.SetDensityMatrix.md | 2 +- ...iskit_aer.library.SetMatrixProductState.md | 2 +- .../0.41/qiskit_aer.library.SetStabilizer.md | 2 +- .../0.41/qiskit_aer.library.SetStatevector.md | 2 +- .../0.41/qiskit_aer.library.SetSuperOp.md | 2 +- .../0.41/qiskit_aer.library.SetUnitary.md | 2 +- .../qiskit_aer.library.save_amplitudes.md | 2 +- ...kit_aer.library.save_amplitudes_squared.md | 2 +- .../0.41/qiskit_aer.library.save_clifford.md | 2 +- .../qiskit_aer.library.save_density_matrix.md | 2 +- ...skit_aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...t_aer.library.save_matrix_product_state.md | 2 +- .../qiskit_aer.library.save_probabilities.md | 2 +- ...kit_aer.library.save_probabilities_dict.md | 2 +- .../qiskit_aer.library.save_stabilizer.md | 2 +- .../0.41/qiskit_aer.library.save_state.md | 2 +- .../qiskit_aer.library.save_statevector.md | 2 +- ...iskit_aer.library.save_statevector_dict.md | 2 +- .../0.41/qiskit_aer.library.save_superop.md | 2 +- .../0.41/qiskit_aer.library.save_unitary.md | 2 +- .../qiskit_aer.library.set_density_matrix.md | 2 +- ...it_aer.library.set_matrix_product_state.md | 2 +- .../0.41/qiskit_aer.library.set_stabilizer.md | 2 +- .../qiskit_aer.library.set_statevector.md | 2 +- .../0.41/qiskit_aer.library.set_superop.md | 2 +- .../0.41/qiskit_aer.library.set_unitary.md | 2 +- .../0.41/qiskit_aer.noise.LocalNoisePass.md | 4 +- .../0.41/qiskit_aer.noise.NoiseModel.md | 24 +- .../0.41/qiskit_aer.noise.QuantumError.md | 24 +- .../0.41/qiskit_aer.noise.ReadoutError.md | 24 +- .../qiskit_aer.noise.RelaxationNoisePass.md | 2 +- ...iskit_aer.noise.amplitude_damping_error.md | 2 +- ...qiskit_aer.noise.coherent_unitary_error.md | 2 +- .../qiskit_aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...skit_aer.noise.device.gate_error_values.md | 2 +- ...kit_aer.noise.device.gate_length_values.md | 2 +- ...skit_aer.noise.device.gate_param_values.md | 2 +- ...t_aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../0.41/qiskit_aer.noise.kraus_error.md | 2 +- .../qiskit_aer.noise.mixed_unitary_error.md | 2 +- .../0.41/qiskit_aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- .../qiskit_aer.noise.phase_damping_error.md | 2 +- .../0.41/qiskit_aer.noise.reset_error.md | 2 +- ...skit_aer.noise.thermal_relaxation_error.md | 2 +- .../0.41/qiskit_aer.primitives.Estimator.md | 4 +- .../0.41/qiskit_aer.primitives.Sampler.md | 4 +- .../0.41/qiskit_aer.pulse.PulseSystemModel.md | 10 +- .../qiskit_aer.pulse.duffing_system_model.md | 2 +- .../qiskit_aer.quantum_info.AerStatevector.md | 16 +- .../0.41/qiskit_aer.utils.NoiseTransformer.md | 36 +-- ...iskit_aer.utils.approximate_noise_model.md | 2 +- ...kit_aer.utils.approximate_quantum_error.md | 2 +- .../0.41/qiskit_aer.utils.insert_noise.md | 2 +- .../qiskit_aer.utils.remap_noise_model.md | 2 +- .../qiskit_aer.utils.transform_noise_model.md | 2 +- .../qiskit_aer.utils.transpile_noise_model.md | 2 +- ...iskit_aer.utils.transpile_quantum_error.md | 2 +- docs/api/qiskit/0.41/synthesis_aqc.md | 2 +- docs/api/qiskit/0.41/utils.md | 6 +- 1129 files changed, 3007 insertions(+), 3007 deletions(-) diff --git a/docs/api/qiskit/0.41/execute.md b/docs/api/qiskit/0.41/execute.md index 1af24c354fa..b5c71060410 100644 --- a/docs/api/qiskit/0.41/execute.md +++ b/docs/api/qiskit/0.41/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.41/pulse.md b/docs/api/qiskit/0.41/pulse.md index 1d5821e036d..b01d492f3ef 100644 --- a/docs/api/qiskit/0.41/pulse.md +++ b/docs/api/qiskit/0.41/pulse.md @@ -69,7 +69,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -228,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -677,7 +677,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.41/qasm3.md b/docs/api/qiskit/0.41/qasm3.md index 5ab706d5634..46e2be8a3ce 100644 --- a/docs/api/qiskit/0.41/qasm3.md +++ b/docs/api/qiskit/0.41/qasm3.md @@ -26,7 +26,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. @@ -44,7 +44,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. @@ -65,7 +65,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -99,7 +99,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") +`QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -123,7 +123,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -147,7 +147,7 @@ a circuit representation of the OpenQASM 3 program. -`loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -173,7 +173,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") +`QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md index 78d413acdf9..c3761d68fa1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md index 877b84bd5c5..0deb3cd1025 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") +`AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") Bases: `qiskit.primitives.primitive_job.PrimitiveJob` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md index c93e4539d10..8924b380bfa 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md index 650136dfd86..3b3fcf59e4c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md index b18f288a597..b1ffb856422 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -77,7 +77,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -98,7 +98,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -119,7 +119,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -145,7 +145,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md index 89ca764cc51..0f7fc6e086c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md index 763f10c1313..d7867df6ad9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md index 3ba8931a981..35bb6180bc7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md index 9f532a0eb3e..a92b676db72 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md index 3b79806ee73..062e3b285e4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md index 15f2762b928..59da2bff4c8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md index afa2803134e..a1f4169c641 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -40,7 +40,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md index 44ee65ffc1b..8b2d71c0234 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md index 52e16421b70..1a2c1c0a0d6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -52,7 +52,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -72,7 +72,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md index a24a7e8db42..ac3b3104b4a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md index f1a2f489f12..b5744c34d1e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -94,7 +94,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -121,7 +121,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -147,7 +147,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md index 1548fe84ce2..5aa0bdf654b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md index cc4125d774e..6b398bc454e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -58,7 +58,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index e93c2502e25..5a66e8a074a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md index 4e0f4a06b45..0c2e3fc4ca9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The ImaginaryEvolver interface has been superseded by the `qiskit.algorithms.tim -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md index b86e703ec7f..14ca5760295 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`abstract ImaginaryTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md index b530d014975..8522722c7d3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -78,7 +78,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 527767991ec..c039cf888b7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md index 69e3582f8db..bddf50b7ad9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -39,7 +39,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -65,7 +65,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 16fce9b98f9..80135fef84a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -45,7 +45,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -71,7 +71,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -92,7 +92,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -109,7 +109,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 2d71e1a6ca5..5916b5d8e2c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md index 0020b51c82f..4fa91d25968 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md index 15dd2cf53ec..3d3c03ae2d9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md index 58331e05214..4f12f5875ae 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -56,7 +56,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md index b78d86e7509..54713ce4978 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -28,7 +28,7 @@ The NumPyMinimumEigensolver class has been superseded by the [`qiskit.algorithms -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -49,7 +49,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md index e5b8219fbc8..098f7a15695 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -158,7 +158,7 @@ quantum algorithm for the time evolution of parameterized circuits, [Quantum 5, -`PVQD.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. @@ -185,7 +185,7 @@ A result object containing the evolution information and evaluated observables. -`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Get a function to evaluate the infidelity between Trotter step and ansatz. @@ -210,7 +210,7 @@ a second callable to evaluate the gradient of the infidelity. -`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform a single time step. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md index 56eee3c3568..c1ff31b71c0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md index 097d4191465..5fef067cefa 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -66,7 +66,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -80,7 +80,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -101,7 +101,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md index c592522c411..21a0baf2d04 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md index 64ccc36c8ba..aa2d9ad251b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md index d94ee5a35ee..6a7b5abc0a1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md index 649a122e127..41b1ab9f2d5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The RealEvolver interface has been superseded by the `qiskit.algorithms.time_evo -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md index d75806df219..6c6fe22213f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`abstract RealTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md index 5aa6b449e68..502935bf7d0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau = it$ under -`SciPyImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md index d68a5b94634..20c9e7c1ecc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, -`SciPyRealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md index 8982999aaa8..7414d023a88 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -56,7 +56,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -84,7 +84,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md index 88b1cf000ca..f9597830863 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md index e8bcb2be6d2..bd83a89aa09 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: `object` @@ -98,7 +98,7 @@ dict\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), complex] -`TimeEvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md index d74532b8e54..4cde25ca282 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md index 020d37c6b6b..762b3487bbc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -51,7 +51,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -80,7 +80,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md index 2380e565403..91ab36ee909 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -48,7 +48,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -69,7 +69,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -90,7 +90,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -117,7 +117,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -147,7 +147,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -163,7 +163,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md index fb1fd772701..16b061feef0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md index dd580044bc0..23a6a3c17ef 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -76,7 +76,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -97,7 +97,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -118,7 +118,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -145,7 +145,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -172,7 +172,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -188,7 +188,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md index 16289e5c6f3..4d3a5e339a4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md index ea75c10fd8f..fe8d99c0706 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md index e31d73991b4..65de4e6c96a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ An eigensolver result. -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md index 06b2f7194a9..21b76befa46 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index caf05a725be..2cc8d0c96f6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -33,7 +33,7 @@ The NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valu -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -54,7 +54,7 @@ An eigensolver result. -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index dbc5510a9a8..14915b9cedf 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md index 3ed7f69b21c..d8e32ec02d5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -144,7 +144,7 @@ An eigensolver result. -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md index f6f4dabd863..54c15655a22 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md b/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md index c689df56ba5..e10c285076d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.estimate_observables -`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") +`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md index cad0372fb98..8cb4a944be0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") Pending deprecation: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 5e4df6bfa86..6d16d0cfc89 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Bases: `abc.ABC` @@ -38,7 +38,7 @@ Base class for an `EstimatorGradient` to compute the gradients of the expectatio -`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Run the job of the estimator gradient on the given circuits. @@ -62,7 +62,7 @@ The job object of the gradients of the expectation values. The i-th result corre -`BaseEstimatorGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md index f94dec0097b..a551921aa07 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Bases: `abc.ABC` @@ -60,7 +60,7 @@ $$ -`BaseQGT.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Run the job of the QGTs on the given circuits. @@ -83,7 +83,7 @@ The job object of the QGTs of the expectation values. The i-th result correspond -`BaseQGT.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md index 2d22d7a7754..b0079fba151 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Bases: `abc.ABC` @@ -27,7 +27,7 @@ Base class for a `SamplerGradient` to compute the gradients of the sampling prob -`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Run the job of the sampler gradient on the given circuits. @@ -50,7 +50,7 @@ The job object of the gradients of the sampling probability. The i-th result cor -`BaseSamplerGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md index 98ef0803fe6..5596a747443 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType -`DerivativeType(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") +`DerivativeType(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md index a2fca87a37f..2db8bda34a0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") +`EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 7a3ea6bbff5..81798050b1d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") +`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index 4aa3b6cf615..666d81628d5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") +`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index bf3595aec0c..553c40197f9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") +`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md index 8bc161d035f..94dccf227f1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") +`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md index d2551d95342..b0b9a347927 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") +`LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 4a835296c52..cd0fd8a953e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") +`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 254b6f2ac6b..92258893f5a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") +`ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md index ce591d94d0b..84f42ebbb1f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Bases: `abc.ABC` @@ -32,7 +32,7 @@ $$ -`QFI.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Run the job of the QFIs on the given circuits. @@ -51,7 +51,7 @@ The job object of the QFIs of the expectation values. The i-th result correspond -`QFI.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md index ec72cc7bf99..cea3bda19d5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") +`QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md index a5d30dc28b7..9af58c1857f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") +`QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index b5a3a460fc4..93b455adf4c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") +`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md index 1c7d04f66f2..a3dd4ffa498 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") +`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 08a3c462dde..479523cfd8d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") +`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md index bac2f7cb3d4..e2f4c3c4c15 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") +`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md index aeeb3337e8c..dd9af027763 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") +`SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 10705143ab1..55e45e718ed 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage -`AbsoluteAverage`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -57,7 +57,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -77,7 +77,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -97,7 +97,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -117,7 +117,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md index a0baa6474aa..7a770a3c061 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -73,7 +73,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -101,7 +101,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md index 3eac543ee0c..d1dd3f779c3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md index 05b6cc4c8e8..12f581d3ba4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index ec9acab4d5c..8f7ff58ed07 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -483,7 +483,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1134,7 +1134,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2133,7 +2133,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index 307eb9c7133..aae97f9a273 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 496e1c64d28..e9c64b1e1a5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -72,7 +72,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -92,7 +92,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -112,7 +112,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -132,7 +132,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index 6023d2b249c..89358514c13 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -47,7 +47,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md index c907381c6fe..cd92490c2fc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -505,7 +505,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1156,7 +1156,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1665,7 +1665,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2155,7 +2155,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index 36b05c1e097..dcf7381a495 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -518,7 +518,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1169,7 +1169,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1678,7 +1678,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2168,7 +2168,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 2cd666de64a..20cf2c34781 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -69,7 +69,7 @@ the maximum number of iterations for the adaptive loop. If `None`, the algorithm -`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Computes the minimum eigenvalue. @@ -95,7 +95,7 @@ An [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qis -`classmethod AdaptVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`classmethod AdaptVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 50d105cc089..b77bf184696 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 8b4b8f60845..59d55485770 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ A minimum eigensolver result. -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 8fd386db895..13c0d8084ea 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 49b0154d470..e18b53e8a8f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -26,7 +26,7 @@ The NumPy minimum eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -47,7 +47,7 @@ A minimum eigensolver result. -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 6007ad2d4b9..8fa5658edaf 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md index df54e147abd..bc1a5a6637c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 05bf7bf2539..b4c2ea54232 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Sampling Minimum Eigensolver Interface. -`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -43,7 +43,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`classmethod SamplingMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 1eba5396f4a..853df6d0b3f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 9dcfac32cdd..a4739f6d797 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -144,7 +144,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`classmethod SamplingVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index 85ed351378f..e73687f4d06 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md index 51bf986c188..829aed79ca4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -129,7 +129,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -150,7 +150,7 @@ A minimum eigensolver result. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 4d9492dc3d8..c4986cff3bc 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md index 8382dd05279..3b5421e71e5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md index 8bd87981fe0..3377a2c813d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md index b28d6820b9e..ddd9860012b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md index ec722dfbbe3..f3201b4dd31 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md index b92f3958c08..d86bc22153c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md index 417ca0bc042..cfd378cb04e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md index 044cdd62086..f589c4181c5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md index 0a48df3a05e..57feb623f52 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index e87f0d2c37d..6d42e2ffa78 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md index 0015cb6720e..ac18b7b2f8b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md index 011adfd6903..72ac2fd2b09 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md index 0be0e52fb2d..ffc9edff2c1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") @@ -141,7 +141,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`GradientDescent.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Returns an object with the data needed to evaluate the gradient. @@ -155,7 +155,7 @@ If this object contains a gradient function the gradient can be evaluated direct -`GradientDescent.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Condition that indicates the optimization process should come to an end. @@ -173,7 +173,7 @@ When the stepsize is smaller than the tolerance, the optimization process is con -`GradientDescent.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Creates a result of the optimization process. @@ -191,7 +191,7 @@ The result of the optimization process. -`GradientDescent.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Evaluates the gradient. @@ -213,7 +213,7 @@ The data containing the gradient evaluation. -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -299,7 +299,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`GradientDescent.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -332,7 +332,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.GradientDescent#ask -`GradientDescent.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Updates `x` by an ammount proportional to the learning rate and value of the gradient at that point. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md index 8263430eb27..1f19abc74de 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md index 4c26cf619a9..67a1ae55613 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md index a6338965582..814df68ba9b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md index f4d82e90623..d93d62b858a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md index 07fd105ce15..980b1156bf2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md index 9107ba9826f..12ab5513ba4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md index ca1e1e26ccb..d88a7e979e8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md index 8fd99c5dcc5..8d0d4450bb7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md index 5bc94cce554..2dc47e03463 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md index 363ed8aede2..983a4f7b20f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index ae26bc6fc6c..6d2436a94be 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md index b18066d10e8..33d5d3f7ce2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md index c3711e8b04f..9477a3db93d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md index 5368bdd57cb..700006b7a0c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -154,7 +154,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md index a407ac6e76b..e4eb2fe2943 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md index 764a5be40db..f20b3e0a764 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -38,7 +38,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -69,7 +69,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md index 7e5b2a878af..2e73e27179d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md index 6ee56a70440..acd8ef6a35b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md index b0dbd71a103..81fa839d152 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -77,7 +77,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`SteppableOptimizer.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Ask the optimizer for a set of points to evaluate. @@ -95,7 +95,7 @@ An object containing the data needed to make the funciton evaluation to advance -`SteppableOptimizer.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Condition that indicates the optimization process should continue. @@ -111,7 +111,7 @@ Condition that indicates the optimization process should continue. -`abstract SteppableOptimizer.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Returns the result of the optimization. @@ -129,7 +129,7 @@ The result of the optimization process. -`abstract SteppableOptimizer.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Evaluates the function according to the instructions contained in `ask_data`. @@ -182,7 +182,7 @@ grad -`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Minimizes the function. @@ -237,7 +237,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -256,7 +256,7 @@ Populates the state of the optimizer with the data provided and sets all the cou -`SteppableOptimizer.step()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.step()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Performs one step in the optimization process. @@ -270,7 +270,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#a -`SteppableOptimizer.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Updates the optimization state using the results of the function evaluation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md index 75cfef2dfa7..60fca8692f9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md index ac914eef91d..3cb175e90b5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md index d54be830117..49e880bce02 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 99399f21d71..10677c3234c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: `Generator` @@ -34,7 +34,7 @@ Raise GeneratorExit inside generator. -`LearningRate.send(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.send(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Send a value into the generator. Return next yielded value or raise StopIteration. @@ -42,7 +42,7 @@ Send a value into the generator. Return next yielded value or raise StopIteratio -`LearningRate.throw(typ, val=None, tb=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.throw(typ, val=None, tb=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Raise an exception in the generator. Return next yielded value or raise StopIteration. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index bbd9988735a..e94d8adc07b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: `abc.ABC` @@ -28,7 +28,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. @@ -49,7 +49,7 @@ The fidelity quantum circuit corresponding to `circuit_1` and `circuit_2`. -`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md index f10a6de0474..7c548640817 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`ComputeUncompute(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") @@ -39,7 +39,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Combines `circuit_1` and `circuit_2` to create the fidelity circuit following the compute-uncompute method. @@ -80,7 +80,7 @@ Primitive job for the fidelity calculation. The job’s result is an instance of -`ComputeUncompute.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Update the fidelity’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md index ae599eaaa77..09f7ada9ad9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index d052f200f6a..24c45c3ff12 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`TrotterQRTE(product_formula=None, estimator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, estimator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using an estimator primitive provided. @@ -78,7 +78,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index ea3308b2971..3b615abcd7f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `scipy.integrate._ivp.base.OdeSolver` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index a5b45defcee..443bf02d1c1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") @@ -31,7 +31,7 @@ Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize -`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index 6cc04edc73a..6b2675e483c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index 7ad673b1f5a..e9c506af13e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") @@ -31,7 +31,7 @@ Class for a Real McLachlan’s Variational Principle. It aims to minimize the di -`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 47d8c8abc79..d8cdb9e2edf 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 040fe82af2f..0be6a279966 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: `abc.ABC` @@ -47,7 +47,7 @@ Instance of a class used to compute the state gradient. -`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. @@ -66,7 +66,7 @@ An evolution gradient. -`VariationalPrinciple.metric_tensor(ansatz, param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple.metric_tensor(ansatz, param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates a metric tensor according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md index 4f87ece860a..90f39a8920b 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md index 987eaf598a7..1c6e57ff275 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md index adae82eadb2..7329ed3cc99 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md index 8a6722e2d6d..a5aa312d43a 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md index 8fa12e98d6a..90e7b731604 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md index 416778a78f5..a0034aa9976 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md index d7fecec8d82..88ad59b9cd0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md index 11f7c25eb70..2b314ec5d74 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md index ef681a84289..f05c007ba60 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md index 43a47cbe1b3..ac503293d5f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md index 804ed3e332b..84e5e12c1eb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md index c3a59f63e36..12045265b61 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md index a4531673e10..b989e7002fa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -206,7 +206,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Delay.md b/docs/api/qiskit/0.41/qiskit.circuit.Delay.md index da2e5d5f610..2bf5a2abfad 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md index a3d0b4660a3..d323cabefa6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.keys()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.keys()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return list of keys to key to node index map. @@ -133,7 +133,7 @@ List -`EquivalenceLibrary.node_index(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.node_index(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return node index for a given key. @@ -153,7 +153,7 @@ Int -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md index 929aa14ed46..c80eaf2a074 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.Gate.md index 080a24edfc7..8d3ae99783d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md index a7d5e571f02..683b99898d6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md index de74c5a2202..09f911b5f24 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md index 7da5a14b3f5..af830f01671 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -107,7 +107,7 @@ qc.draw('mpl') -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Operation.md b/docs/api/qiskit/0.41/qiskit.circuit.Operation.md index 6b18bd4e627..51c5c46153a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") +`Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md index 537b041824e..99e3f7959e3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -203,7 +203,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md index b7cd30b40f0..4567d7c54b2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -107,7 +107,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -119,7 +119,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -127,7 +127,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -135,7 +135,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -155,7 +155,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -163,7 +163,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -171,7 +171,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -179,7 +179,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -206,7 +206,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -220,7 +220,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md index 8ebdbd000e6..5a8df333eb9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md index 476899872ab..b6f63de09f3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -107,7 +107,7 @@ qc.draw('mpl') -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -119,7 +119,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -142,7 +142,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -154,7 +154,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -184,7 +184,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -256,7 +256,7 @@ circuit.draw('mpl') -`QuantumCircuit.barrier(*qargs, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -277,7 +277,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -306,7 +306,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -330,7 +330,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -342,7 +342,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -362,7 +362,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -387,7 +387,7 @@ A handle to the instructions created. -`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CCZGate`. @@ -413,7 +413,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -438,7 +438,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -452,7 +452,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -464,7 +464,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -476,7 +476,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -505,7 +505,7 @@ A handle to the instructions created. -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -561,7 +561,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -585,7 +585,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -611,7 +611,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -631,7 +631,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -657,7 +657,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -673,7 +673,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -699,7 +699,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -725,7 +725,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -751,7 +751,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -777,7 +777,7 @@ A handle to the instructions created. -`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSGate`. @@ -802,7 +802,7 @@ A handle to the instructions created. -`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSdgGate`. @@ -827,7 +827,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -853,7 +853,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -878,7 +878,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -907,7 +907,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -932,7 +932,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -957,7 +957,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -982,7 +982,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1005,7 +1005,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1026,7 +1026,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1052,7 +1052,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1103,7 +1103,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1177,7 +1177,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1200,7 +1200,7 @@ A handle to the instructions created. -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1231,7 +1231,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1286,7 +1286,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1314,7 +1314,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Construct a circuit from an iterable of CircuitInstructions. @@ -1335,7 +1335,7 @@ The quantum circuit. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1355,7 +1355,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1375,7 +1375,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1395,7 +1395,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1425,7 +1425,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1433,7 +1433,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1453,7 +1453,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1475,7 +1475,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1501,7 +1501,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1547,7 +1547,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1701,7 +1701,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1803,7 +1803,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1826,7 +1826,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1912,7 +1912,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1953,7 +1953,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1990,7 +1990,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2015,7 +2015,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2037,7 +2037,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2066,7 +2066,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2089,7 +2089,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2109,7 +2109,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2123,7 +2123,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2139,7 +2139,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2151,7 +2151,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2174,7 +2174,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2195,7 +2195,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2321,7 +2321,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2348,7 +2348,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2368,7 +2368,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2388,7 +2388,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2415,7 +2415,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2442,7 +2442,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2466,7 +2466,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2491,7 +2491,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2515,7 +2515,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2537,7 +2537,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2557,7 +2557,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2577,7 +2577,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2631,7 +2631,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2671,7 +2671,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2698,7 +2698,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2722,7 +2722,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2746,7 +2746,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2770,7 +2770,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2794,7 +2794,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2817,7 +2817,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2841,7 +2841,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2865,7 +2865,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3277,7 +3277,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3445,7 +3445,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3523,7 +3523,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3546,7 +3546,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3568,7 +3568,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3590,7 +3590,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3612,7 +3612,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3634,7 +3634,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3679,7 +3679,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3700,7 +3700,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3721,7 +3721,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3749,7 +3749,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3909,7 +3909,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -3954,7 +3954,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -3970,7 +3970,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -3993,7 +3993,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4015,7 +4015,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md index 1a1925bd515..95bf3501f07 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md index 522275d2040..860a3cfc84a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md index a180e949bc9..c10dc8311ef 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md index 077e093cc1a..670a65f545c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md index da86a0d15d6..3ecdf9a61cf 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 08daec4fe67..825facd3392 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index e4ebbf0cbda..b173b304429 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md index 585e13c7341..a054b9f8fe7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md index 75d4412b54c..a21c742a4d3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -51,7 +51,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -72,7 +72,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -106,7 +106,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md index 446be7cb24d..103a07a58fd 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md index c2978779dee..941370a632d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md index a0430dcd9ef..6c120c7dcb1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md index 71dd510e909..4bbab0696b8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md index e7d24960e70..c0a14e5b7af 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md index 9361f395f57..1c1153df13a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md index 59e02db96b0..b9aa451a4d8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) @@ -83,7 +83,7 @@ Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) -`CPhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md index 39e9e2fc093..e6c10b2b426 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md index 22a65b6ca0e..40a4f74d7fa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md index 289d94ce27a..332447959c1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md index 3e628baa9b6..815296abd27 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md index 8e1f38635f4..f8a85f8b357 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md index 3a34cf79725..14b9925ec37 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md index b1967837ce1..74c5337eddb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md index 31adfab3941..12ac1e77bd8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md index 4bf901fe96e..f415506b93f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md index 61e42f333e3..00083d95736 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md index d49aef13e1c..413a1686833 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md index 32af862167c..8611dd455f1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md index 665346646fb..1a6a7667bd0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md index 8cee4e763fd..c1d1da2b5ad 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md index 86c6f9aa0bf..a30265302c1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md index 77ac697ad88..32a97e7f3ce 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md index c1af52c9d98..bc72285be45 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md index a9cb7713f92..ef8c5790a97 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md index 7899bc54263..1d820f88f95 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md index 87d7018c2d4..2bc48040291 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md index eeb8cd28968..9efe89e3167 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md index 64332289023..be1cfa597c5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md index d3c176be2d2..d2830693894 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md index 3bbdf7bc1ce..229ba9d383c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md index d8f79ab83a2..8a62621522d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md index 26a45948e8c..4065fd8b4de 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md index 274ee11fdb3..6966d8eee72 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md index f72abc46b12..4778f275824 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md index 8469bf47116..dfd5f7c9b4f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md index 1f24061fa7b..f5a6e7270e0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md index 931dc9f407d..c45a0dd2431 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md index f7424870926..b9ca4f45aa2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. @@ -53,7 +53,7 @@ Invert this gate. -`IGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md index e69613d828e..86e672cb2b9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md index 0b5b2382b6a..7e5d7005675 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md index ea4a4c6caf3..eda9fb1005f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md index 76aad706a2b..9c80650e4f8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md index e622abff0a2..a9520684b76 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md index 7c7a98b3fe6..77dba83f423 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md index 9805fbf92b5..1d015e6e161 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -52,7 +52,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -60,7 +60,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md index 323dcdc6ff7..156a08abe18 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -76,7 +76,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md index 0183c097408..f5cd6fb1f61 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md index dd69b71ebf0..31850e6f71d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md index a7da7d059ce..01760a4ec17 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md index 9f1cde91398..323a6144c55 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md index d8759215a46..6d8cf59c276 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md index b51b1906508..8c0c4d6dfb3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md index f03c9d89380..85ff760e5b0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md index aed13af33c1..a3b9085024b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -74,7 +74,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -100,7 +100,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -122,7 +122,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -165,7 +165,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -181,7 +181,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md index 0216804db0c..21926f80e82 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md index 3297045e664..0506be6a25a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md index 92367628f04..9ff74cf21cb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md index 3fc6b245319..26db9ea5c75 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md index 50a7b8e974a..bfc355b6001 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md index 0e264fc8aa5..e283092ed57 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md index f51e64bf365..d8c5ef17628 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -40,7 +40,7 @@ Return a permutation gate. -`PermutationGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Returns the inverse of the permutation. @@ -48,7 +48,7 @@ Returns the inverse of the permutation. -`PermutationGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") The qasm for a permutation. @@ -56,7 +56,7 @@ The qasm for a permutation. -`PermutationGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Parameter validation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md index 7eb8bc2dde9..a42dc5997c8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md index edac42d9b58..8d788b173c1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) @@ -100,7 +100,7 @@ Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) -`PhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md index c3598d80235..fee150ac7f1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md index 5f39f138320..cecb8f0b3ad 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 02133ea4ef2..cdb69edc5ba 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 29a9d23c72a..40fbea64eec 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md index 0a2bfa28d1c..b5d009ad133 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md index eda64534b10..822b5ced843 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md index 76bb505adf4..1051bf263f1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -55,7 +55,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -71,7 +71,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md index 345f7c9e9dd..565da5d621d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md index 5056dfb967b..e40879916a4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md index 81a343498b6..4a3cd3df13c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md index 14ba96a8aa1..236ac3929de 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md index 45fea507171..d9e50964458 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md index 0de358c93c6..de354d4a3d8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. @@ -54,7 +54,7 @@ r(θ, φ)^dagger = r(-θ, φ) -`RGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md index e4dbcee741a..487259ed54d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md index 87c03d6b6f2..2a1c7493394 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. @@ -76,7 +76,7 @@ $RX(\lambda)^{\dagger} = RX(-\lambda)$ -`RXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md index cfd9f8b60d0..e99913091f3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RXX gate (i.e. with the negative rotation angle). -`RXXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md index e74136d5b85..44137c5143c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. @@ -76,7 +76,7 @@ $RY(\lambda){\dagger} = RY(-\lambda)$ -`RYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md index c8de5d40a44..f47d3e76177 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RYY gate (i.e. with the negative rotation angle). -`RYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md index 85fa328b294..13d82090db2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate @@ -88,7 +88,7 @@ $RZ(\lambda){\dagger} = RZ(-\lambda)$ -`RZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md index f5ed86678ae..cd5cf462943 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). @@ -116,7 +116,7 @@ Return inverse RZX gate (i.e. with the negative rotation angle). -`RZXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md index ac5b92a837e..f85e86c8254 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). @@ -90,7 +90,7 @@ Return inverse RZZ gate (i.e. with the negative rotation angle). -`RZZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md index 2f31cb8c401..823a4f8bf2e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md index 6205e0ff1b1..84c1f90d196 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md index 39dafb99cf8..5af27cad582 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). @@ -57,7 +57,7 @@ Return inverse of S (SdgGate). -`SGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md index 1ee0a76c765..c681575c30a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md index ebdf3a8770e..9aa7eef2187 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md index dd7732f601d..36e9d20daf1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). @@ -57,7 +57,7 @@ Return inverse of Sdg (SGate). -`SdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md index 7b5aa7feaa8..cba0ca71181 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md index e700f960e4d..db3eea03411 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md index bbddfdff0f2..907f7e0dfc0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). @@ -57,7 +57,7 @@ Return inverse T gate (i.e. Tdg). -`TGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md index ce83234bf4b..e3824566ebe 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). @@ -57,7 +57,7 @@ Return inverse Tdg gate (i.e. T). -`TdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md index ad931b9a8d1..d10f6b6460f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -134,7 +134,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md index 0fcc929f76b..6be66dd79ee 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -83,7 +83,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -105,7 +105,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md index 8dbe6a07d67..dbf69d179b6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md index a69aa7d5aed..6863f9effda 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -96,7 +96,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md index 16f8b8d2daf..a588af243bb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md index 41b02e63539..2d94c66a972 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md index 0cf66bf3077..f0d40ba6dad 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md index d6e2b1195cf..a86240373b7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md index 5d00a86799e..ddb5bc1b16f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md index d378f67a9b6..9bc00161206 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. @@ -86,7 +86,7 @@ Inverse gate. -`XXMinusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md index ac25436d40a..337f31ce50a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). @@ -86,7 +86,7 @@ Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase -`XXPlusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md index 8f4f8a2e5f7..94eb7049d04 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md index 437483cb036..081cac86ad7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md index bcc47dc0d31..ed03feca04b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). @@ -96,7 +96,7 @@ Return inverted Z gate (itself). -`ZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md index 08db3c66783..817a724ad1d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md index 537a2592732..39d5df7239a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md index cbc054b1f73..fe878c0871d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md index 4067d4099cf..0e7fe5a15f9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md index df5a5b13f6a..6dcce274813 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md index d6dab2fc07a..b03a3035831 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md index e5cb97250c1..9c83ff85b38 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md index 57c4ffbdf9b..59dbbef3dbf 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md index 11c7d5cd0e2..059587c2863 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md index 5eafc0a0abe..b1801eac2e6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md index 4838b2afc26..97eec849606 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md index 0f730a0a850..750f27c8414 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md index 32481500c09..4305b9c7d6f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md index f4c16715bca..37c3a2a9eb7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md index f13175b19b8..5030945f812 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md index b4e83cd6f30..b565c707a8f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md index 5db991f3aaa..80f71d0ee14 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md index 3509d7227e8..ce5beb27a8c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md index 92a08eaa2a4..e5f385d315d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md index 4d3b6311a5f..39307cb702b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -77,7 +77,7 @@ Create new iSwap gate. -`iSwapGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md index 2e7c58db696..34cbda2bf44 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md index dc512e4fad5..d1993b9377d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md index b430c7c7605..8ebf514777c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md index f6d631f440c..960e560d2c3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md index 8ddfd743be2..ec227cc0cfa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md index 4658b8ba613..84a2697df98 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 411cc2785bd..3dbe2fbb715 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index d4658054174..1ec00ffbadc 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 523b9ca1ee1..dc5e045b707 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index ba9d086e738..547fda45d28 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 97efbb86e96..71c1fa7cf2b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index dcfb88a2083..f17a3a11589 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index eb681b27915..7977d0ecfe6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 7716596b8c7..3b7c4b401e9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 2030aff311c..f07d7360644 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 4f995a87f7e..ee854c45e50 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 63d67446d01..9bcd5b661f7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index d3feffedd4a..6bc79299d26 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index d5df5a4840d..ead2358ed20 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index f6ceda17a34..ca8f1e625e6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 3c69aeb9710..ac504aaf766 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 28c6c50f977..10a09d46fad 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index e9ace7e9516..46dc1c8cd4f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index a7b7b028d63..501c28a359f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 101eb025fac..6bb70c6426a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 0b99372f4f1..116c8706000 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 063a1019dd8..eec5c1da56e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index a9450c13fb0..4003eb8e2aa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 57f5f89602e..3d99e9884a6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 7add567d79f..b436afdb0e0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 4d21f1ecea0..36aef9e7525 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 912f691818a..8c2be8ce09c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index b14c7c34ad1..12ac7737910 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 190aaf00371..058d34cc91a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 6d8196a357f..a4bff248d51 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 6e8b04ad1e3..5db881bee9a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index cb3aae6bda2..a3886765e61 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 1a502f14d60..55e9f2a4172 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 01cbe2f3259..8713945b288 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 55191519877..a389764e230 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 3e604d8aae5..b3af7d6f6b4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index d755e41e8c5..7cc9126971d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 7db3309ec76..bfd297827eb 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 640bdd2e40b..f90983de338 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 4f16e108b89..13585ff1724 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index 95efa766d85..13f091ff347 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 9547a53343c..e408b3b3527 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 230d5ad3387..9213072f884 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 9e2d4cbe7e4..ebc28a69c32 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index cf0ffb26b11..c704a176587 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index b59fe428856..599696c96e0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index f05dbd7d8b5..0b9ad3ae335 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index da1c5d8c7d5..8337f735b16 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md index adef361e2ea..d1b90828f66 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.41/qiskit.compiler.assemble.md b/docs/api/qiskit/0.41/qiskit.compiler.assemble.md index 7e6785ebf9b..cfcd3d0bf51 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.41/qiskit.compiler.schedule.md b/docs/api/qiskit/0.41/qiskit.compiler.schedule.md index 2a8358979da..0ad32ddd7a7 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.41/qiskit.compiler.sequence.md b/docs/api/qiskit/0.41/qiskit.compiler.sequence.md index 46db9f61083..b63196cd566 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.41/qiskit.compiler.transpile.md b/docs/api/qiskit/0.41/qiskit.compiler.transpile.md index 0e4a3bcc7d8..2af172819a9 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md index 2aad366d4d2..d69383bf5a9 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md index 4feea0a45a9..b0de4e02014 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md index 1e567ee1a25..46a0891af60 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md index dca1b2e68d8..beb2948c541 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md index 30931b78b80..4ba61af4d1a 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md index 55d5d484fdf..6a54d21faeb 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md index 647d2503827..b5d5955a010 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md index cdb6a6fe1f2..b40d7999104 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md index d9b24a128f4..64f03ce9732 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md index ff178b6d025..70bff723d32 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser -`BlockCollapser(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollapser(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class implements various strategies of consolidating blocks of nodes in a D -`BlockCollapser.collapse_to_operation(blocks, collapse_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollapser.collapse_to_operation(blocks, collapse_fn)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") For each block, constructs a quantum circuit containing instructions in the block, then uses collapse\_fn to collapse this circuit into a single operation. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md index 0ea27eb7ae8..0f480a78d4f 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector -`BlockCollector(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ In general, there are multiple ways to collect maximal blocks. The approaches us -`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Collects all blocks that match a given filtering function filter\_fn. @@ -50,7 +50,7 @@ Returns the list of matching blocks only. -`BlockCollector.collect_matching_block(filter_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector.collect_matching_block(filter_fn)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Iteratively collects the largest block of input nodes diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md index 13bc803029a..d25d21dff6d 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops(*, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops(*, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -248,7 +248,7 @@ Mapping\[str, int] -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -258,7 +258,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be staticly known. @@ -283,7 +283,7 @@ int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -291,7 +291,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -315,7 +315,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -337,7 +337,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -345,7 +345,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -361,7 +361,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -369,7 +369,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -389,7 +389,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -397,7 +397,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -405,7 +405,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -419,7 +419,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -427,7 +427,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -435,7 +435,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -443,7 +443,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -451,7 +451,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -471,7 +471,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -483,7 +483,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -504,7 +504,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -512,7 +512,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -520,7 +520,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -528,7 +528,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -549,7 +549,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -557,7 +557,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -565,7 +565,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -573,7 +573,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -581,7 +581,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -589,7 +589,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -597,7 +597,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -613,7 +613,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -626,7 +626,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -634,7 +634,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -642,7 +642,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -650,7 +650,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -660,7 +660,7 @@ Add edges from predecessors to successors. -`DAGCircuit.remove_qregs(*qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qregs(*qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -673,7 +673,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_qubits(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qubits(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove quantum bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -689,7 +689,7 @@ Remove quantum bits from the circuit. All bits MUST be idle. Any registers with -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single node. @@ -718,7 +718,7 @@ The op node that replaces the block. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -734,7 +734,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -744,7 +744,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be statically known. @@ -768,7 +768,7 @@ int -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single operation. qargs, cargs and conditions for the new operation will be inferred from the node to be replaced. The new operation will be checked to match the shape of the replaced operation. @@ -795,7 +795,7 @@ the new node containing the added operation. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -822,7 +822,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -830,7 +830,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -850,7 +850,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -872,7 +872,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -880,7 +880,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md index 388202e6b04..3a66e03254b 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md index 5f9cb4a3aa5..c4163021eed 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md index c01ae8d158d..9d18531b26c 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Replace a block of nodes with a single node. @@ -326,7 +326,7 @@ It is important that such consolidation preserves commutativity assumptions pres -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -334,7 +334,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -354,7 +354,7 @@ List -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -362,7 +362,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md index aa28a3cb373..f994eef6bce 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md index 7bef1e4c88c..13c59da06cf 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md index 7f9f85795fb..c1f117f1230 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md index 30edf3e38a5..63e063fb756 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md index 32de719c924..a4d0a22ba25 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md index bd56ab00cc5..88027e6ce5e 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md index d280020ae1f..c10522473b0 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md index 92c4998e5b8..2c487c5b8b8 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md index 12a96968c46..8bef0385e54 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md index 3fe670fee26..0ed8decb4ff 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md index d9e0b5ecd18..16e1e8566e4 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md index d6e014491de..b8538645b9e 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md index 30a4c03baf6..c8ba837e900 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md index a7ae52d9bbe..8e9591940b5 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md index 47086c22c0a..e1a051da997 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md index e86d190e5a6..0bf60ccbede 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.commutator.md b/docs/api/qiskit/0.41/qiskit.opflow.commutator.md index 6e5fb07c794..de3db2a936b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md index 0456cb9f228..b50ddd6ac63 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md index e523e883979..f69f0b8e7da 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md index 89d850ea221..b939a7ee84c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md index b1fd067d35a..fb4275ddb08 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md index f8678989b8f..fb3f4c405e4 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md index 48a26ed1dfc..0b6014ef7e3 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md index 49bc33b09d3..57cdee0cd5c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md index bc2d0ec43fe..6503fc8b132 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md index 5c1a7c4d2e4..c402166b50d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md index 988287f5196..4c4692ea9a5 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md index 71be240cd87..09773cd7848 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 5acd3002e0e..05d6d07b191 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md index c24f7f74c40..00732188163 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md index aa15f120663..a4838377415 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md index 0d2699444e7..2d349b70ef1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md index be305bd5371..5d43d7a3e7e 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md index 3236f7fc463..49b2c765949 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md index 7ac480f3b1e..55087d2ba78 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md index 95203092f19..8f9d3257ff2 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md index f0dd5f714b1..55a07a1ab66 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md index 422b0f08822..3f267c0ca7f 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md index 3c83c73b555..655ab3ada51 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md index c945ea94df6..1545f97490c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md index edf49889deb..166fd5493a5 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md index 761a18e157c..4cdfa384744 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md index 0549fc2ae7a..ad762c30a89 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md index 3294ac63cb5..20f5ca9281d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md index 6b7e9407b3b..7424e36b226 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md index 8d4591e2265..d1f2ccb708e 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md index 808e372cdf0..ad4fcbaf95c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md index c9f06c5223a..55fde925d2b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md index cbdba232293..a615691da71 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md index debdbfbda2d..9d39541b757 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md index 8431a1a737d..0b356164aee 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. @@ -152,7 +152,7 @@ The circuit representation of the composed operator. -`ComposedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md index d45f5857737..6f515bf905c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md index 1b8544b3c88..60cd4821326 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md index 4c517541af1..8624aea4b18 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. @@ -116,7 +116,7 @@ The circuit representation of the tensored operator. -`TensoredOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md index 062a69e7163..3804a13b2ad 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md index c20e731be22..e14ec072d34 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md index 680201e9cf7..5ef1f586264 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md index 4ecb200319a..0641d7a6840 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -172,7 +172,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -182,7 +182,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -194,7 +194,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -216,7 +216,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -236,7 +236,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -260,7 +260,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -297,7 +297,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -321,7 +321,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -333,7 +333,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -349,7 +349,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -361,7 +361,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md index c8fec82620d..7d54734a567 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 181208b7e3d..5763f55a9b8 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md index b7aef50f839..35d014df5cf 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.convert_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -82,7 +82,7 @@ This method operates the first part of the tapering. It converts the operator by -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -90,7 +90,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -106,7 +106,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -114,7 +114,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -142,7 +142,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.opflow.primitive_ops.Z2Symmetries#convert_clifford "qiskit.opflow.primitive_ops.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md index 61328732ac2..43e382588be 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md index 37207aa05e6..3d595d7ba45 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md index c7d0ae099bc..56a45714f83 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md index 3b9d59486b8..b0805f42fb1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md index b713aea4165..93c72302e73 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md index 70a5da7a4b5..e1d2a07cd20 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md index 4f7ff608921..e22f6cd0c1b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md index 2880480a49a..30014d312a3 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -96,7 +96,7 @@ Set options values for the estimator. -`BackendEstimator.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md index d7fc0f78865..8c7184c8302 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -79,7 +79,7 @@ Set options values for the estimator. -`BackendSampler.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md index 01c32fe8abb..7a4b72db58f 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Close the session and free resources @@ -45,7 +45,7 @@ Close the session and free resources -`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Run the job of the estimation of expectation value(s). diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md index 37519392c28..c897ad5dce7 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -34,7 +34,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Close the session and free resources @@ -42,7 +42,7 @@ Close the session and free resources -`BaseSampler.run(circuits, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.run(circuits, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Run the job of the sampling of bitstrings. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md index 9aaafb990d9..a6bb0bce788 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -38,7 +38,7 @@ Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "q -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md index e0929a1e689..0cf195db090 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md index f14c48ceca3..6ddfb1b5ee3 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -39,7 +39,7 @@ Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md index d07f2dc6672..2a9ca29eeea 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.41/qiskit.providers.Backend.md b/docs/api/qiskit/0.41/qiskit.providers.Backend.md index 18e60ad5e81..3ea7b914146 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md index 83a8dc76c25..e729579e73a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md index 9563703aefa..237d5d813e6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md index ff1ae490b38..93cd7e7a5c5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -45,7 +45,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -67,7 +67,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -95,7 +95,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -117,7 +117,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -139,7 +139,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -165,7 +165,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -188,7 +188,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md index 5d039f69646..26e0d1dea7e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`BackendV2Converter(backend, name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter(backend, name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -32,7 +32,7 @@ Initialize a BackendV2 converter instance based on a BackendV1 instance. -`BackendV2Converter.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the acquisition channel for the given qubit. @@ -54,7 +54,7 @@ The Qubit measurement acquisition line. -`BackendV2Converter.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the secondary drive channel for the given qubit @@ -82,7 +82,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2Converter.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the drive channel for the given qubit. @@ -104,7 +104,7 @@ The Qubit drive channel -`BackendV2Converter.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the measure stimulus channel for the given qubit. @@ -152,7 +152,7 @@ qubit\_properties -`BackendV2Converter.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Job.md b/docs/api/qiskit/0.41/qiskit.providers.Job.md index be4d4d20fee..62083094139 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobError.md b/docs/api/qiskit/0.41/qiskit.providers.JobError.md index 9f780d95c92..5c6fd2ab2dc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md index a4b6663259e..9b26c865247 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md index 904562b003d..9f09aa4f3a8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobV1.md b/docs/api/qiskit/0.41/qiskit.providers.JobV1.md index 9d3cffe0b57..bdc3e2b9a07 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Options.md b/docs/api/qiskit/0.41/qiskit.providers.Options.md index 40dd58c566b..f7e164034bd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.41/qiskit.providers.Provider.md b/docs/api/qiskit/0.41/qiskit.providers.Provider.md index 25a66ac2c3f..045d61a00d4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md index 4cb8cf018b1..67c067e829b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md index 706d8d392e2..c011e7f8fa5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md index 4542d93aadb..3deb7c94353 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md index 56e1413bf32..46dd3f4e991 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md index a39510f0233..f0dd6227064 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md index 964d67a213e..ffd8fa17ec9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md index 7e3f7048c76..e672d7b7cd1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 004db3ccca5..56d85bbdeed 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md index e041336f8de..60fc64ba91a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md index c46def02bd9..041b625b375 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.convert_to_target -`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 9bbe2efd197..dc7cc2deb12 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md index 8d594a5d8c7..67f4198c1a1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md index 97d30fd5936..91014c4d586 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md index 8c6a1b169dd..9c15bcedeae 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md index d64672ed455..3e9033f8993 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md index 593a3f6e1e9..9c773f90b7f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md index dee5feae2ad..cc46baee0af 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md index 066bc4f5075..5729c79fa63 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md index c97fabc05c1..189f65c0400 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md index 9ef203b53d3..33e6f83dcc1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md index d7eb853cc50..d95bd1e007d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md index 24b299479a0..79f13aba2c5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md index c26723a5361..3c5be60acf1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md index 22d821f3d25..426c04fae62 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 3cf34405dbc..61e9fb9434a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md index d841c3560c8..8e691b01277 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md index f3ea6bf178c..c746d8d770c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md index 6bc1208ebd3..842c5272a77 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md index 2bce1cc001b..3ad72bc071c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md index 75df2efed43..56c46c054b5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md index c54b5e1a37f..12d14a3736c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md index 73dfd91f137..4ba003b7b70 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md index 7da0caa832e..b38fc3fe5c5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md index c2c68106766..33201891707 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md index 56dd58ddcfa..00126d23019 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md index 8baeffee498..afa533c41ed 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md index 46f12132c29..c64150726b7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md index 74585894ad8..4d353be6ea9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md index 9d2149d7e71..64ac18f353c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md index b334fd24c68..5a87d3ad6d6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md index d44da06e21e..5e591ea665e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md index 9214437bbc2..d7be337f41a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md index 78df172b18b..cc4049a9c96 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md index ba740afea96..0f564169bf4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md index 32d971597b5..a6cdeba49bc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md index 69d32b8bf80..9c563bc6fd1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md index 456a82ff4b1..29e7d37a07a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md index a873bcb8334..aa5e36173e1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md index f4f37145c8a..5cbfdd63a85 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md index 026564eb148..c27f858e18c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md index d1916d4c750..3a1c7448bb8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md index ffde37f6f60..4350bd3fef5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md index 2931b4d6e7c..333739c02e0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md index 5fb7ac2df41..873ee9fc8fc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md index 8c39eaef396..1108e435f8b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md index 9d22cfbdaca..33ba9dbbebe 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md index c349edd6143..63e84021726 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md index 4555cafdae9..48746e3deb7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md index e504670663e..325397b38c7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md index 36eff58cd35..ae8be2ba3d1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md index e1fc2030837..b7435b776fb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md index 9821cc122fb..1288fe30eb4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md index 96bc87423e4..a44dd7ca968 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md index 843cbd9b08c..3f550d15adc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md index 9f2ee0eacbf..60934f4ff6e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index bcee926beda..6d8362d50ab 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md index b540e939c86..143c29f005e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md index bb93bb14f02..445be79a2d2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md index c2b3df68f70..dc5666c7ff3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 1cdd8301ef5..177d8a5de92 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index e2bede2330b..dfb21b83e98 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md index 8bfc3d057ad..0be75c0191d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md index ba842fa11a0..3cdc7bdac88 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md index adff695a4cd..0ec66a3c1fc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md index 0008e7f2c24..c18ba2a8ee5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md index e27a9f8070d..09b6a1ecf40 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md index f352249466e..aea941054b9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md index ca0e6f34384..07bb2948bcf 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 256a1bf08b1..3c59341eb30 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md index e2c1bda1b89..1d691024550 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md index 9fe4b563e54..d4c0500a8a2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index 857824cbe28..955888900a3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md index 327ea9712dc..809d8828258 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md index d7631210be5..a30f1b9b00c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md index e3f9ab018c0..bc65c62494f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md index 4083d8b5810..7e15127787b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md index 3224cd37757..5d9ae3f2096 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md index bda625625e0..bc60803db6c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md index 07afc5080eb..374ef4f08e3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md index 83fe3fc50a9..ec7450a3548 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md index 0a9cda4b1b7..e020b01e98b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md index 894541fbcd5..765cb88a8e1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md index 9e48023d5fd..1aaf1207d98 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md index 9dc4a0cfb9d..9f1d17b999f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md index 2855f535d10..d57442a45f6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md index bfd7b52a9c2..d1d29800c84 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md index 24f19f6c7da..4e7b3691cb4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md index d22938870ea..c34a64ee3d2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md index adbd05d19c8..da9a3ed0678 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md index f822a7771d4..f5b7d826952 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md index 9d02a92cff6..3a198a75a40 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md index ef73876d251..c0186bce3bd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md index 1e3538c25c2..527002ac936 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md index 0b1edf89806..fa7b01ac026 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md index baf56833f21..394f4357fb6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md index 57412e8b871..b685c2085bd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md index 32513514c60..1d49f3848cc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md index 9bde741d22a..03ece87de60 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md index fe6ece2e004..a73e7097d93 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md index 0e6c0e0b596..806a82cfdcf 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -81,7 +81,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -150,7 +150,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -178,7 +178,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -220,7 +220,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -249,7 +249,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md index 17a8f280a65..3a9e9ac2018 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index b25d3ec7ab7..d7a64cdb999 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index cd6a57baa8d..c1a12a8a02e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 8ea00a97320..002fd31583d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 84b8de0ec65..b7ac5c522bf 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md index 643bf92da68..387e583fcb6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index c25adb85512..e88d0d6afc0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md index 9491167cd42..88c4c11f758 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -72,7 +72,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -98,7 +98,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -122,7 +122,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -148,7 +148,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -188,7 +188,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -278,7 +278,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -331,7 +331,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -361,7 +361,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -390,7 +390,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -418,7 +418,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -537,7 +537,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md index d39ddfcd6e6..5042fe266a6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 2cef57dcf88..5271337feb9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md index fa201148834..885d9a33836 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md index 6437c787f0b..bbb23ed6a64 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -102,7 +102,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -156,7 +156,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -229,7 +229,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -249,7 +249,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md index 19ddfe141f5..e9ff97473a3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md index 3eb1eac3cd4..8d9c8976a02 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md index df5dabdf140..49aec72eb3d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -52,7 +52,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -74,7 +74,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -94,7 +94,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -143,7 +143,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -173,7 +173,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -201,7 +201,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -227,7 +227,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -272,7 +272,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -297,7 +297,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md index 0e16c7d54d9..f80dbe6dbe2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md index 591b45e5673..ada2e858b40 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -68,7 +68,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -172,7 +172,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md index d36957508be..2f03dfbee99 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -71,7 +71,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -87,7 +87,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md index ed6bef01122..864ef3c2fc0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index a184675e58f..0a73edca6a3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 2b452ff59ce..d01c42a744b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md index 269a5f73272..22d2bd6cdb6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index a925238e2a5..06cfb3d5867 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index 52f23f2551a..7341357d8da 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md index eb24ac04da6..121f5bbaba7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md index ae7b128cb28..f64556301c7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -70,7 +70,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -100,7 +100,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -170,7 +170,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -190,7 +190,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -229,7 +229,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -288,7 +288,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -324,7 +324,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -352,7 +352,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -380,7 +380,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -409,7 +409,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -437,7 +437,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -467,7 +467,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -553,7 +553,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -584,7 +584,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -610,7 +610,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -642,7 +642,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -691,7 +691,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md index 056c0844049..f45a311125e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md index 1d8e683a115..771adeb0eae 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -103,7 +103,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -125,7 +125,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -169,7 +169,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -189,7 +189,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -225,7 +225,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -245,7 +245,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -281,7 +281,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -301,7 +301,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -321,7 +321,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -345,7 +345,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -369,7 +369,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -395,7 +395,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -423,7 +423,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -445,7 +445,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -515,7 +515,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -539,7 +539,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -561,7 +561,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -593,7 +593,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -617,7 +617,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -637,7 +637,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -665,7 +665,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -694,7 +694,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -738,7 +738,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md index 4df34a82064..b91dcfbf8be 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md index bb6d202f593..ae83cb376ab 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 3d85b78c2a7..1469089add5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 0ecbcbb394f..f456f47f054 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index c1ead0ab020..9ea63fead5d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md index 25ab198806f..d0317fdc106 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md index 02258c0e57f..9bae3fa8d96 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md index 6f2ab3d12b5..e3d03e8b2a3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md index 3c2aa084a88..04da8a7f696 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -95,7 +95,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -119,7 +119,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -150,7 +150,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index b42a0ccb577..6041ab44197 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 2746e10a94b..259f582afae 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 56eed9caa99..f287a0945e5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index a4cc22c11d8..d81bc7d5cdd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 3760f58b8c8..0d445a6fc94 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 3a3db678e9a..4b8c653398a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md index b0bf23bce54..1fb050e8496 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -54,7 +54,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -74,7 +74,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -94,7 +94,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -124,7 +124,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -144,7 +144,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md index cad9e0246fa..24851681cab 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -55,7 +55,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -77,7 +77,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -114,7 +114,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -134,7 +134,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -154,7 +154,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -174,7 +174,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -194,7 +194,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -214,7 +214,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -238,7 +238,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -289,7 +289,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -315,7 +315,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -344,7 +344,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -364,7 +364,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -384,7 +384,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -408,7 +408,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md index e498b520a46..a223237914c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -82,7 +82,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -118,7 +118,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -147,7 +147,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -176,7 +176,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -206,7 +206,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 20296614cd4..771408066d1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -79,7 +79,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -106,7 +106,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -131,7 +131,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -160,7 +160,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -187,7 +187,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -209,7 +209,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -232,7 +232,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -264,7 +264,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -292,7 +292,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -335,7 +335,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -361,7 +361,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -394,7 +394,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 8836dda57db..cc1278fd918 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -38,7 +38,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md index d10f5c2176d..a4fa8374c47 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -146,7 +146,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md index 6e759e9e2f5..aaa7c69817e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index 2948506732f..5e359114521 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -54,7 +54,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index fb09a789926..1e945e0919c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -48,7 +48,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md index 64c1788ecd1..b1844b49776 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -83,7 +83,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -104,7 +104,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -120,7 +120,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -140,7 +140,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -160,7 +160,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -188,7 +188,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -218,7 +218,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -238,7 +238,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -269,7 +269,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 00bbef1ab94..ca3f33aa344 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 08a9c28e13f..c35a33bee20 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -65,7 +65,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -89,7 +89,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md index 2b4d47ecec2..3838341f5b0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md index 41ee02fe391..f53110a8d43 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md index 134192118f7..29e5961f6a2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md index 9b184dae9c9..d89a39176aa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md index b9c254dcc61..1ed5dfb00f1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md index caf5d797c8d..1873f45b3de 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md index 03d432ab1a9..e597c938891 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md index 23442453c57..7525fa58c41 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md index 3e752eebd6e..a437d90d01a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.Command.md b/docs/api/qiskit/0.41/qiskit.providers.models.Command.md index ff4919d535c..699b19574ae 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md index d18bea2eda0..36991ea65c7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md index efaf5a8685d..b5cced46263 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md index 3d2327ada84..e4998fa485c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md index 9cec55a818d..fd21ef280ec 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md index e11f0ae4e07..9ea71ee1fdc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md index ad04506ab73..6b2a53d276c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md index 2bb3499aca8..6ba40a8b4ba 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -101,7 +101,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -122,7 +122,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -143,7 +143,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -155,7 +155,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -178,7 +178,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -200,7 +200,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -224,7 +224,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md index b5ffc39f0ba..c4619232171 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md index bdad0d68765..da3ee9c3efe 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -166,7 +166,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -192,7 +192,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -217,7 +217,7 @@ Schedule with updated parameters. -`ScheduleBlock.assign_references(subroutine_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_references(subroutine_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign schedules to references. @@ -277,7 +277,7 @@ Schedule block with assigned subroutine. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -339,7 +339,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -372,7 +372,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -403,7 +403,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -443,7 +443,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -468,7 +468,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -480,7 +480,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_referenced()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_referenced()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the current schedule block contains reference to subroutine. @@ -492,7 +492,7 @@ Return True iff the current schedule block contains reference to subroutine. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -504,7 +504,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -526,7 +526,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.scoped_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.scoped_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return unassigned parameters with scoped names. @@ -542,7 +542,7 @@ Return unassigned parameters with scoped names. -`ScheduleBlock.search_parameters(parameter_regex)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.search_parameters(parameter_regex)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Search parameter with regular expression. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md index ddea77147e4..0ebbfcbc060 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md index 4740c15d574..314c2b2a10b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md index 70f5c6b76db..b66843c6f16 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 85676e5fbe7..f5400d203e3 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md index 8c050eead2a..f32e2b52cba 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md index 65ee92284fe..aadd87968ca 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md index 9232696c643..2292ae3d18a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md index 46e39b38363..446ecd7ff62 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md index 85ad4f1cf25..2194a18b04f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md index 32c77294ee5..0ba2a42cf86 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md index 7c518c47f59..a2059dfc11f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md index f5a80ba9fb6..af3d3eb6c9b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md index 289f4989ed7..b8c5778cb1d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md index 2690f31f73f..ba7787a0be2 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md index f8f0dec1afe..2c96ac58364 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md index 18cc9c86811..d82c5273f13 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md index 3bfc0a741ca..217759615b4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md index b0d443000c6..1be65e269f2 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md index 4cc8985420a..f17619f438a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md index ab753bbf02d..3edc20543db 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md index 4ae5f943ab5..a36454365cd 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md index 32d745d26a8..9b021c089aa 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md index b2a6a0b8364..9ccdf20d6b1 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md index 64db9937675..3ccffe81655 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md index 554699927d6..621cff23924 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md index 84990b4aaa8..813325930c5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md index 5538e667f20..b083ecfa413 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md index 09565a65d28..9a820a671a5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.reference -`reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md index 64f1c6dde90..8b0e59f4ba2 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md index d8ac9114603..69aceaf9319 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md index 6531e9ad6b4..4197c39af10 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md index 28764fb92a6..d218e291d9d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md index b86679ed11d..75f229e5e46 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md index 78a344c1396..a5382fa3c11 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md index 459cc11755b..de5bad56d6f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md index b86e8ce5c27..f36ee8c6f66 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md index 70b53383520..362007b9018 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md index 5689e9208c3..7e7fbc4653f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md index edd35910dd0..05b3a3e9544 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md index 50e44d8ee87..822353f3e65 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md index 9400a701fcc..45dbcde7a39 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md index cd5282bfb3f..91f4190a807 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md index 84992f7a95f..bb41895914b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md index e936a32c145..cfe059a17f8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md index db97a471ae8..2c7605d2136 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md index 20a0d97ee87..53e159d873f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md index 45dfe1c0bec..5b8d7c075c4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md index 2191c4ae4c0..8770200a38e 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md index d3685c1768c..17af2b30b66 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md index 6abf0349858..b52b069edf0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md index e81acb82b14..6d8547af3ef 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md index 3dcba26e566..ba8067c2437 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") +`Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md index e8cbe6f7f77..a22211e063c 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") +`RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md index fc1bb6800f7..05633d42eea 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md index afb67fae325..2e29282e996 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md index 45312883111..8f45c1f5c93 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md index d2346399342..c0fcb16d449 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md index 9839824acd5..88308e8cb7b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md index 1ed2e91bdb3..d5a04eebd09 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") +`TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md index 29561260fa0..75f005f9614 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md index 2b6e9dca0a5..22cb3d82c92 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md index 8a0f7d07ad4..ce0d87d056d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md index 4a1c157da9e..005a32c32f1 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md index acbc560e389..9534cdce9c7 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md index 8a9d14e75ed..78c1ab8e881 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md b/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md index f0070f1fa30..e2bd0ee7371 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse -`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md index aa9e7a3dd0a..546ee391334 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -159,7 +159,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -186,7 +186,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -198,7 +198,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md index d2e2833ba34..baf3efa225a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md index 4f10e688a06..c872edb8c0c 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md index d72fd09553d..a6cfa84e80b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md index 9443df2c001..0fbad854987 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md index f9c0cd826cf..759db57ac93 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md index 2bfc83e8347..64f99a12b4a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md index a1beed16e39..8170bb0fe73 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md index 20d23ba6db8..fe643787be3 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.square.md b/docs/api/qiskit/0.41/qiskit.pulse.library.square.md index a94da2f4f97..f2971a7bd98 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md index 8a15ca1af2b..60e70b8ecd2 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md index 63ddb1835a4..100b3ca756f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md index ab37294e2c0..d6792e1d865 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md index 3533b01d489..c0ed60a47f6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md index 95dc46fa569..ad052551aec 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md index 614bbd5203d..363a87257f6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md index d126a129ee6..ea5c8a90d41 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md index 93ac699254f..aeafc86694d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md index ecb1edc1670..2a797760ccc 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md index 31b1e46df66..72bf309368d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md index 7e27aedcf7b..c1a9f0f5793 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md index df3c3645df8..082a0982735 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md index 26a4ecd06e3..cf86924864f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md index 49a462a6d7e..81572cb8a85 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md index 2646f0c9e5c..e42a68e50fd 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md index abba51e324b..89adb88b8da 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md index cd17656eac0..5bb8a1eaa0b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md index f884d7f88df..8bcfb76a998 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md index 277a17572f0..730f35d42aa 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md index 8b967c56cbc..9974221c41a 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md index f46e5034371..76beddf5222 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md index 87382e3a5ac..09de69c1c07 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md index 28c44e92bb1..cf40a13868f 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md index 589e7c5f277..c882791084f 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md index 2f24a336726..28a0da5e4b5 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md index 11d6ef7a31b..57489fa5b4f 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md index d2cf0167942..bdea2468934 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md index 8c903a06dea..601a1532fd3 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md index c5fbe60c869..eb81f8b2d05 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md index b04251e571f..f2c28cffba8 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md index d86cb15111f..ee37d0324d1 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md index 99ccd488add..ff2b6087515 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md index 3e51cfeecc5..37dfd6e29c9 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md index 7c26e8cd34b..e31126b3359 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md index 3c0e32aab9f..d4d925d48b4 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md index ed61b696cc7..b949164483d 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md index 3d0ab5f74d3..479ab7575c7 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md index 798b1649b61..4b990e1c902 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md index 4004a4d4b68..f34a4e4b725 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md index 7d0288e4291..40c29287b13 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.41/qiskit.qpy.dump.md b/docs/api/qiskit/0.41/qiskit.qpy.dump.md index fe1c9056406..c39d85fd2d8 100644 --- a/docs/api/qiskit/0.41/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.41/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.41/qiskit.qpy.load.md b/docs/api/qiskit/0.41/qiskit.qpy.load.md index 7df78086f70..52bfb57c427 100644 --- a/docs/api/qiskit/0.41/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.41/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md index f96d196e511..10071011251 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md index 91c327f32eb..5c3eb978bfe 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md index d212d17052e..59f643470c3 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md index 37ae598234c..1f28b5b47a9 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin`, [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -123,7 +123,7 @@ Return the conjugate of the Clifford. -`Clifford.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Make a deep copy of current operator. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`classmethod Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_labels(array=False, mode='B')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_labels(array=False, mode='B')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert a Clifford to a list Pauli (de)stabilizer string labels. @@ -437,7 +437,7 @@ list or array -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -445,7 +445,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -453,7 +453,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md index 50cfbc83179..cf09b1ee06f 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -600,7 +600,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -608,7 +608,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -635,7 +635,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md index 4542b246e39..b8ebdf08ef0 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md index 3abf9fd282e..39def6002c6 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -72,7 +72,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. @@ -92,7 +92,7 @@ tuple -`OneQubitEulerDecomposer.build_circuit(gates, global_phase)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.build_circuit(gates, global_phase)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the circuit or dag object from a list of gates. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md index 2206cf56c8b..f93d1b2cfd8 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -202,7 +202,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -238,7 +238,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -254,7 +254,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -304,7 +304,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -322,7 +322,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -348,7 +348,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -356,7 +356,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to NumPy matrix. @@ -364,7 +364,7 @@ Convert operator to NumPy matrix. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -372,7 +372,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md index c2e255b98af..dd8e7406ee1 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md index 21b8cce21d7..a1fb315b744 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md index ac85fb782f6..2c6fda58c9c 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md index 2deff1d17db..7502b1cf412 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -582,7 +582,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -622,7 +622,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -651,7 +651,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -681,7 +681,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -689,7 +689,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md index dadfbb98453..f5cfe627ee4 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md index 3eb55199958..4c33d364797 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md index 83967a82b4a..6d1dfcea294 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -74,7 +74,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -82,7 +82,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return indices for sorting the rows of the table. @@ -152,7 +152,7 @@ array -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -176,7 +176,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -208,7 +208,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -249,7 +249,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -270,7 +270,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -292,7 +292,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -330,7 +330,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -358,7 +358,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -405,7 +405,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -448,7 +448,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -469,7 +469,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -487,7 +487,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -567,7 +567,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -588,7 +588,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sort the rows of the table. @@ -661,7 +661,7 @@ a sorted copy of the original table. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -689,7 +689,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -715,7 +715,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -737,7 +737,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -757,7 +757,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -765,7 +765,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md index 79887299f03..2e195282891 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md index 0b597618db1..bba7aa75c71 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -632,7 +632,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -672,7 +672,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -705,7 +705,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -747,7 +747,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md index 012faca5a21..6086003f1b6 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -116,7 +116,7 @@ sv.draw(output='hinton') -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -142,7 +142,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -167,7 +167,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -191,7 +191,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -212,7 +212,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -238,7 +238,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -266,7 +266,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -299,7 +299,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -323,7 +323,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -355,7 +355,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -453,7 +453,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -461,7 +461,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -485,7 +485,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -565,7 +565,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -589,7 +589,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -660,7 +660,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -668,7 +668,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md index dde447577d0..72ce3cba3df 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md index 20bc3a33619..2b70ab59c54 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 2eb121a3e84..ed30b833e35 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md index 4502672b04e..41008b55f09 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md index 68b7ee87ff1..4c634359363 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md index 462b4510c77..8fbb8ebd566 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md index 15a58126750..a327506a102 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md index 4936b0ed129..0a3fbe5a1d2 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md index fb3690b3339..e12c9da1c4d 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md index 4db0623c210..0a1ce28209c 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md index bd50ef1b1f3..b0d21e55214 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md index d112e6e18eb..0b3ee96fc38 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md index e42f1e60347..5541b159c90 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md index 78bd05e08b2..0647dd165d7 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md index a5270830cd9..13b64aed669 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md index 924486e0a87..ed47b8fc384 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md index a8b83a95f9e..25f867150b4 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md index 721d246209e..ca8b1cf76b4 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md index d780529e235..e02d97989f7 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md index 593d64f4d0f..77349e50bcc 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md index 3ca0fd49e5d..058d667a5ce 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md index 84fc7189411..d16fcf9868f 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md index d0919d4f951..dece2d04e34 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md index 6574676d30e..7354dc4c3b8 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md index 72695d21f9b..80697d3de2e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md index 8e68bd61b9f..e5576b9adf9 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md index 0169f9727cb..2e7fefffb9d 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md index cce3ed138ff..2fea823b9be 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md index e80e975f973..c1c9cd87c14 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md index 9f2d208b746..12664888216 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md index 4d84e302629..13e96697dbe 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md index 92980da2fff..1df3c2c2df0 100644 --- a/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md index e90496ce5bb..045f1b24e9a 100644 --- a/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.41/qiskit.result.Counts.md b/docs/api/qiskit/0.41/qiskit.result.Counts.md index 7c496d84975..d5163fdefe4 100644 --- a/docs/api/qiskit/0.41/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.41/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md index 3a5c5fe1cb8..107c90ab6d4 100644 --- a/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md index 8152f25e4ab..5f43730ad42 100644 --- a/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md index e6d5af563d4..335a080d578 100644 --- a/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.41/qiskit.result.Result.md b/docs/api/qiskit/0.41/qiskit.result.Result.md index 20b6e521d37..5f2f2755888 100644 --- a/docs/api/qiskit/0.41/qiskit.result.Result.md +++ b/docs/api/qiskit/0.41/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.41/qiskit.result.ResultError.md b/docs/api/qiskit/0.41/qiskit.result.ResultError.md index 5bdc8f10cc3..c895b528a26 100644 --- a/docs/api/qiskit/0.41/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.41/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md index 1d92d6fa354..a00214b1d87 100644 --- a/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md index 50fc45b68a3..ab34cd0bfd6 100644 --- a/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md index 90da19986ed..82f3e3cbe6e 100644 --- a/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md b/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md index 9ae734e4bf5..9f4f50b50ad 100644 --- a/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md +++ b/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.sampled_expectation_value -`sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") +`sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md index 7c9c0f199da..41a349955d8 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md index 26150641b6f..b5b75ccec28 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md index e8c9f0fc2ef..585dea0de89 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md index c6465577a9b..5b6cd42fe7b 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md index a4bf83b6681..286f6aa5327 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md index 53da5f61b78..7783e8353b8 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") +`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -33,7 +33,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") +`QDrift.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md index 7cc7e996aa4..2b0829e406b 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class is called recursively by the transpiler pass, which is why it is sepa -`SolovayKitaevDecomposition.find_basic_approximation(sequence)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.find_basic_approximation(sequence)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Finds gate in `self._basic_approximations` that best represents `sequence`. @@ -48,7 +48,7 @@ Gate in basic approximations that is closest to `sequence`. -`SolovayKitaevDecomposition.load_basic_approximations(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.load_basic_approximations(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Load basic approximations. @@ -72,7 +72,7 @@ A list of basic approximations as type `GateSequence`. -`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Run the algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md index 9db1cf42d23..1d5c0ae9fc0 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md b/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md index ede4a1f8478..8fbf1204a39 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.generate_basic_approximations -`generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md index 7ecda249dd0..e1aaae1c985 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_ag -`synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md index a1d81910e85..6d3cd19f73a 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_bm -`synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md index 2c745f2343a..9e8959acf90 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_full -`synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md index 194d1106e23..e32855558e8 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_greedy -`synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md index 6c2b345a32e..b0e2f450f13 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_layers -`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md index 9251417036d..e86465eaed4 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnot_count_full_pmh -`synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") +`synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md index 98544e67b8d..db55fc4f16c 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnot_depth_line_kms -`synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md index 15db6e4a8a9..98c049b1a55 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_full -`synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md index 24d2abc96ce..aa69990e9b1 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_general -`synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md index c8537d21d00..e4bf92ecdf6 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_two_qubits -`synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md index 81998640617..1d1c0f22a07 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_acg -`synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md index bfee99f7bb3..d69f554b049 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_basic -`synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md index ddbf659d603..9a3383f7897 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_depth_lnn_kms -`synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md index 8f375df262c..1ddce8a7a59 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md index ae943e14bf9..ac23d602074 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md b/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md index 60bde9bf4f9..e18b1653f3b 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md +++ b/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.events.TextProgressBar -`TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Bases: `qiskit.tools.events.progressbar.BaseProgressBar` @@ -70,7 +70,7 @@ Run when progress bar has completed. -`TextProgressBar.start(iterations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.start(iterations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Start the progress bar. @@ -134,7 +134,7 @@ Unsubscribe a pair event-callback, so the callback will not be called anymore wh -`TextProgressBar.update(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.update(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Update status of progress bar. diff --git a/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md index d5eab415f1d..71d4758982b 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md index 1ba7ea05678..b36d87976cc 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md index 01e7684f560..1c45c1a75dd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md index b8ed6c8a159..2d8adbffb78 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md index c57c7beaa47..e72248e6d59 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -108,7 +108,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -120,7 +120,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -132,7 +132,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -157,7 +157,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -182,7 +182,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -204,7 +204,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -216,7 +216,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -228,7 +228,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -244,7 +244,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -254,7 +254,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -262,7 +262,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -270,7 +270,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -280,7 +280,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -304,7 +304,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -329,7 +329,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -337,7 +337,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md index 7d7c7964781..72ec446a408 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md index 61563412856..3bff2984c83 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md index d1cebbf5482..e9a90ddaab3 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md index 60c8a1ace31..a7f11da6240 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md index 0ee681ef048..5551484296c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md index e70f16f17b4..a85be55c5a5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md index aec70a2f0a1..14964a123a5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit. @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md index 6e348546fac..31111124cb2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. @@ -194,7 +194,7 @@ The transformed circuit(s). -`PassManager.to_flow_controller()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.to_flow_controller()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Linearize this manager into a single [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController"), so that it can be nested inside another [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md index 2a39e258f7f..cbf0a9d6c9d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md index 7b3bf1e21fb..01dfb47fd6c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md index 602c9d7c334..aa1a696cbb5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.Target.md b/docs/api/qiskit/0.41/qiskit.transpiler.Target.md index 83ad12c4808..8335d4bf32a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -136,7 +136,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -165,7 +165,7 @@ for this target. If there are no connectivity constraints in the target this wil -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -189,7 +189,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -211,7 +211,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -251,7 +251,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -267,7 +267,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -308,19 +308,19 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -340,7 +340,7 @@ The Instruction instance corresponding to the name. This also can also be the cl -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -364,7 +364,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -388,7 +388,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -408,7 +408,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -424,7 +424,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -463,7 +463,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -481,7 +481,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md index b3311265ad7..d0460a05000 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md index 29397d4512e..e69533bbb3e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md index b7b747e5dac..8c9e8295a97 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md index 59f494ffa32..dbb7b9a8767 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation -`ACGSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`ACGSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"acg: {qct.size() = }, {qct.depth() = }") -`ACGSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`ACGSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md index 2e3b1ecf22a..e93944c4342 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index c7a5f92d706..ea147fb7acd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md index 46d46e4b721..6fc7ce5a907 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index f5aa9f097b4..b22f0a9ea6e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md index 845d19175fd..b9f8c655973 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md index 8cf3523dd09..bcf0526bd9f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md index 32439b51fa6..693247ec22a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 69e1d864cd7..35dc0299028 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md index 990f47be323..e342a320e18 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md index 232c3735abe..c9b1cb0faee 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation -`BasicSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`BasicSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"basic: {qct.size() = }, {qct.depth() = }") -`BasicSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`BasicSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md index c1903025a90..07b56710424 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md index e1799c68b4d..b3ce0a7e154 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md index c6da41a4cb8..8b4573e4095 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md index 4f5b996a7bd..941a9d1df72 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md index 6a13f74c626..18947416521 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md index c0d427193ff..417fb39de05 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md index 734b1c13232..95f37340c7a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md index 96b384f9e91..48f07fb44fc 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md index 39e06123f91..93fcd5f6b6a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md index 28504c2a6a6..18d0192a47f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse -`CollectAndCollapse(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") +`CollectAndCollapse(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CollectAndCollapse.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") +`CollectAndCollapse.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md index 95bfe86f3e7..143a93fe3ed 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md index dbf672a7d46..fa2970a57c9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md index b00674be2b8..47f5f9b43f5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md index e82a960ed69..38eacf2c366 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md index 687cceab07e..855f64ef4bb 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md index b645f918dc1..1a630c74482 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CommutativeInverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Run the CommutativeInverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md index 9fcde788733..086150dc013 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -92,7 +92,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -118,7 +118,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md index ac98e454891..3ae9e41b527 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md index b2996b923a7..6de96092f47 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md index bb0a6a7e261..8a6f1c504e6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(instruction_name, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(instruction_name, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 2b0445928bc..3d0fed2a85d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ConvertConditionsToIfOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md index 24153ce7fd6..0f4823aa9a1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md index 82f8ffd2890..d30d7b390e1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index d12bbe32b93..8a78c0ae9fe 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md index ada5bb2b01f..ebf2655234e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md index 6c031c6c758..1d62e001b9e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md index 71a9e9e3d33..d961a155323 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md index 67cb56d7a6b..7898f248bf4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md index 4090dc1b76f..dd1cc7c64d6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md index d4e55450e42..85042289cfb 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -94,7 +94,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 3b38a4c450f..57e48f3d8ec 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md index b957cc8f92a..992916723a1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md index 40f2ff0ebc2..5d281273b2c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md index 2189ad9f1a5..0e2d84bfdb6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md index 196c151ac92..3797351bb05 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md index 9320420c64f..db2870a6858 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md index c47de4326d1..c958afbfee7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`HighLevelSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run the HighLevelSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md index 305486d0d0f..81ff05a6a62 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md index 0d79135232d..c139ee26726 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md index 542209b6847..2325be9ec36 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md index f0a0084a78d..023af163b4c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation -`KMSSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`KMSSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -43,7 +43,7 @@ print(f"kms: {qct.size() = }, {qct.depth() = }") -`KMSSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`KMSSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md index ca74ca67b4e..7d16dae6a5e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index e58d7e51aa9..e0203a9fee0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 0e941d8d9e6..a4829829d5b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md index 1864eea3199..f7c3608eb76 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 65666f25189..c230cd4e93a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index de45437444d..fd5ff86a3c3 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md index ca00260f50d..be25890ba40 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md index f06ef2692a9..895b23e352d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 323bb4c6971..17913f7772d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index cdb89beeeb9..078d5a08ca5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md index 550684b2578..6b79a03ebf0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`OptimizeCliffords.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Run the OptimizeCliffords pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md index 1a5fbf4d4f4..e807df0bf6d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 2f94a83206c..e3d54879f06 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md index 52516d51c0d..04bd9d6fff3 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 028009112cc..772f08f5b66 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -69,7 +69,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") A builder macro to play stretched pulse. @@ -115,7 +115,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index dc933889fd9..a08808a1d03 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md index 5ad369cdda3..1d4ef509b57 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -49,7 +49,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index f7be66080e1..66e85cf41ed 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md index ee3a43885ec..6fc40af2574 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md index 44d7f6dd71b..65bfefda67d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 860f3b34919..fecd5772a73 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ResetAfterMeasureSimplification.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Run the pass on a dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md index eb3e36b5d62..d811c9b9abf 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md index 8274d0b0798..c5ef57c3a3c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -90,7 +90,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md index 465dcc939e1..146cceb5cfe 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md index af55e1faf61..411bb0252a1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md index c07b8b5bc77..cccb5928bde 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md index af91286dbf6..d8d7e2d093c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -119,7 +119,7 @@ Return the name of the pass. -`SolovayKitaev.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run the `SolovayKitaev` pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index da3fdb354f1..2955f9d148b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -44,7 +44,7 @@ The number of times the decomposition is recursively improved. If None, defaults -`SolovayKitaevSynthesis.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md index 19b0f4ee58c..0f50785342a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md index 185337b2581..57856f53189 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md index c4dfe0bbd72..c28e5ad4f64 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md index 81a007a7f6b..6d62effca24 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -87,7 +87,7 @@ Return the name of the pass. -`TranslateParameterizedGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Run the transpiler pass. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md index f1af0f14b1c..c806187a689 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md index 3eaffbdc737..f9b5689de79 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on `dag`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md index c87f7fb0563..6d129e33194 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md index fa05395e7ae..afc79925d0c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md index 84c61bf79af..e45545cc668 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md index 3092315c2b5..f65576eaf3f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -66,7 +66,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md index a75552dfac1..e003368cf7c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md index d190bc870bf..5b335b7cb06 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md index 19873d0bd78..dbe275e60ff 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 9a52ea85f26..b01c3684350 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for high-level synthesis plugins. -`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given Operation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index af10d36ed2c..d7415a3a075 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Class tracking the installed high-level-synthesis plugins. -`HighLevelSynthesisPluginManager.method(op_name, method_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method(op_name, method_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns the plugin for `op_name` and `method_name`. @@ -30,7 +30,7 @@ Returns the plugin for `op_name` and `method_name`. -`HighLevelSynthesisPluginManager.method_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns plugin methods for op\_name. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 2cf4289ae62..c1d11823144 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 15399e0b525..25de05436cb 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 462219d3000..d67a884247f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md index b961b11ed3d..1289536654c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_control_f -`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md index 3577f57d722..2678d3cea07 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_embed_pas -`generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md index 50b0183bcc7..8709024f9ec 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_error_on_ -`generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md index 3046853434f..63a0d72b1af 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_pre_op_pa -`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md index c857d4369c4..342cccf7247 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_routing_p -`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md index 9305e8bbe94..fd4e089c291 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_schedulin -`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md index ee1cf236416..40d90559d25 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_translati -`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md index 51818ed723a..cb58578454c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q -`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 7aea9ae57c8..60ca848fb50 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index a0dda418fd9..e0579ef614b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 38cca4e2f22..2f1ea5e7360 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 39231c12d04..5ac56445836 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 41c2dc88a0c..ce5f111daab 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 0080a0e8f7c..5855105eb0e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ A `PassManagerStagePlugin` object can be added to an external package and integr -`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index aa63be7fc5a..a995d332298 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Manager class for preset pass manager stage plugins. -`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a stage diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md index 5a9675b4640..aa138691116 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins -`list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md index 76d9428b676..98789b1cc3d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 3265c21d977..4dce5d70fc7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index 6cdd0f3659e..27b694148af 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 0554e706307..5890367487f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 0b1d6ee0005..0bcfeac76ce 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 1f5c277f498..32ffac2995e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 95a96991071..ff92c7f410e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index 6771c2c1d2f..c4bb79bda70 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ Implementation of objective function and gradient calculator, which is similar t -`FastCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the gradient of objective function. See description of the base class method. @@ -39,7 +39,7 @@ Computes the gradient of objective function. See description of the base class m -`FastCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. diff --git a/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md index 13a7db21a1d..15ac8b68196 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md index 18e4bc1cafd..8b1ba545b00 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md index 48db8a0fa56..5dd443b550d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md index 26966ec6081..23238733546 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md index a0c0354e4ab..7a741d8468c 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md index eb57125b4f7..fc664fd00b1 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.41/qiskit.utils.has_aer.md b/docs/api/qiskit/0.41/qiskit.utils.has_aer.md index ee3848bebff..8a189fa5680 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.41/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md index 63a48b4f364..4b6b1df9958 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md index a77586ad017..da0011a1c2d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md index d52fb33fc04..6243359925a 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md index 58df10dae46..9e31829a9f8 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md index 3652cadf5e8..72b3ee82603 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. @@ -81,7 +81,7 @@ The on-diagonal elements of the calibration matrices are the probabilities of me -`TensoredMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.41/qiskit.utils.name_args.md b/docs/api/qiskit/0.41/qiskit.utils.name_args.md index 6be1349c741..3b90eb8825c 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.41/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md index 0b1d9a1e7bf..f463de57651 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md index a1e0f8b0677..bb379d3cb7d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md index 5fa0d0601de..e860c3ce79d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md index d9c3c13769e..aa7eea04a46 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md index 8f5384af8ba..71527502656 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md index a04367ede1d..87d3de97542 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md index c483aa5f639..52b4abc4a80 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md index 3eeac3b5ed3..323213b421b 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md index 7c0d2aa9751..553b9cf159b 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md index 93ea9a1550f..958faa0bf0e 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md index b28604dba09..8d9e39a2acd 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md index c98daa4fe2c..e795a8d6f08 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md index 40762eb3751..d148d8e2bd1 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_distribution -`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") +`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md index 0343ec7a5c2..bc8b27ca4bd 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md index 1f313c81335..018c3152b27 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md index 4d23a5124d6..87e308ea1b2 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md index a8cafe78cab..73fabc6f0ab 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md index 8951a0fdd89..4425653fb37 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md index 77cd2bd35d7..696df7e60d5 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md index 26ae27bdc13..f1406ef8aaa 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md index 4be541bcafe..10061567376 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md index 0abf720b463..156b4f2baef 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md index 192b14169dd..fdfbccc9883 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md index 02cf563453c..e377904c072 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md index 321fbb35f33..797171e5b42 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerError.md b/docs/api/qiskit/0.41/qiskit_aer.AerError.md index 5f4c2607a79..91244a10699 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerError.md +++ b/docs/api/qiskit/0.41/qiskit_aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md b/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md index 4f6b0e4db92..77c9fa9340c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md +++ b/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md index 47bc8a665dc..9cde92150bd 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -205,7 +205,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -213,7 +213,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -263,7 +263,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -271,7 +271,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -359,7 +359,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md index 7fcf1526bba..3d25707435b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md index 41467bd0e1c..8f2f21730ab 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md index 32eeaabdfc3..d59c192ceaf 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md b/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md index 1f06420d096..c87ff1ea1f7 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md index db313fa15b5..cdf53e9e60e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md index 36f087d4664..6249b146be1 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md index a6a3c1ee847..3457e924414 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md index dbe9b362161..b16ed6fca93 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md index 61c035747e2..a553e3e4af3 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md index a97970dec60..68c04471132 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md index 4f170429cb8..fbbc9be197e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md index b65cc654c01..f601397e76f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md index ff45c0c06ee..10cfc651eec 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md index 750f4dfb595..8509eeeea01 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md index 24aaefbd1fd..3863e28f4ab 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md index 9e4d612450f..a74c3cc3d87 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md index cb8857d14a2..3f8b64809d4 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md index 323c863b155..bc75412a401 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md index aa18c03bbdf..2526eefb249 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md index d9ad2d95fc5..455d9f2e07c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md index da93367d185..1a2a5efa681 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md index f3fc262661e..4f540720c71 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md index 095d26f3275..538b8e1ce0c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md index 26b4d86aeea..a0fec10f158 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md index b79415d8eb7..565a4c97f7a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md index a1818ec75a6..c373d432109 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md index 590a0694967..de590aa0a79 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md index 390115a92e8..ec1b668c7c4 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md index c6e631fd67a..82d8c10578c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md index a15ce90d970..3545ea80cb0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md index c5bf046d92e..2afcf6cbd81 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md index 83f3756753a..4eb728318a6 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md index e0c48040e8b..06e3e06dc46 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md index fc4efa9230c..3ec3e9646c5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md index 3f917fa6387..95c6cffa69a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md index d554184bcd8..d6cb284ec4e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md index 012a26267e4..e0cb79acf70 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md index b58f26be497..6254b7409a8 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md index f6638818b12..d8bd261964f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md index 9b4deb5fb70..010dcaf80d0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md index 4bed5d00e43..ef47af6761f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md index fd8a0373bab..ded625276b0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md index 2938daa4809..6fedfb63299 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md index a8c1135644e..ba41900f2b0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md index 690a1072521..f291fd9fa05 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md index 41e1bce3a7c..91728cb7f66 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md index 48988d8ec8c..fcbccc6a02f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md index e6f8fd9c84e..c3a15022d7e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md index c1b8d94266e..50ecacefd0b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md b/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md index 2952b33e4f2..92dd77570e5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions, warnings=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -265,7 +265,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -289,7 +289,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -297,7 +297,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Reset the noise model. @@ -305,7 +305,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md b/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md index c81f1308985..1db3c8d7e4b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -129,7 +129,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -154,7 +154,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -176,7 +176,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -250,7 +250,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -258,7 +258,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`classmethod QuantumError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -266,7 +266,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -292,7 +292,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -300,7 +300,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -308,7 +308,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md b/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md index 473f00da065..bf79429206c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md index cf2c6e6cba9..b983d9d944c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md index 060dec129a3..4feddbe5752 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md index f90a1a068c5..5f375e4118e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md index 682b4c35050..1a855f9520d 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md index bbb6ff34ecf..839935cebc7 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return QuantumErrors derived from either of a devices BackendProperties or Target. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md index 036856d7afc..5ec67050a9a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return readout error parameters from either of device Target or BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md index 995c5adf824..4e229d33a5a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md index c7985d8a231..5adc8d2bc1d 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md index 9a03c869835..4b68d14dcb0 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md index 9e7cd14a25f..54ed50271bf 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md index 4315386aea1..9a514b55877 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md index 1d5fb16a3df..2c1fd8347bb 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.kraus_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md index 134d564711e..fade2783f7b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md index b4e9f01faec..75a2282158c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.pauli_error -`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops, standard_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md index 70ced555d78..930337b8f4f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md index 2dadfc13527..c686b920614 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md index 955de63ad01..68b38e7ce57 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md index 52d4dc7edcd..a131331ef50 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md b/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md index e997121e9b8..70c818af1d5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -49,7 +49,7 @@ Aer implmentation of Estimator. -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md b/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md index 1a3544818de..6a6e3073af1 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md +++ b/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -45,7 +45,7 @@ Aer implementation of Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md index 1f9c2bb1d0c..3df65cca226 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md index ea9d60c65fd..7bd6f1f4889 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md b/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md index 49b4e26b2d8..8e5144e1b97 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector -`AerStatevector(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector(data, dims=None, **configs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") @@ -38,7 +38,7 @@ The `dims` kwarg is used to `Statevector` constructor. -`AerStatevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the conjugate of the operator. @@ -210,7 +210,7 @@ complex -`classmethod AerStatevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the output statevector of an instruction. @@ -236,7 +236,7 @@ The final statevector. -`static AerStatevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`static AerStatevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a computational basis statevector. @@ -264,7 +264,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerStatevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -353,7 +353,7 @@ tuple -`AerStatevector.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.metadata()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return result metadata of an operation that executed lastly. @@ -536,7 +536,7 @@ Additional Information: -`AerStatevector.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -563,7 +563,7 @@ Additional Information: -`AerStatevector.seed(value=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.seed(value=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md index 19ae0afd358..1bc6ad231e2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.NoiseTransformer -`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.channel_matrix_representation(operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_P(As)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.compute_channel_operation(rho, operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.compute_q(As, C)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.fidelity(channel)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.flatten_matrix(m)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_circuit(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.operator_matrix(operator)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`static NoiseTransformer.prepare_channel_operator_list(ops_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.solve_quadratic_program(P, q)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md index fb3f3841a0a..a55bd1cde5f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md index b11ed875e94..34cea362496 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md b/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md index 4a76436e647..781c8172b8d 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md index c299cda8af2..33d73b14a5f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.remap_noise_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md index d7301f5f544..f5fb8849045 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md index 4fd8ade1fe4..f1c17a64b81 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md index 0e89f33a58f..accabb93593 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.41/synthesis_aqc.md b/docs/api/qiskit/0.41/synthesis_aqc.md index c80989b3801..e2d66c0a490 100644 --- a/docs/api/qiskit/0.41/synthesis_aqc.md +++ b/docs/api/qiskit/0.41/synthesis_aqc.md @@ -128,7 +128,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.41/utils.md b/docs/api/qiskit/0.41/utils.md index ba14cb76640..c8663b82d29 100644 --- a/docs/api/qiskit/0.41/utils.md +++ b/docs/api/qiskit/0.41/utils.md @@ -111,7 +111,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -232,7 +232,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -246,7 +246,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From de6a3674c4d03ebdc1ce8c1666e226c04c4cf7f3 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:54:55 +0100 Subject: [PATCH 22/41] Regenerate qiskit 0.42.0 --- docs/api/qiskit/0.42/execute.md | 2 +- docs/api/qiskit/0.42/pulse.md | 8 +- docs/api/qiskit/0.42/qasm3.md | 14 +- .../0.42/qiskit.algorithms.AlgorithmError.md | 2 +- .../0.42/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.42/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.42/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.42/qiskit.algorithms.Grover.md | 8 +- .../0.42/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../api/qiskit/0.42/qiskit.algorithms.PVQD.md | 8 +- .../0.42/qiskit.algorithms.PVQDResult.md | 2 +- .../0.42/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.42/qiskit.algorithms.QAOA.md | 2 +- .../0.42/qiskit.algorithms.RealEvolver.md | 4 +- .../0.42/qiskit.algorithms.RealTimeEvolver.md | 4 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 4 +- .../qiskit.algorithms.SciPyRealEvolver.md | 4 +- .../api/qiskit/0.42/qiskit.algorithms.Shor.md | 8 +- .../0.42/qiskit.algorithms.ShorResult.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 4 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.42/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.42/qiskit.algorithms.VQD.md | 14 +- .../0.42/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.42/qiskit.algorithms.VQE.md | 14 +- .../qiskit/0.42/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.42/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 6 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 6 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 6 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- .../qiskit.algorithms.estimate_observables.md | 2 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 6 +- .../qiskit.algorithms.gradients.BaseQGT.md | 6 +- ...lgorithms.gradients.BaseSamplerGradient.md | 6 +- ...kit.algorithms.gradients.DerivativeType.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.42/qiskit.algorithms.gradients.QFI.md | 6 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...gorithms.linear_solvers.AbsoluteAverage.md | 10 +- .../qiskit.algorithms.linear_solvers.HHL.md | 6 +- ....algorithms.linear_solvers.LinearSolver.md | 4 +- ...ithms.linear_solvers.LinearSolverResult.md | 2 +- ...ithms.linear_solvers.LinearSystemMatrix.md | 8 +- ...s.linear_solvers.LinearSystemObservable.md | 10 +- ...orithms.linear_solvers.MatrixFunctional.md | 10 +- ...rithms.linear_solvers.NumPyLinearSolver.md | 4 +- ...t.algorithms.linear_solvers.NumPyMatrix.md | 10 +- ...thms.linear_solvers.TridiagonalToeplitz.md | 10 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 6 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 6 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 6 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 6 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 6 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 6 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.42/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.42/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.42/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.42/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.42/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.42/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 16 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.42/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.42/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- ...lgorithms.optimizers.SteppableOptimizer.md | 18 +- .../0.42/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.42/qiskit.algorithms.optimizers.UMDA.md | 6 +- ...optimizers.optimizer_utils.LearningRate.md | 6 +- ...thms.state_fidelities.BaseStateFidelity.md | 6 +- ...ithms.state_fidelities.ComputeUncompute.md | 6 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 6 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 4 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 4 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 6 +- .../qiskit/0.42/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.42/qiskit.assembler.disassemble.md | 2 +- .../0.42/qiskit.circuit.AncillaQubit.md | 2 +- .../0.42/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit/0.42/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.42/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.42/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.42/qiskit.circuit.Clbit.md | 2 +- .../0.42/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.42/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.42/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.42/qiskit.circuit.Delay.md | 12 +- .../0.42/qiskit.circuit.EquivalenceLibrary.md | 16 +- .../qiskit/0.42/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.42/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.42/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.42/qiskit.circuit.Instruction.md | 26 +- .../0.42/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.42/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.42/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.42/qiskit.circuit.ParameterVector.md | 6 +- .../0.42/qiskit.circuit.QuantumCircuit.md | 222 +++++++++--------- .../0.42/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.42/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.42/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.AND.md | 2 +- .../0.42/qiskit.circuit.library.Barrier.md | 8 +- .../0.42/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.42/qiskit.circuit.library.C3XGate.md | 6 +- .../0.42/qiskit.circuit.library.C4XGate.md | 6 +- .../0.42/qiskit.circuit.library.CCXGate.md | 6 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.42/qiskit.circuit.library.CHGate.md | 4 +- .../0.42/qiskit.circuit.library.CPhaseGate.md | 8 +- .../0.42/qiskit.circuit.library.CRXGate.md | 4 +- .../0.42/qiskit.circuit.library.CRYGate.md | 4 +- .../0.42/qiskit.circuit.library.CRZGate.md | 4 +- .../0.42/qiskit.circuit.library.CSXGate.md | 2 +- .../0.42/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.42/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.42/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.42/qiskit.circuit.library.CUGate.md | 4 +- .../0.42/qiskit.circuit.library.CXGate.md | 6 +- .../0.42/qiskit.circuit.library.CYGate.md | 4 +- .../0.42/qiskit.circuit.library.CZGate.md | 4 +- .../0.42/qiskit.circuit.library.DCXGate.md | 2 +- .../0.42/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.42/qiskit.circuit.library.ECRGate.md | 4 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.GRZ.md | 2 +- .../0.42/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.42/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.42/qiskit.circuit.library.IGate.md | 6 +- .../qiskit/0.42/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.42/qiskit.circuit.library.MCMT.md | 6 +- .../0.42/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.42/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.42/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.42/qiskit.circuit.library.MSGate.md | 2 +- .../0.42/qiskit.circuit.library.Measure.md | 4 +- .../0.42/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.42/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.42/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 8 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.42/qiskit.circuit.library.PhaseGate.md | 8 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.42/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.42/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.42/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.42/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.42/qiskit.circuit.library.RGate.md | 6 +- .../0.42/qiskit.circuit.library.RVGate.md | 6 +- .../0.42/qiskit.circuit.library.RXGate.md | 8 +- .../0.42/qiskit.circuit.library.RXXGate.md | 6 +- .../0.42/qiskit.circuit.library.RYGate.md | 8 +- .../0.42/qiskit.circuit.library.RYYGate.md | 6 +- .../0.42/qiskit.circuit.library.RZGate.md | 8 +- .../0.42/qiskit.circuit.library.RZXGate.md | 6 +- .../0.42/qiskit.circuit.library.RZZGate.md | 6 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.42/qiskit.circuit.library.Reset.md | 4 +- .../0.42/qiskit.circuit.library.SGate.md | 6 +- .../0.42/qiskit.circuit.library.SXGate.md | 6 +- .../0.42/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.42/qiskit.circuit.library.SdgGate.md | 6 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.42/qiskit.circuit.library.SwapGate.md | 6 +- .../0.42/qiskit.circuit.library.TGate.md | 6 +- .../0.42/qiskit.circuit.library.TdgGate.md | 6 +- .../0.42/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.42/qiskit.circuit.library.U1Gate.md | 6 +- .../0.42/qiskit.circuit.library.U2Gate.md | 4 +- .../0.42/qiskit.circuit.library.U3Gate.md | 6 +- .../0.42/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.42/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.42/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 6 +- .../qiskit.circuit.library.XXPlusYYGate.md | 6 +- .../0.42/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.42/qiskit.circuit.library.ZGate.md | 8 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.42/qiskit.circuit.library.iSwapGate.md | 4 +- .../0.42/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.42/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.42/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.42/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.42/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.42/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.42/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.42/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.42/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.42/qiskit.compiler.transpile.md | 2 +- .../0.42/qiskit.converters.ast_to_dag.md | 2 +- .../0.42/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.42/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.42/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.42/qiskit.dagcircuit.BlockCollapser.md | 4 +- .../0.42/qiskit.dagcircuit.BlockCollector.md | 6 +- .../0.42/qiskit.dagcircuit.DAGCircuit.md | 128 +++++----- .../0.42/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.42/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.42/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.42/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.42/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.42/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.42/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.42/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.42/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.42/qiskit.extensions.Snapshot.md | 8 +- .../0.42/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.42/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.42/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.42/qiskit.extensions.UCRZGate.md | 2 +- .../0.42/qiskit.extensions.UnitaryGate.md | 16 +- .../qiskit/0.42/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.42/qiskit.opflow.OpflowError.md | 2 +- .../0.42/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.42/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.42/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.42/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.42/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.42/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.42/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.42/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.42/qiskit.opflow.gradients.QFI.md | 4 +- .../0.42/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.42/qiskit.opflow.list_ops.ComposedOp.md | 16 +- .../0.42/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.42/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.42/qiskit.opflow.list_ops.TensoredOp.md | 12 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 16 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.42/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../qiskit.primitives.BackendEstimator.md | 4 +- .../0.42/qiskit.primitives.BackendSampler.md | 4 +- .../0.42/qiskit.primitives.BaseEstimator.md | 6 +- .../0.42/qiskit.primitives.BaseSampler.md | 6 +- .../0.42/qiskit.primitives.Estimator.md | 4 +- .../0.42/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.42/qiskit.primitives.Sampler.md | 4 +- .../0.42/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.42/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.42/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.42/qiskit.providers.BackendV2.md | 16 +- .../qiskit.providers.BackendV2Converter.md | 12 +- docs/api/qiskit/0.42/qiskit.providers.Job.md | 2 +- .../qiskit/0.42/qiskit.providers.JobError.md | 2 +- .../qiskit/0.42/qiskit.providers.JobStatus.md | 2 +- .../0.42/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.42/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.42/qiskit.providers.Options.md | 8 +- .../qiskit/0.42/qiskit.providers.Provider.md | 2 +- .../0.42/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.42/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit.providers.ibmq.AccountProvider.md | 12 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 2 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 2 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 2 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 2 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 2 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 2 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 2 +- .../0.42/qiskit.providers.ibmq.IBMQBackend.md | 24 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 2 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 2 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 2 +- ...iskit.providers.ibmq.IBMQBackendService.md | 12 +- ...it.providers.ibmq.IBMQBackendValueError.md | 2 +- .../0.42/qiskit.providers.ibmq.IBMQError.md | 2 +- .../0.42/qiskit.providers.ibmq.IBMQFactory.md | 22 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 2 +- .../qiskit.providers.ibmq.RunnerResult.md | 6 +- ....providers.ibmq.credentials.Credentials.md | 8 +- ...iders.ibmq.credentials.CredentialsError.md | 2 +- ...mq.credentials.CredentialsNotFoundError.md | 2 +- ...edentials.InvalidCredentialsFormatError.md | 2 +- ...oviders.ibmq.experiment.DeviceComponent.md | 2 +- ...bmq.experiment.IBMExperimentEntryExists.md | 2 +- ...q.experiment.IBMExperimentEntryNotFound.md | 2 +- ...ders.ibmq.experiment.IBMExperimentError.md | 2 +- ...rs.ibmq.experiment.IBMExperimentService.md | 36 +-- ...providers.ibmq.experiment.ResultQuality.md | 2 +- .../0.42/qiskit.providers.ibmq.job.IBMQJob.md | 48 ++-- ...skit.providers.ibmq.job.IBMQJobApiError.md | 2 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 2 +- ....providers.ibmq.job.IBMQJobFailureError.md | 2 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 2 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 2 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 4 +- .../qiskit.providers.ibmq.job.job_monitor.md | 2 +- .../0.42/qiskit.providers.ibmq.least_busy.md | 2 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 10 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 2 +- ...managed.IBMQJobManagerInvalidStateError.md | 2 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 2 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 2 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 2 +- ...naged.IBMQManagedResultDataNotAvailable.md | 2 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 14 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 34 +-- ...t.providers.ibmq.managed.ManagedResults.md | 14 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 26 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 4 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 4 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 4 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 4 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 22 +- ...t.providers.ibmq.runtime.RuntimeOptions.md | 4 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 6 +- ...it.providers.ibmq.runtime.UserMessenger.md | 4 +- ...roviders.ibmq.utils.seconds_to_duration.md | 2 +- ...oviders.ibmq.utils.to_python_identifier.md | 2 +- ...providers.ibmq.utils.update_qobj_config.md | 2 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 2 +- ....providers.ibmq.utils.validate_job_tags.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.42/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.42/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.42/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.42/qiskit.pulse.ScheduleBlock.md | 30 +-- .../0.42/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.42/qiskit.pulse.builder.align_func.md | 2 +- .../0.42/qiskit.pulse.builder.align_left.md | 2 +- .../0.42/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.42/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.delay.md | 2 +- .../0.42/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.42/qiskit.pulse.builder.measure.md | 2 +- .../0.42/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.42/qiskit.pulse.builder.num_qubits.md | 2 +- .../0.42/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- .../0.42/qiskit.pulse.builder.reference.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.42/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.42/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.42/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.42/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.42/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.42/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.42/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.42/qiskit.pulse.instructions.Call.md | 4 +- .../0.42/qiskit.pulse.instructions.Delay.md | 2 +- .../0.42/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- .../0.42/qiskit.pulse.library.Constant.md | 2 +- .../qiskit/0.42/qiskit.pulse.library.Drag.md | 2 +- .../0.42/qiskit.pulse.library.Gaussian.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- ...kit.pulse.library.ScalableSymbolicPulse.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- .../0.42/qiskit.pulse.library.Waveform.md | 4 +- .../qiskit/0.42/qiskit.pulse.library.cos.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.42/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.42/qiskit.pulse.library.sech.md | 2 +- .../0.42/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.42/qiskit.pulse.library.sin.md | 2 +- .../0.42/qiskit.pulse.library.square.md | 2 +- .../0.42/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.42/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.42/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.42/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.42/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.42/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- .../qiskit/0.42/qiskit.qasm.OpenQASMLexer.md | 2 +- docs/api/qiskit/0.42/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.42/qiskit.qasm.QasmError.md | 2 +- .../qiskit/0.42/qiskit.qasm.QasmHTMLStyle.md | 2 +- .../0.42/qiskit.qasm.QasmTerminalStyle.md | 2 +- .../0.42/qiskit.qobj.GateCalibration.md | 6 +- .../0.42/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.md | 6 +- .../0.42/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.42/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.42/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.42/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.42/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.42/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.42/qiskit.qobj.Qobj.md | 2 +- .../0.42/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.42/qiskit.qobj.QobjHeader.md | 2 +- .../0.42/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.42/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.42/qiskit.qpy.load.md | 2 +- .../0.42/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.42/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.42/qiskit.quantum_info.Choi.md | 12 +- .../0.42/qiskit.quantum_info.Clifford.md | 36 +-- .../0.42/qiskit.quantum_info.DensityMatrix.md | 38 +-- .../qiskit/0.42/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 8 +- .../0.42/qiskit.quantum_info.Operator.md | 30 +-- .../qiskit/0.42/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.42/qiskit.quantum_info.Pauli.md | 38 +-- .../0.42/qiskit.quantum_info.PauliList.md | 54 ++--- .../0.42/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.42/qiskit.quantum_info.Quaternion.md | 14 +- .../0.42/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.42/qiskit.quantum_info.SparsePauliOp.md | 46 ++-- .../qiskit.quantum_info.StabilizerState.md | 30 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.42/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.42/qiskit.quantum_info.Stinespring.md | 14 +- .../0.42/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.42/qiskit.quantum_info.XXDecomposer.md | 4 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.42/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.42/qiskit.quantum_info.diamond_norm.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.42/qiskit.quantum_info.entropy.md | 2 +- .../0.42/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.42/qiskit.quantum_info.partial_trace.md | 2 +- .../0.42/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.42/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.42/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.42/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.42/qiskit.result.ProbDistribution.md | 6 +- .../0.42/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.42/qiskit.result.Result.md | 16 +- .../qiskit/0.42/qiskit.result.ResultError.md | 2 +- .../0.42/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.42/qiskit.result.marginal_memory.md | 2 +- ...qiskit.result.sampled_expectation_value.md | 2 +- .../0.42/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.42/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.42/qiskit.synthesis.ProductFormula.md | 2 +- .../qiskit/0.42/qiskit.synthesis.QDrift.md | 4 +- ...it.synthesis.SolovayKitaevDecomposition.md | 8 +- .../0.42/qiskit.synthesis.SuzukiTrotter.md | 4 +- ...synthesis.generate_basic_approximations.md | 2 +- .../qiskit.synthesis.synth_clifford_ag.md | 2 +- .../qiskit.synthesis.synth_clifford_bm.md | 2 +- .../qiskit.synthesis.synth_clifford_full.md | 2 +- .../qiskit.synthesis.synth_clifford_greedy.md | 2 +- .../qiskit.synthesis.synth_clifford_layers.md | 2 +- ...kit.synthesis.synth_cnot_count_full_pmh.md | 2 +- ...kit.synthesis.synth_cnot_depth_line_kms.md | 2 +- ...iskit.synthesis.synth_cnotdihedral_full.md | 2 +- ...it.synthesis.synth_cnotdihedral_general.md | 2 +- ...synthesis.synth_cnotdihedral_two_qubits.md | 2 +- .../qiskit.synthesis.synth_permutation_acg.md | 2 +- ...iskit.synthesis.synth_permutation_basic.md | 2 +- ...nthesis.synth_permutation_depth_lnn_kms.md | 2 +- .../0.42/qiskit.tools.backend_monitor.md | 2 +- .../0.42/qiskit.tools.backend_overview.md | 2 +- .../qiskit.tools.events.TextProgressBar.md | 6 +- .../qiskit/0.42/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.42/qiskit.tools.parallel_map.md | 2 +- .../0.42/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.42/qiskit.transpiler.CouplingMap.md | 44 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.42/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.42/qiskit.transpiler.Layout.md | 30 +-- .../0.42/qiskit.transpiler.PassManager.md | 16 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.42/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 12 +- .../qiskit/0.42/qiskit.transpiler.Target.md | 36 +-- .../qiskit.transpiler.TransformationPass.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.42/qiskit.transpiler.TranspilerError.md | 2 +- ...anspiler.passes.ACGSynthesisPermutation.md | 4 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...spiler.passes.BasicSynthesisPermutation.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.42/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...it.transpiler.passes.CollectAndCollapse.md | 4 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...r.passes.CommutativeInverseCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 4 +- .../0.42/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.42/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...it.transpiler.passes.HighLevelSynthesis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...anspiler.passes.KMSSynthesisPermutation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- ...kit.transpiler.passes.OptimizeCliffords.md | 4 +- .../0.42/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- ....passes.ResetAfterMeasureSimplification.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.42/qiskit.transpiler.passes.Size.md | 4 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 4 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- ...iler.passes.TranslateParameterizedGates.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- .../0.42/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.42/qiskit.transpiler.passes.Width.md | 4 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 4 +- ....plugin.HighLevelSynthesisPluginManager.md | 6 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...mon.generate_control_flow_options_check.md | 2 +- ...agers.common.generate_embed_passmanager.md | 2 +- ...s.common.generate_error_on_control_flow.md | 2 +- ...gers.common.generate_pre_op_passmanager.md | 2 +- ...ers.common.generate_routing_passmanager.md | 2 +- ...passmanagers.common.generate_scheduling.md | 2 +- ...common.generate_translation_passmanager.md | 2 +- ..._passmanagers.common.generate_unroll_3q.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 4 +- ...rs.plugin.PassManagerStagePluginManager.md | 4 +- ..._passmanagers.plugin.list_stage_plugins.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- ...ler.synthesis.aqc.FastCNOTUnitObjective.md | 6 +- .../0.42/qiskit.utils.QuantumInstance.md | 16 +- .../qiskit/0.42/qiskit.utils.apply_prefix.md | 2 +- .../0.42/qiskit.utils.deprecate_arguments.md | 2 +- .../0.42/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.42/qiskit.utils.detach_prefix.md | 2 +- .../0.42/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.42/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.42/qiskit.utils.has_ibmq.md | 2 +- .../0.42/qiskit.utils.is_main_process.md | 2 +- .../0.42/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 8 +- .../api/qiskit/0.42/qiskit.utils.name_args.md | 2 +- .../0.42/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.42/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.42/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.42/qiskit_aer.AerError.md | 2 +- .../api/qiskit/0.42/qiskit_aer.AerProvider.md | 6 +- .../qiskit/0.42/qiskit_aer.AerSimulator.md | 14 +- .../qiskit/0.42/qiskit_aer.PulseSimulator.md | 8 +- .../qiskit/0.42/qiskit_aer.QasmSimulator.md | 12 +- .../0.42/qiskit_aer.StatevectorSimulator.md | 8 +- .../0.42/qiskit_aer.UnitarySimulator.md | 8 +- .../api/qiskit/0.42/qiskit_aer.jobs.AerJob.md | 18 +- .../qiskit/0.42/qiskit_aer.jobs.AerJobSet.md | 20 +- .../0.42/qiskit_aer.library.SaveAmplitudes.md | 2 +- ...iskit_aer.library.SaveAmplitudesSquared.md | 2 +- .../0.42/qiskit_aer.library.SaveClifford.md | 2 +- .../qiskit_aer.library.SaveDensityMatrix.md | 2 +- ...qiskit_aer.library.SaveExpectationValue.md | 2 +- ...er.library.SaveExpectationValueVariance.md | 2 +- ...skit_aer.library.SaveMatrixProductState.md | 2 +- .../qiskit_aer.library.SaveProbabilities.md | 2 +- ...iskit_aer.library.SaveProbabilitiesDict.md | 2 +- .../0.42/qiskit_aer.library.SaveStabilizer.md | 2 +- .../0.42/qiskit_aer.library.SaveState.md | 2 +- .../qiskit_aer.library.SaveStatevector.md | 2 +- .../qiskit_aer.library.SaveStatevectorDict.md | 2 +- .../0.42/qiskit_aer.library.SaveSuperOp.md | 2 +- .../0.42/qiskit_aer.library.SaveUnitary.md | 2 +- .../qiskit_aer.library.SetDensityMatrix.md | 2 +- ...iskit_aer.library.SetMatrixProductState.md | 2 +- .../0.42/qiskit_aer.library.SetStabilizer.md | 2 +- .../0.42/qiskit_aer.library.SetStatevector.md | 2 +- .../0.42/qiskit_aer.library.SetSuperOp.md | 2 +- .../0.42/qiskit_aer.library.SetUnitary.md | 2 +- .../qiskit_aer.library.save_amplitudes.md | 2 +- ...kit_aer.library.save_amplitudes_squared.md | 2 +- .../0.42/qiskit_aer.library.save_clifford.md | 2 +- .../qiskit_aer.library.save_density_matrix.md | 2 +- ...skit_aer.library.save_expectation_value.md | 2 +- ...library.save_expectation_value_variance.md | 2 +- ...t_aer.library.save_matrix_product_state.md | 2 +- .../qiskit_aer.library.save_probabilities.md | 2 +- ...kit_aer.library.save_probabilities_dict.md | 2 +- .../qiskit_aer.library.save_stabilizer.md | 2 +- .../0.42/qiskit_aer.library.save_state.md | 2 +- .../qiskit_aer.library.save_statevector.md | 2 +- ...iskit_aer.library.save_statevector_dict.md | 2 +- .../0.42/qiskit_aer.library.save_superop.md | 2 +- .../0.42/qiskit_aer.library.save_unitary.md | 2 +- .../qiskit_aer.library.set_density_matrix.md | 2 +- ...it_aer.library.set_matrix_product_state.md | 2 +- .../0.42/qiskit_aer.library.set_stabilizer.md | 2 +- .../qiskit_aer.library.set_statevector.md | 2 +- .../0.42/qiskit_aer.library.set_superop.md | 2 +- .../0.42/qiskit_aer.library.set_unitary.md | 2 +- .../0.42/qiskit_aer.noise.LocalNoisePass.md | 4 +- .../0.42/qiskit_aer.noise.NoiseModel.md | 24 +- .../0.42/qiskit_aer.noise.QuantumError.md | 20 +- .../0.42/qiskit_aer.noise.ReadoutError.md | 24 +- .../qiskit_aer.noise.RelaxationNoisePass.md | 2 +- ...iskit_aer.noise.amplitude_damping_error.md | 2 +- ...qiskit_aer.noise.coherent_unitary_error.md | 2 +- .../qiskit_aer.noise.depolarizing_error.md | 2 +- ...r.noise.device.basic_device_gate_errors.md | 2 +- ...oise.device.basic_device_readout_errors.md | 2 +- ...skit_aer.noise.device.gate_error_values.md | 2 +- ...kit_aer.noise.device.gate_length_values.md | 2 +- ...skit_aer.noise.device.gate_param_values.md | 2 +- ...t_aer.noise.device.readout_error_values.md | 2 +- ....noise.device.thermal_relaxation_values.md | 2 +- .../0.42/qiskit_aer.noise.kraus_error.md | 2 +- .../qiskit_aer.noise.mixed_unitary_error.md | 2 +- .../0.42/qiskit_aer.noise.pauli_error.md | 2 +- ...aer.noise.phase_amplitude_damping_error.md | 2 +- .../qiskit_aer.noise.phase_damping_error.md | 2 +- .../0.42/qiskit_aer.noise.reset_error.md | 2 +- ...skit_aer.noise.thermal_relaxation_error.md | 2 +- .../0.42/qiskit_aer.primitives.Estimator.md | 2 +- .../0.42/qiskit_aer.primitives.Sampler.md | 4 +- .../0.42/qiskit_aer.pulse.PulseSystemModel.md | 10 +- .../qiskit_aer.pulse.duffing_system_model.md | 2 +- ...iskit_aer.quantum_info.AerDensityMatrix.md | 24 +- .../qiskit_aer.quantum_info.AerStatevector.md | 16 +- ...iskit_aer.utils.approximate_noise_model.md | 2 +- ...kit_aer.utils.approximate_quantum_error.md | 2 +- .../0.42/qiskit_aer.utils.insert_noise.md | 2 +- .../qiskit_aer.utils.transform_noise_model.md | 2 +- .../qiskit_aer.utils.transpile_noise_model.md | 2 +- ...iskit_aer.utils.transpile_quantum_error.md | 2 +- docs/api/qiskit/0.42/synthesis_aqc.md | 2 +- docs/api/qiskit/0.42/utils.md | 6 +- 1128 files changed, 2998 insertions(+), 2998 deletions(-) diff --git a/docs/api/qiskit/0.42/execute.md b/docs/api/qiskit/0.42/execute.md index 1af24c354fa..b5c71060410 100644 --- a/docs/api/qiskit/0.42/execute.md +++ b/docs/api/qiskit/0.42/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.42/pulse.md b/docs/api/qiskit/0.42/pulse.md index a8dc8bdc9fd..617c50d4b9b 100644 --- a/docs/api/qiskit/0.42/pulse.md +++ b/docs/api/qiskit/0.42/pulse.md @@ -69,7 +69,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: -`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`Channel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -228,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -677,7 +677,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.42/qasm3.md b/docs/api/qiskit/0.42/qasm3.md index 5ab706d5634..46e2be8a3ce 100644 --- a/docs/api/qiskit/0.42/qasm3.md +++ b/docs/api/qiskit/0.42/qasm3.md @@ -26,7 +26,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. @@ -44,7 +44,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. @@ -65,7 +65,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -99,7 +99,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") +`QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -123,7 +123,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -147,7 +147,7 @@ a circuit representation of the OpenQASM 3 program. -`loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") +`loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -173,7 +173,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") +`QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.md index 78d413acdf9..c3761d68fa1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.md index 877b84bd5c5..0deb3cd1025 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") +`AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") Bases: `qiskit.primitives.primitive_job.PrimitiveJob` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.md index c93e4539d10..8924b380bfa 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.md index 650136dfd86..3b3fcf59e4c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.md index b18f288a597..b1ffb856422 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -77,7 +77,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -98,7 +98,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -119,7 +119,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -145,7 +145,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.md index 89ca764cc51..0f7fc6e086c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.md index 763f10c1313..d7867df6ad9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.md index 3ba8931a981..35bb6180bc7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.md index 9f532a0eb3e..a92b676db72 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.md index 3b79806ee73..062e3b285e4 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.md index 15f2762b928..59da2bff4c8 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.md index afa2803134e..a1f4169c641 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -40,7 +40,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.md index 44ee65ffc1b..8b2d71c0234 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.md index 52e16421b70..1a2c1c0a0d6 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -52,7 +52,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -72,7 +72,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.md index a24a7e8db42..ac3b3104b4a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.42/qiskit.algorithms.Grover.md index f1a2f489f12..b5744c34d1e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -94,7 +94,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -121,7 +121,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -147,7 +147,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.md index 1548fe84ce2..5aa0bdf654b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.md index cc4125d774e..6b398bc454e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -58,7 +58,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index e93c2502e25..5a66e8a074a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.md index 4e0f4a06b45..0c2e3fc4ca9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The ImaginaryEvolver interface has been superseded by the `qiskit.algorithms.tim -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.md index b86e703ec7f..14ca5760295 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`abstract ImaginaryTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.md index b530d014975..8522722c7d3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -78,7 +78,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 527767991ec..c039cf888b7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.md index 69e3582f8db..bddf50b7ad9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -39,7 +39,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -65,7 +65,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 16fce9b98f9..80135fef84a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -45,7 +45,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -71,7 +71,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -92,7 +92,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -109,7 +109,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 2d71e1a6ca5..5916b5d8e2c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.md index 0020b51c82f..4fa91d25968 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.md index 15dd2cf53ec..3d3c03ae2d9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.md index 58331e05214..4f12f5875ae 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -56,7 +56,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.md index b78d86e7509..54713ce4978 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -28,7 +28,7 @@ The NumPyMinimumEigensolver class has been superseded by the [`qiskit.algorithms -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -49,7 +49,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.md index e5b8219fbc8..098f7a15695 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -158,7 +158,7 @@ quantum algorithm for the time evolution of parameterized circuits, [Quantum 5, -`PVQD.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. @@ -185,7 +185,7 @@ A result object containing the evolution information and evaluated observables. -`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Get a function to evaluate the infidelity between Trotter step and ansatz. @@ -210,7 +210,7 @@ a second callable to evaluate the gradient of the infidelity. -`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform a single time step. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.md index 56eee3c3568..c1ff31b71c0 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.md index 097d4191465..5fef067cefa 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -66,7 +66,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -80,7 +80,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -101,7 +101,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.md index c592522c411..21a0baf2d04 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.md index 64ccc36c8ba..aa2d9ad251b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.md index d94ee5a35ee..6a7b5abc0a1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.md index 649a122e127..41b1ab9f2d5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The RealEvolver interface has been superseded by the `qiskit.algorithms.time_evo -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.md index d75806df219..6c6fe22213f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`abstract RealTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.md index 5aa6b449e68..502935bf7d0 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau = it$ under -`SciPyImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.md index d68a5b94634..20c9e7c1ecc 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, -`SciPyRealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.42/qiskit.algorithms.Shor.md index 8982999aaa8..7414d023a88 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.Shor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Shor -`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor(quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.construct_circuit(N, a=2, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -56,7 +56,7 @@ Quantum circuit. -`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`Shor.factor(N, a=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -84,7 +84,7 @@ results of the algorithm. -`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`static Shor.modinv(a, m)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.md index 88b1cf000ca..f9597830863 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.ShorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ShorResult -`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") +`ShorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.md index e8bcb2be6d2..bd83a89aa09 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: `object` @@ -98,7 +98,7 @@ dict\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), complex] -`TimeEvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.md index d74532b8e54..4cde25ca282 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.md index 020d37c6b6b..762b3487bbc 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -51,7 +51,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -80,7 +80,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.42/qiskit.algorithms.VQD.md index 2380e565403..91ab36ee909 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -48,7 +48,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -69,7 +69,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -90,7 +90,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -117,7 +117,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -147,7 +147,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -163,7 +163,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.md index fb1fd772701..16b061feef0 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.42/qiskit.algorithms.VQE.md index dd580044bc0..23a6a3c17ef 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -76,7 +76,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -97,7 +97,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -118,7 +118,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -145,7 +145,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -172,7 +172,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -188,7 +188,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.md index 16289e5c6f3..4d3a5e339a4 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.md index ea75c10fd8f..fe8d99c0706 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.md index e31d73991b4..65de4e6c96a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ An eigensolver result. -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.md index 06b2f7194a9..21b76befa46 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index caf05a725be..2cc8d0c96f6 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -33,7 +33,7 @@ The NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valu -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -54,7 +54,7 @@ An eigensolver result. -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index dbc5510a9a8..14915b9cedf 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.md index 3ed7f69b21c..d8e32ec02d5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -144,7 +144,7 @@ An eigensolver result. -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.md index f6f4dabd863..54c15655a22 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.estimate_observables.md b/docs/api/qiskit/0.42/qiskit.algorithms.estimate_observables.md index c689df56ba5..e10c285076d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.estimate_observables.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.estimate_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.estimate_observables -`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") +`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.42/qiskit.algorithms.eval_observables.md index cad0372fb98..8cb4a944be0 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eval_observables.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") Pending deprecation: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 5e4df6bfa86..6d16d0cfc89 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Bases: `abc.ABC` @@ -38,7 +38,7 @@ Base class for an `EstimatorGradient` to compute the gradients of the expectatio -`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Run the job of the estimator gradient on the given circuits. @@ -62,7 +62,7 @@ The job object of the gradients of the expectation values. The i-th result corre -`BaseEstimatorGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.md index f94dec0097b..a551921aa07 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Bases: `abc.ABC` @@ -60,7 +60,7 @@ $$ -`BaseQGT.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Run the job of the QGTs on the given circuits. @@ -83,7 +83,7 @@ The job object of the QGTs of the expectation values. The i-th result correspond -`BaseQGT.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.md index 2d22d7a7754..b0079fba151 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Bases: `abc.ABC` @@ -27,7 +27,7 @@ Base class for a `SamplerGradient` to compute the gradients of the sampling prob -`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Run the job of the sampler gradient on the given circuits. @@ -50,7 +50,7 @@ The job object of the gradients of the sampling probability. The i-th result cor -`BaseSamplerGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.md index 98ef0803fe6..5596a747443 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType -`DerivativeType(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") +`DerivativeType(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.md index a2fca87a37f..2db8bda34a0 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") +`EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 7a3ea6bbff5..81798050b1d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") +`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index 4aa3b6cf615..666d81628d5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") +`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index bf3595aec0c..553c40197f9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") +`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.md index 8bc161d035f..94dccf227f1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") +`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.md index d2551d95342..b0b9a347927 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") +`LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 4a835296c52..cd0fd8a953e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") +`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 254b6f2ac6b..92258893f5a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") +`ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.md index ce591d94d0b..84f42ebbb1f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Bases: `abc.ABC` @@ -32,7 +32,7 @@ $$ -`QFI.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Run the job of the QFIs on the given circuits. @@ -51,7 +51,7 @@ The job object of the QFIs of the expectation values. The i-th result correspond -`QFI.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.md index ec72cc7bf99..cea3bda19d5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") +`QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.md index a5d30dc28b7..9af58c1857f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") +`QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index b5a3a460fc4..93b455adf4c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") +`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.md index 1c7d04f66f2..a3dd4ffa498 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") +`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 08a3c462dde..479523cfd8d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") +`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.md index bac2f7cb3d4..e2f4c3c4c15 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") +`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.md index aeeb3337e8c..dd9af027763 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") +`SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 10705143ab1..55e45e718ed 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage -`AbsoluteAverage`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -57,7 +57,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -77,7 +77,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -97,7 +97,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -117,7 +117,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.md index a0baa6474aa..7a770a3c061 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -73,7 +73,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.construct_circuit(matrix, vector, neg_vals=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -101,7 +101,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.md index 3eac543ee0c..d1dd3f779c3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolver -`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.md index 05b6cc4c8e8..12f581d3ba4 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult -`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") +`LinearSolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index d729b912b0c..97f34846b32 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -483,7 +483,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1134,7 +1134,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2133,7 +2133,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") +`abstract LinearSystemMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index 307eb9c7133..aae97f9a273 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable -`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`LinearSystemObservable` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 496e1c64d28..e9c64b1e1a5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional -`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional(main_diag, off_diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -72,7 +72,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.evaluate_classically(solution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -92,7 +92,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -112,7 +112,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.observable_circuit(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -132,7 +132,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index 6023d2b249c..89358514c13 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver -`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -47,7 +47,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.md index 768e4c68f5a..91360495a39 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -505,7 +505,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1156,7 +1156,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1665,7 +1665,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2155,7 +2155,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") +`NumPyMatrix.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index 126210efda6..65f2b4ca666 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -518,7 +518,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.condition_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1169,7 +1169,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.eigs_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1678,7 +1678,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2168,7 +2168,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") +`TridiagonalToeplitz.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 2cd666de64a..20cf2c34781 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -69,7 +69,7 @@ the maximum number of iterations for the adaptive loop. If `None`, the algorithm -`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Computes the minimum eigenvalue. @@ -95,7 +95,7 @@ An [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qis -`classmethod AdaptVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`classmethod AdaptVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 50d105cc089..b77bf184696 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 8b4b8f60845..59d55485770 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ A minimum eigensolver result. -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 8fd386db895..13c0d8084ea 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 49b0154d470..e18b53e8a8f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -26,7 +26,7 @@ The NumPy minimum eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -47,7 +47,7 @@ A minimum eigensolver result. -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 6007ad2d4b9..8fa5658edaf 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.md index df54e147abd..bc1a5a6637c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 05bf7bf2539..b4c2ea54232 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Sampling Minimum Eigensolver Interface. -`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -43,7 +43,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`classmethod SamplingMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 1eba5396f4a..853df6d0b3f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 9dcfac32cdd..a4739f6d797 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -144,7 +144,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`classmethod SamplingVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index 85ed351378f..e73687f4d06 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.md index 51bf986c188..829aed79ca4 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -129,7 +129,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -150,7 +150,7 @@ A minimum eigensolver result. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 4d9492dc3d8..c4986cff3bc 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.md index 8382dd05279..3b5421e71e5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.md index 8bd87981fe0..3377a2c813d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.md index b28d6820b9e..ddd9860012b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.md index ec722dfbbe3..f3201b4dd31 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.md index b92f3958c08..d86bc22153c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.md index 417ca0bc042..cfd378cb04e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.md index 044cdd62086..f589c4181c5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.md index 0a48df3a05e..57feb623f52 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index e87f0d2c37d..6d42e2ffa78 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.md index 0015cb6720e..ac18b7b2f8b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.md index 011adfd6903..72ac2fd2b09 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.md index 0be0e52fb2d..ffc9edff2c1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") @@ -141,7 +141,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`GradientDescent.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Returns an object with the data needed to evaluate the gradient. @@ -155,7 +155,7 @@ If this object contains a gradient function the gradient can be evaluated direct -`GradientDescent.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Condition that indicates the optimization process should come to an end. @@ -173,7 +173,7 @@ When the stepsize is smaller than the tolerance, the optimization process is con -`GradientDescent.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Creates a result of the optimization process. @@ -191,7 +191,7 @@ The result of the optimization process. -`GradientDescent.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Evaluates the gradient. @@ -213,7 +213,7 @@ The data containing the gradient evaluation. -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -299,7 +299,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`GradientDescent.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -332,7 +332,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.GradientDescent#ask -`GradientDescent.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Updates `x` by an ammount proportional to the learning rate and value of the gradient at that point. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.md index 8263430eb27..1f19abc74de 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.md index 4c26cf619a9..67a1ae55613 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.md index a6338965582..814df68ba9b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.md index f4d82e90623..d93d62b858a 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.md index 07fd105ce15..980b1156bf2 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.md index 9107ba9826f..12ab5513ba4 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.md index ca1e1e26ccb..d88a7e979e8 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.md index 8fd99c5dcc5..8d0d4450bb7 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.md index 5bc94cce554..2dc47e03463 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.md index 363ed8aede2..983a4f7b20f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index ae26bc6fc6c..6d2436a94be 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.md index b18066d10e8..33d5d3f7ce2 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.md index c3711e8b04f..9477a3db93d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.md index 5368bdd57cb..700006b7a0c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -154,7 +154,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.md index a407ac6e76b..e4eb2fe2943 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.md index 764a5be40db..f20b3e0a764 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -38,7 +38,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -69,7 +69,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.md index 7e5b2a878af..2e73e27179d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.md index 6ee56a70440..acd8ef6a35b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.md index b0dbd71a103..81fa839d152 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -77,7 +77,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`SteppableOptimizer.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Ask the optimizer for a set of points to evaluate. @@ -95,7 +95,7 @@ An object containing the data needed to make the funciton evaluation to advance -`SteppableOptimizer.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Condition that indicates the optimization process should continue. @@ -111,7 +111,7 @@ Condition that indicates the optimization process should continue. -`abstract SteppableOptimizer.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Returns the result of the optimization. @@ -129,7 +129,7 @@ The result of the optimization process. -`abstract SteppableOptimizer.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Evaluates the function according to the instructions contained in `ask_data`. @@ -182,7 +182,7 @@ grad -`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Minimizes the function. @@ -237,7 +237,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -256,7 +256,7 @@ Populates the state of the optimizer with the data provided and sets all the cou -`SteppableOptimizer.step()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.step()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Performs one step in the optimization process. @@ -270,7 +270,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#a -`SteppableOptimizer.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Updates the optimization state using the results of the function evaluation. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.md index 75cfef2dfa7..60fca8692f9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.md index ac914eef91d..3cb175e90b5 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.md index d54be830117..49e880bce02 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 99399f21d71..10677c3234c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: `Generator` @@ -34,7 +34,7 @@ Raise GeneratorExit inside generator. -`LearningRate.send(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.send(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Send a value into the generator. Return next yielded value or raise StopIteration. @@ -42,7 +42,7 @@ Send a value into the generator. Return next yielded value or raise StopIteratio -`LearningRate.throw(typ, val=None, tb=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.throw(typ, val=None, tb=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Raise an exception in the generator. Return next yielded value or raise StopIteration. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index bbd9988735a..e94d8adc07b 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: `abc.ABC` @@ -28,7 +28,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. @@ -49,7 +49,7 @@ The fidelity quantum circuit corresponding to `circuit_1` and `circuit_2`. -`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.md index f10a6de0474..7c548640817 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`ComputeUncompute(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") @@ -39,7 +39,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Combines `circuit_1` and `circuit_2` to create the fidelity circuit following the compute-uncompute method. @@ -80,7 +80,7 @@ Primitive job for the fidelity calculation. The job’s result is an instance of -`ComputeUncompute.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Update the fidelity’s default options setting. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.md index ae599eaaa77..09f7ada9ad9 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index d052f200f6a..24c45c3ff12 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`TrotterQRTE(product_formula=None, estimator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, estimator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using an estimator primitive provided. @@ -78,7 +78,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index ea3308b2971..3b615abcd7f 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `scipy.integrate._ivp.base.OdeSolver` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index a5b45defcee..443bf02d1c1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") @@ -31,7 +31,7 @@ Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize -`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index 6cc04edc73a..6b2675e483c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index 7ad673b1f5a..e9c506af13e 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") @@ -31,7 +31,7 @@ Class for a Real McLachlan’s Variational Principle. It aims to minimize the di -`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 47d8c8abc79..d8cdb9e2edf 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 040fe82af2f..0be6a279966 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: `abc.ABC` @@ -47,7 +47,7 @@ Instance of a class used to compute the state gradient. -`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. @@ -66,7 +66,7 @@ An evolution gradient. -`VariationalPrinciple.metric_tensor(ansatz, param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple.metric_tensor(ansatz, param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates a metric tensor according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.md index 4f87ece860a..90f39a8920b 100644 --- a/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.42/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.42/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.42/qiskit.assembler.assemble_circuits.md index 987eaf598a7..1c6e57ff275 100644 --- a/docs/api/qiskit/0.42/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.42/qiskit.assembler.assemble_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.42/qiskit.assembler.assemble_schedules.md index adae82eadb2..7329ed3cc99 100644 --- a/docs/api/qiskit/0.42/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.42/qiskit.assembler.assemble_schedules.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.42/qiskit.assembler.disassemble.md index 8a6722e2d6d..a5aa312d43a 100644 --- a/docs/api/qiskit/0.42/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.42/qiskit.assembler.disassemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.md index 8fa12e98d6a..90e7b731604 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.md index 416778a78f5..a0034aa9976 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.md index d7fecec8d82..88ad59b9cd0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.md index 11f7c25eb70..2b314ec5d74 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.md index ef681a84289..f05c007ba60 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.42/qiskit.circuit.Clbit.md index 43a47cbe1b3..ac503293d5f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.md index 804ed3e332b..84e5e12c1eb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.md index c3a59f63e36..12045265b61 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.md index 1ca88d3f262..34447b10209 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -206,7 +206,7 @@ updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Delay.md b/docs/api/qiskit/0.42/qiskit.circuit.Delay.md index da2e5d5f610..2bf5a2abfad 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.md index a3d0b4660a3..d323cabefa6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.keys()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.keys()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return list of keys to key to node index map. @@ -133,7 +133,7 @@ List -`EquivalenceLibrary.node_index(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.node_index(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return node index for a given key. @@ -153,7 +153,7 @@ Int -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.md index 929aa14ed46..c80eaf2a074 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Gate.md b/docs/api/qiskit/0.42/qiskit.circuit.Gate.md index 080a24edfc7..8d3ae99783d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.md index a7d5e571f02..683b99898d6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.42/qiskit.circuit.Instruction.md index de74c5a2202..09f911b5f24 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.md index b5171aeefc8..519d1e47b3f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -107,7 +107,7 @@ qc.draw('mpl') -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Operation.md b/docs/api/qiskit/0.42/qiskit.circuit.Operation.md index 02971757072..c7860b43f12 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") +`Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.42/qiskit.circuit.Parameter.md index b6ece9ed4fa..017037f25cd 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") +`Parameter(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -203,7 +203,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.md index b7cd30b40f0..4567d7c54b2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -107,7 +107,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -119,7 +119,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -127,7 +127,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -135,7 +135,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -155,7 +155,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -163,7 +163,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -171,7 +171,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -179,7 +179,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -206,7 +206,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -220,7 +220,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.md index 8ebdbd000e6..5a8df333eb9 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.md index c9cc9c5fcc3..6533ee6c09b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -107,7 +107,7 @@ qc.draw('mpl') -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -119,7 +119,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -142,7 +142,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -154,7 +154,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -184,7 +184,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -256,7 +256,7 @@ circuit.draw('mpl') -`QuantumCircuit.barrier(*qargs, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -277,7 +277,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -306,7 +306,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -330,7 +330,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -342,7 +342,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -362,7 +362,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -387,7 +387,7 @@ A handle to the instructions created. -`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CCZGate`. @@ -413,7 +413,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -438,7 +438,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -452,7 +452,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -464,7 +464,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -476,7 +476,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -505,7 +505,7 @@ A handle to the instructions created. -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -561,7 +561,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -585,7 +585,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -611,7 +611,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -631,7 +631,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -657,7 +657,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -673,7 +673,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -699,7 +699,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -725,7 +725,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -751,7 +751,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -777,7 +777,7 @@ A handle to the instructions created. -`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSGate`. @@ -802,7 +802,7 @@ A handle to the instructions created. -`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSdgGate`. @@ -827,7 +827,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -853,7 +853,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -878,7 +878,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -907,7 +907,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -932,7 +932,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -957,7 +957,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -982,7 +982,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1005,7 +1005,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1026,7 +1026,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1052,7 +1052,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1103,7 +1103,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1177,7 +1177,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1200,7 +1200,7 @@ A handle to the instructions created. -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1231,7 +1231,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -1286,7 +1286,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1314,7 +1314,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Construct a circuit from an iterable of CircuitInstructions. @@ -1335,7 +1335,7 @@ The quantum circuit. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1355,7 +1355,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1375,7 +1375,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1395,7 +1395,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1425,7 +1425,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1433,7 +1433,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1453,7 +1453,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1475,7 +1475,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1501,7 +1501,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1547,7 +1547,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str] = 'None') → qiskit.circuit.instructionset.InstructionSet` @@ -1701,7 +1701,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1803,7 +1803,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1826,7 +1826,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1912,7 +1912,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1953,7 +1953,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1990,7 +1990,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2015,7 +2015,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2037,7 +2037,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2066,7 +2066,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2089,7 +2089,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2109,7 +2109,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2123,7 +2123,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2139,7 +2139,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2151,7 +2151,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2174,7 +2174,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2195,7 +2195,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2321,7 +2321,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2348,7 +2348,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2368,7 +2368,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2388,7 +2388,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2415,7 +2415,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2442,7 +2442,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2466,7 +2466,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2491,7 +2491,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2515,7 +2515,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2537,7 +2537,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2557,7 +2557,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2577,7 +2577,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2631,7 +2631,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2671,7 +2671,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2698,7 +2698,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2722,7 +2722,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2746,7 +2746,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2770,7 +2770,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2794,7 +2794,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2817,7 +2817,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2841,7 +2841,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2865,7 +2865,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3277,7 +3277,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3445,7 +3445,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3523,7 +3523,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3546,7 +3546,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3568,7 +3568,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3590,7 +3590,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3612,7 +3612,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3634,7 +3634,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3679,7 +3679,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3700,7 +3700,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3721,7 +3721,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3749,7 +3749,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3909,7 +3909,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: QuantumCircuit, qubits: Sequence[Union[qiskit.circuit.quantumregister.Qubit, qiskit.circuit.quantumregister.QuantumRegister, int, slice, Sequence[Union[qiskit.circuit.quantumregister.Qubit, int]]]], clbits: Sequence[Union[qiskit.circuit.classicalregister.Clbit, qiskit.circuit.classicalregister.ClassicalRegister, int, slice, Sequence[Union[qiskit.circuit.classicalregister.Clbit, int]]]], *, label: Optional[str]) → qiskit.circuit.instructionset.InstructionSet` @@ -3954,7 +3954,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -3970,7 +3970,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -3993,7 +3993,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4015,7 +4015,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.md index 3315a31e680..bf500adea57 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.42/qiskit.circuit.Qubit.md index 522275d2040..860a3cfc84a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.md index a180e949bc9..c10dc8311ef 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.md index 077e093cc1a..670a65f545c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.md index da86a0d15d6..3ecdf9a61cf 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 08daec4fe67..825facd3392 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index e4ebbf0cbda..b173b304429 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.42/qiskit.circuit.library.AND.md index 031582ea39f..0f7f8c8858e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.md index 75d4412b54c..a21c742a4d3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -51,7 +51,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -72,7 +72,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -106,7 +106,7 @@ updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.md index 446be7cb24d..103a07a58fd 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.md index c2978779dee..941370a632d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.md index a0430dcd9ef..6c120c7dcb1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.md index 71dd510e909..4bbab0696b8 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.md index 00a4d286557..c7e19596210 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.md index 9361f395f57..1c1153df13a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.md index 59e02db96b0..b9aa451a4d8 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) @@ -83,7 +83,7 @@ Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) -`CPhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.md index 39e9e2fc093..e6c10b2b426 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.md index 22a65b6ca0e..40a4f74d7fa 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.md index 289d94ce27a..332447959c1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.md index 3e628baa9b6..815296abd27 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.md index 8e1f38635f4..f8a85f8b357 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.md index 3a34cf79725..14b9925ec37 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.md index b1967837ce1..74c5337eddb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.md index 31adfab3941..12ac1e77bd8 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.md index 4bf901fe96e..f415506b93f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.md index 61e42f333e3..00083d95736 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.md index d49aef13e1c..413a1686833 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.md index 32af862167c..8611dd455f1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.md index 9e94d041f86..cc1ddef096a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.md index e337b84cf28..b56b0e54dda 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.md index 86c6f9aa0bf..a30265302c1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.md index 0471be2d67c..66c5a677663 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 20312a13bb8..a456d2a137d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.md index a70ff147fc8..1bef8ff371b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.md index 7706814523e..6bb45457bd6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.md index 219fd2d8a31..b43c6b486c5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.md index b2132d76b9b..339a4dc1117 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.md index b76990c11ff..b70c7276f09 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GR.md index 061c54beb9e..ac03a4cc021 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.md index c66ffdceb73..8df003bbfb1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.md index bd876053e36..f6e17a20fc5 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.md index 1986c689b36..609655eb705 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.md index 436c246a04c..b9c81d61f89 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.md index 5db6d363ee9..5a7ae762d6d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.md index 8469bf47116..dfd5f7c9b4f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.md index b7a0adfaf1f..b8013dc1d7a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.md index e9f3b22776f..3475549f0eb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.md index f7424870926..b9ca4f45aa2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. @@ -53,7 +53,7 @@ Invert this gate. -`IGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.md index 144b498b31f..144cdbf7f7c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.md index b96cf00abcf..1339184425c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.md index 4506f296fa5..997da9ea612 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.md index 8e832059daf..eb39755fdc0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.md index e622abff0a2..a9520684b76 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.md index ba894acc0bf..f3c4812996e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.md index fad2ed7e5b4..1fb5550b271 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -52,7 +52,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -60,7 +60,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.md index 34090ca5a8d..0570c8a4e5c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -76,7 +76,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.md index 0183c097408..f5cd6fb1f61 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.md index dd69b71ebf0..31850e6f71d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.md index a7da7d059ce..01760a4ec17 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.md index 9f1cde91398..323a6144c55 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.md index d8759215a46..6d8cf59c276 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.md index b51b1906508..8c0c4d6dfb3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.md index f03c9d89380..85ff760e5b0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.md index cd1ebd00d97..a6bd291931d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -74,7 +74,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -100,7 +100,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -122,7 +122,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -165,7 +165,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -181,7 +181,7 @@ The unentangled qubits. -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.42/qiskit.circuit.library.OR.md index 7ecb69a844a..9cfad105bf1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.md index 3297045e664..0506be6a25a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.md index 2176ac038b8..a53f59d644d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.md index 3fc6b245319..26db9ea5c75 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.md index 65d2a8b2c38..5b31cef924e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.md index 8f867d5500a..5be3a4f24e2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.md index e7d54cc2031..6b8d818c000 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -40,7 +40,7 @@ Return a permutation gate. -`PermutationGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Returns the inverse of the permutation. @@ -48,7 +48,7 @@ Returns the inverse of the permutation. -`PermutationGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") The qasm for a permutation. @@ -56,7 +56,7 @@ The qasm for a permutation. -`PermutationGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Parameter validation. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.md index 61ea5e52c28..41570ccb306 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.md index edac42d9b58..8d788b173c1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) @@ -100,7 +100,7 @@ Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) -`PhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.md index 25e60e52689..02ae6a96c20 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.md index 6c65b42c99b..456374c9ed4 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 2ca67b627fb..c092e30323c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 26399cca7d4..07a1484bcbb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.md index 519f022cc07..3c2a5753aba 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.md index 85077acaf72..be5c222a2f0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.md index ae643890823..69930206613 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -55,7 +55,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -71,7 +71,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.md index 19f194c61b3..d2ceb6a4bf8 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.md index 0bad6c825db..c867db45627 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.md index 81a343498b6..4a3cd3df13c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.md index 14ba96a8aa1..236ac3929de 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.md index 68988273b23..a98273ba094 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.md index 0de358c93c6..de354d4a3d8 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. @@ -54,7 +54,7 @@ r(θ, φ)^dagger = r(-θ, φ) -`RGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.md index e4dbcee741a..487259ed54d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.md index 87c03d6b6f2..2a1c7493394 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. @@ -76,7 +76,7 @@ $RX(\lambda)^{\dagger} = RX(-\lambda)$ -`RXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.md index cfd9f8b60d0..e99913091f3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RXX gate (i.e. with the negative rotation angle). -`RXXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.md index e74136d5b85..44137c5143c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. @@ -76,7 +76,7 @@ $RY(\lambda){\dagger} = RY(-\lambda)$ -`RYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.md index c8de5d40a44..f47d3e76177 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RYY gate (i.e. with the negative rotation angle). -`RYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.md index 85fa328b294..13d82090db2 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate @@ -88,7 +88,7 @@ $RZ(\lambda){\dagger} = RZ(-\lambda)$ -`RZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.md index f5ed86678ae..cd5cf462943 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). @@ -116,7 +116,7 @@ Return inverse RZX gate (i.e. with the negative rotation angle). -`RZXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.md index ac5b92a837e..f85e86c8254 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). @@ -90,7 +90,7 @@ Return inverse RZZ gate (i.e. with the negative rotation angle). -`RZZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.md index 7bf0c1c8078..bf886ed1c21 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.md index 6205e0ff1b1..84c1f90d196 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.md index 39dafb99cf8..5af27cad582 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). @@ -57,7 +57,7 @@ Return inverse of S (SdgGate). -`SGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.md index 1ee0a76c765..c681575c30a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.md index ebdf3a8770e..9aa7eef2187 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.md index dd7732f601d..36e9d20daf1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). @@ -57,7 +57,7 @@ Return inverse of Sdg (SGate). -`SdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.md index 7b5aa7feaa8..cba0ca71181 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.md index e700f960e4d..db3eea03411 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.md index bbddfdff0f2..907f7e0dfc0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). @@ -57,7 +57,7 @@ Return inverse T gate (i.e. Tdg). -`TGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.md index ce83234bf4b..e3824566ebe 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). @@ -57,7 +57,7 @@ Return inverse Tdg gate (i.e. T). -`TdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.md index 9532d0e2a5c..42fba33cac0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -134,7 +134,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.md index 0fcc929f76b..6be66dd79ee 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -83,7 +83,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -105,7 +105,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.md index 8dbe6a07d67..dbf69d179b6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.md index a69aa7d5aed..6863f9effda 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -96,7 +96,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.md index 16f8b8d2daf..a588af243bb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.md index c31f064a6d7..90d261e0db3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.md index 5383f3106af..a22d2ffc640 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.md index d6e2b1195cf..a86240373b7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.md index 34646e43323..f9696bcf54a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.md index d378f67a9b6..9bc00161206 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. @@ -86,7 +86,7 @@ Inverse gate. -`XXMinusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.md index ac25436d40a..337f31ce50a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). @@ -86,7 +86,7 @@ Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase -`XXPlusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.md index 8f4f8a2e5f7..94eb7049d04 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.md index 0939d3642ac..c7671285dc1 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.md index bcc47dc0d31..ed03feca04b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). @@ -96,7 +96,7 @@ Return inverted Z gate (itself). -`ZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.md index f9e2f9dff3b..14c2f006500 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_1.md index 537a2592732..39d5df7239a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_2.md index cbc054b1f73..fe878c0871d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_3.md index 4067d4099cf..0e7fe5a15f9 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_4.md index df5a5b13f6a..6dcce274813 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_2_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_3_1.md index d6dab2fc07a..b03a3035831 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_3_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_1.md index e5cb97250c1..9c83ff85b38 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_2.md index 57c4ffbdf9b..59dbbef3dbf 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_3.md index 11c7d5cd0e2..059587c2863 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_4.md index 5eafc0a0abe..b1801eac2e6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_4_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_5_1.md index 4838b2afc26..97eec849606 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_5_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_1.md index 0f730a0a850..750f27c8414 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_2.md index 32481500c09..4305b9c7d6f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_3.md index f4c16715bca..37c3a2a9eb7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_4.md index f13175b19b8..5030945f812 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_5.md index b4e83cd6f30..b565c707a8f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_6_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_1.md index 5db991f3aaa..80f71d0ee14 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_2.md index 3509d7227e8..ce5beb27a8c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_3.md index 92a08eaa2a4..e5f385d315d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.clifford_8_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.md index 4d3b6311a5f..39307cb702b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -77,7 +77,7 @@ Create new iSwap gate. -`iSwapGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_cy.md index 2e7c58db696..34cbda2bf44 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_cy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_xz.md index dc512e4fad5..d1993b9377d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_xz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_yz.md index b430c7c7605..8ebf514777c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_yz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz1.md index f6d631f440c..960e560d2c3 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz2.md index 8ddfd743be2..ec227cc0cfa 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz3.md index 4658b8ba613..84a2697df98 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.rzx_zz3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 411cc2785bd..3dbe2fbb715 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index d4658054174..1ec00ffbadc 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 523b9ca1ee1..dc5e045b707 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index ba9d086e738..547fda45d28 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 97efbb86e96..71c1fa7cf2b 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index dcfb88a2083..f17a3a11589 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index eb681b27915..7977d0ecfe6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 7716596b8c7..3b7c4b401e9 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index 2030aff311c..f07d7360644 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index 4f995a87f7e..ee854c45e50 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 63d67446d01..9bcd5b661f7 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index d3feffedd4a..6bc79299d26 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index d5df5a4840d..ead2358ed20 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index f6ceda17a34..ca8f1e625e6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index 3c69aeb9710..ac504aaf766 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 28c6c50f977..10a09d46fad 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index e9ace7e9516..46dc1c8cd4f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index a7b7b028d63..501c28a359f 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 101eb025fac..6bb70c6426a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 0b99372f4f1..116c8706000 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 063a1019dd8..eec5c1da56e 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index a9450c13fb0..4003eb8e2aa 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 57f5f89602e..3d99e9884a6 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index 7add567d79f..b436afdb0e0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 4d21f1ecea0..36aef9e7525 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 912f691818a..8c2be8ce09c 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index b14c7c34ad1..12ac7737910 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index 190aaf00371..058d34cc91a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 6d8196a357f..a4bff248d51 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 6e8b04ad1e3..5db881bee9a 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index cb3aae6bda2..a3886765e61 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 1a502f14d60..55e9f2a4172 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 01cbe2f3259..8713945b288 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 55191519877..a389764e230 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index 3e604d8aae5..b3af7d6f6b4 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index d755e41e8c5..7cc9126971d 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 7db3309ec76..bfd297827eb 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 640bdd2e40b..f90983de338 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index 4f16e108b89..13585ff1724 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index 95efa766d85..13f091ff347 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 9547a53343c..e408b3b3527 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 230d5ad3387..9213072f884 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 9e2d4cbe7e4..ebc28a69c32 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index cf0ffb26b11..c704a176587 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index b59fe428856..599696c96e0 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index f05dbd7d8b5..0b9ad3ae335 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index da1c5d8c7d5..8337f735b16 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.42/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.42/qiskit.circuit.random.random_circuit.md index 491264fc206..120c64d92bd 100644 --- a/docs/api/qiskit/0.42/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.42/qiskit.circuit.random.random_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.42/qiskit.compiler.assemble.md b/docs/api/qiskit/0.42/qiskit.compiler.assemble.md index 7e6785ebf9b..cfcd3d0bf51 100644 --- a/docs/api/qiskit/0.42/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.42/qiskit.compiler.assemble.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.42/qiskit.compiler.schedule.md b/docs/api/qiskit/0.42/qiskit.compiler.schedule.md index 2a8358979da..0ad32ddd7a7 100644 --- a/docs/api/qiskit/0.42/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.42/qiskit.compiler.schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.42/qiskit.compiler.sequence.md b/docs/api/qiskit/0.42/qiskit.compiler.sequence.md index 46db9f61083..b63196cd566 100644 --- a/docs/api/qiskit/0.42/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.42/qiskit.compiler.sequence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.42/qiskit.compiler.transpile.md b/docs/api/qiskit/0.42/qiskit.compiler.transpile.md index 0e4a3bcc7d8..2af172819a9 100644 --- a/docs/api/qiskit/0.42/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.42/qiskit.compiler.transpile.md @@ -10,7 +10,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.42/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.42/qiskit.converters.ast_to_dag.md index 2aad366d4d2..d69383bf5a9 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.42/qiskit.converters.ast_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dag.md index 4feea0a45a9..b0de4e02014 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dagdependency.md index 1e567ee1a25..46a0891af60 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_gate.md index dca1b2e68d8..beb2948c541 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_instruction.md index 30931b78b80..4ba61af4d1a 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.42/qiskit.converters.circuit_to_instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.42/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.42/qiskit.converters.dag_to_circuit.md index 75de661f998..608fd540a3e 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.42/qiskit.converters.dag_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.42/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.42/qiskit.converters.dag_to_dagdependency.md index 647d2503827..b5d5955a010 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.42/qiskit.converters.dag_to_dagdependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_circuit.md index cdb6a6fe1f2..b40d7999104 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_circuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_dag.md index d9b24a128f4..64f03ce9732 100644 --- a/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.42/qiskit.converters.dagdependency_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.md index ff178b6d025..70bff723d32 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollapser.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser -`BlockCollapser(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollapser(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class implements various strategies of consolidating blocks of nodes in a D -`BlockCollapser.collapse_to_operation(blocks, collapse_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollapser.collapse_to_operation(blocks, collapse_fn)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") For each block, constructs a quantum circuit containing instructions in the block, then uses collapse\_fn to collapse this circuit into a single operation. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.md index 0ea27eb7ae8..0f480a78d4f 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.BlockCollector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector -`BlockCollector(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ In general, there are multiple ways to collect maximal blocks. The approaches us -`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Collects all blocks that match a given filtering function filter\_fn. @@ -50,7 +50,7 @@ Returns the list of matching blocks only. -`BlockCollector.collect_matching_block(filter_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") +`BlockCollector.collect_matching_block(filter_fn)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Iteratively collects the largest block of input nodes diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.md index 13bc803029a..d25d21dff6d 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops(*, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops(*, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -248,7 +248,7 @@ Mapping\[str, int] -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -258,7 +258,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be staticly known. @@ -283,7 +283,7 @@ int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -291,7 +291,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -315,7 +315,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -337,7 +337,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -345,7 +345,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -361,7 +361,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -369,7 +369,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -389,7 +389,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -397,7 +397,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -405,7 +405,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -419,7 +419,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -427,7 +427,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -435,7 +435,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -443,7 +443,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -451,7 +451,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -471,7 +471,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -483,7 +483,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -504,7 +504,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -512,7 +512,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -520,7 +520,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -528,7 +528,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -549,7 +549,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -557,7 +557,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -565,7 +565,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -573,7 +573,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -581,7 +581,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -589,7 +589,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -597,7 +597,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -613,7 +613,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -626,7 +626,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -634,7 +634,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -642,7 +642,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -650,7 +650,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -660,7 +660,7 @@ Add edges from predecessors to successors. -`DAGCircuit.remove_qregs(*qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qregs(*qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -673,7 +673,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_qubits(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qubits(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove quantum bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -689,7 +689,7 @@ Remove quantum bits from the circuit. All bits MUST be idle. Any registers with -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single node. @@ -718,7 +718,7 @@ The op node that replaces the block. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -734,7 +734,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -744,7 +744,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be statically known. @@ -768,7 +768,7 @@ int -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single operation. qargs, cargs and conditions for the new operation will be inferred from the node to be replaced. The new operation will be checked to match the shape of the replaced operation. @@ -795,7 +795,7 @@ the new node containing the added operation. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -822,7 +822,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -830,7 +830,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -850,7 +850,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -872,7 +872,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -880,7 +880,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.md index 388202e6b04..3a66e03254b 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGCircuitError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.md index 5f9cb4a3aa5..c4163021eed 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.md index c01ae8d158d..9d18531b26c 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Replace a block of nodes with a single node. @@ -326,7 +326,7 @@ It is important that such consolidation preserves commutativity assumptions pres -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -334,7 +334,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -354,7 +354,7 @@ List -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -362,7 +362,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.md index aa28a3cb373..f994eef6bce 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.md index 7bef1e4c88c..13c59da06cf 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=- 1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.md index 7f9f85795fb..c1f117f1230 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.md index 30edf3e38a5..63e063fb756 100644 --- a/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.42/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.md index 32de719c924..a4d0a22ba25 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.42/qiskit.extensions.Initialize.md index bd56ab00cc5..88027e6ce5e 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.md index d280020ae1f..c10522473b0 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.md index 92c4998e5b8..2c487c5b8b8 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.md index 12a96968c46..8bef0385e54 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.md index 3fe670fee26..0ed8decb4ff 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.md index d9e0b5ecd18..16e1e8566e4 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.md index d6e014491de..b8538645b9e 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.md index 30a4c03baf6..c8ba837e900 100644 --- a/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.42/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.md index a7ae52d9bbe..8e9591940b5 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.md index 47086c22c0a..e1a051da997 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.OpflowError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.42/qiskit.opflow.anti_commutator.md index e86d190e5a6..0bf60ccbede 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.anti_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.commutator.md b/docs/api/qiskit/0.42/qiskit.opflow.commutator.md index 6e5fb07c794..de3db2a936b 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.md index 0456cb9f228..b50ddd6ac63 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.md index e523e883979..f69f0b8e7da 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.md index 89d850ea221..b939a7ee84c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.md index b1fd067d35a..fb4275ddb08 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.md index f8678989b8f..fb3f4c405e4 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.md index 48a26ed1dfc..0b6014ef7e3 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.42/qiskit.opflow.double_commutator.md index 49bc33b09d3..57cdee0cd5c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.double_commutator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.md index bc2d0ec43fe..6503fc8b132 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.md index 5c1a7c4d2e4..c402166b50d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.md index 988287f5196..4c4692ea9a5 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.md index 71be240cd87..09773cd7848 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 5acd3002e0e..05d6d07b191 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.md index c24f7f74c40..00732188163 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.md index aa15f120663..a4838377415 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.md index 0d2699444e7..2d349b70ef1 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.md index be305bd5371..5d43d7a3e7e 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.md index 3236f7fc463..49b2c765949 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.md index 7ac480f3b1e..55087d2ba78 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.md index 95203092f19..8f9d3257ff2 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.md index f0dd5f714b1..55a07a1ab66 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.md index 422b0f08822..3f267c0ca7f 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.md index 3c83c73b555..655ab3ada51 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.md index c945ea94df6..1545f97490c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.md index edf49889deb..166fd5493a5 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.md index 761a18e157c..4cdfa384744 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.md index 0549fc2ae7a..ad762c30a89 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.md index 3294ac63cb5..20f5ca9281d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.md index 6b7e9407b3b..7424e36b226 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.md index 8d4591e2265..d1f2ccb708e 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.md index 808e372cdf0..ad4fcbaf95c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.md index c9f06c5223a..55fde925d2b 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.md index cbdba232293..a615691da71 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.md index debdbfbda2d..9d39541b757 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.md index 8431a1a737d..0b356164aee 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. @@ -152,7 +152,7 @@ The circuit representation of the composed operator. -`ComposedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.md index d45f5857737..6f515bf905c 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.md index 1b8544b3c88..60cd4821326 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.md index 4c517541af1..8624aea4b18 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. @@ -116,7 +116,7 @@ The circuit representation of the tensored operator. -`TensoredOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.md index 062a69e7163..3804a13b2ad 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.md index c20e731be22..e14ec072d34 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.md index 680201e9cf7..5ef1f586264 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.md index 4ecb200319a..0641d7a6840 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -172,7 +172,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -182,7 +182,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -194,7 +194,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -216,7 +216,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -236,7 +236,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -260,7 +260,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -297,7 +297,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -321,7 +321,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -333,7 +333,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -349,7 +349,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -361,7 +361,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.md index c8fec82620d..7d54734a567 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 181208b7e3d..5763f55a9b8 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.md index b7aef50f839..35d014df5cf 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.convert_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -82,7 +82,7 @@ This method operates the first part of the tapering. It converts the operator by -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -90,7 +90,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -106,7 +106,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -114,7 +114,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -142,7 +142,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.opflow.primitive_ops.Z2Symmetries#convert_clifford "qiskit.opflow.primitive_ops.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.md index 61328732ac2..43e382588be 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.md index 37207aa05e6..3d595d7ba45 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.md index c7d0ae099bc..56a45714f83 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.md index 3b9d59486b8..b0805f42fb1 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.md index b713aea4165..93c72302e73 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.md index 70a5da7a4b5..e1d2a07cd20 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.md index 4f7ff608921..e22f6cd0c1b 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.md index 2880480a49a..30014d312a3 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -96,7 +96,7 @@ Set options values for the estimator. -`BackendEstimator.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.md index d7fc0f78865..8c7184c8302 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -79,7 +79,7 @@ Set options values for the estimator. -`BackendSampler.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.md index 01c32fe8abb..7a4b72db58f 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Close the session and free resources @@ -45,7 +45,7 @@ Close the session and free resources -`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Run the job of the estimation of expectation value(s). diff --git a/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.md index 37519392c28..c897ad5dce7 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -34,7 +34,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Close the session and free resources @@ -42,7 +42,7 @@ Close the session and free resources -`BaseSampler.run(circuits, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.run(circuits, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Run the job of the sampling of bitstrings. diff --git a/docs/api/qiskit/0.42/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.42/qiskit.primitives.Estimator.md index 9aaafb990d9..a6bb0bce788 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -38,7 +38,7 @@ Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "q -`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") +`Estimator.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.md index e0929a1e689..0cf195db090 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.42/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.42/qiskit.primitives.Sampler.md index f14c48ceca3..6ddfb1b5ee3 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -39,7 +39,7 @@ Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.md index d07f2dc6672..2a9ca29eeea 100644 --- a/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.42/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.42/qiskit.providers.Backend.md b/docs/api/qiskit/0.42/qiskit.providers.Backend.md index 18e60ad5e81..3ea7b914146 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.42/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.md index 83a8dc76c25..e729579e73a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendPropertyError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.42/qiskit.providers.BackendV1.md index 9563703aefa..237d5d813e6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.42/qiskit.providers.BackendV2.md index ff1ae490b38..93cd7e7a5c5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -45,7 +45,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -67,7 +67,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -95,7 +95,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -117,7 +117,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -139,7 +139,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -165,7 +165,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -188,7 +188,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.md index 5d039f69646..26e0d1dea7e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.42/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`BackendV2Converter(backend, name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter(backend, name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -32,7 +32,7 @@ Initialize a BackendV2 converter instance based on a BackendV1 instance. -`BackendV2Converter.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the acquisition channel for the given qubit. @@ -54,7 +54,7 @@ The Qubit measurement acquisition line. -`BackendV2Converter.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the secondary drive channel for the given qubit @@ -82,7 +82,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2Converter.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the drive channel for the given qubit. @@ -104,7 +104,7 @@ The Qubit drive channel -`BackendV2Converter.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the measure stimulus channel for the given qubit. @@ -152,7 +152,7 @@ qubit\_properties -`BackendV2Converter.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.Job.md b/docs/api/qiskit/0.42/qiskit.providers.Job.md index be4d4d20fee..62083094139 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.42/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobError.md b/docs/api/qiskit/0.42/qiskit.providers.JobError.md index 9f780d95c92..5c6fd2ab2dc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.JobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.42/qiskit.providers.JobStatus.md index a4b6663259e..9b26c865247 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.42/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.md index 904562b003d..9f09aa4f3a8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.JobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.42/qiskit.providers.JobV1.md b/docs/api/qiskit/0.42/qiskit.providers.JobV1.md index 9d3cffe0b57..bdc3e2b9a07 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.42/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.42/qiskit.providers.Options.md b/docs/api/qiskit/0.42/qiskit.providers.Options.md index 40dd58c566b..f7e164034bd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.42/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.get(field, default=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.42/qiskit.providers.Provider.md b/docs/api/qiskit/0.42/qiskit.providers.Provider.md index 25a66ac2c3f..045d61a00d4 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.42/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.md index 4cb8cf018b1..67c067e829b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.md index 706d8d392e2..c011e7f8fa5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.QiskitBackendNotFoundError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.md index 4542d93aadb..3deb7c94353 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.42/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.md index 56e1413bf32..46dd3f4e991 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.md index a39510f0233..f0dd6227064 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.md index 964d67a213e..ffd8fa17ec9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.md index 7e3f7048c76..e672d7b7cd1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 004db3ccca5..56d85bbdeed 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.md index e041336f8de..60fc64ba91a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.42/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.42/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.42/qiskit.providers.convert_to_target.md index c46def02bd9..041b625b375 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.42/qiskit.providers.convert_to_target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.convert_to_target -`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") +`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 9bbe2efd197..dc7cc2deb12 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.md index 8d594a5d8c7..67f4198c1a1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.md index 97d30fd5936..91014c4d586 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.md index 8c6a1b169dd..9c15bcedeae 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.md index d64672ed455..3e9033f8993 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.md index 593a3f6e1e9..9c773f90b7f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.md index dee5feae2ad..cc46baee0af 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.md index 066bc4f5075..5729c79fa63 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.md index c97fabc05c1..189f65c0400 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.md index 9ef203b53d3..33e6f83dcc1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.md index d7eb853cc50..d95bd1e007d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.md index 24b299479a0..79f13aba2c5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.md index c26723a5361..3c5be60acf1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.md index 22d821f3d25..426c04fae62 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 3cf34405dbc..61e9fb9434a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.md index d841c3560c8..8e691b01277 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.md index f3ea6bf178c..c746d8d770c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.md index 6bc1208ebd3..842c5272a77 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.md index 2bce1cc001b..3ad72bc071c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.md index 75df2efed43..56c46c054b5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.md index c54b5e1a37f..12d14a3736c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.md index 73dfd91f137..4ba003b7b70 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.md index 7da0caa832e..b38fc3fe5c5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.md index c2c68106766..33201891707 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.md index 56dd58ddcfa..00126d23019 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.md index 8baeffee498..afa533c41ed 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.md index 46f12132c29..c64150726b7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.md index 74585894ad8..4d353be6ea9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.md index 9d2149d7e71..64ac18f353c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.md index b334fd24c68..5a87d3ad6d6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.md index d44da06e21e..5e591ea665e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.md index 9214437bbc2..d7be337f41a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.md index 78df172b18b..cc4049a9c96 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.md index ba740afea96..0f564169bf4 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.md index 32d971597b5..a6cdeba49bc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.md index 69d32b8bf80..9c563bc6fd1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.md index 456a82ff4b1..29e7d37a07a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.md index a873bcb8334..aa5e36173e1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.md index f4f37145c8a..5cbfdd63a85 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.md index 026564eb148..c27f858e18c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.md index d1916d4c750..3a1c7448bb8 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.md index ffde37f6f60..4350bd3fef5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.md index 2931b4d6e7c..333739c02e0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.md index 5fb7ac2df41..873ee9fc8fc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.md index 8c39eaef396..1108e435f8b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.md index 9d22cfbdaca..33ba9dbbebe 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.md index c349edd6143..63e84021726 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.md index 4555cafdae9..48746e3deb7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.md index e504670663e..325397b38c7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.md index 36eff58cd35..ae8be2ba3d1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.md index e1fc2030837..b7435b776fb 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.md index 9821cc122fb..1288fe30eb4 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.md index 96bc87423e4..a44dd7ca968 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.md index 843cbd9b08c..3f550d15adc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.md index 9f2ee0eacbf..60934f4ff6e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index bcee926beda..6d8362d50ab 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.md index b540e939c86..143c29f005e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.md index bb93bb14f02..445be79a2d2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.md index c2b3df68f70..dc5666c7ff3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 1cdd8301ef5..177d8a5de92 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index e2bede2330b..dfb21b83e98 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.md index 8bfc3d057ad..0be75c0191d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.md index ba842fa11a0..3cdc7bdac88 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.md index adff695a4cd..0ec66a3c1fc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.md index 0008e7f2c24..c18ba2a8ee5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.md index e27a9f8070d..09b6a1ecf40 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.md index f352249466e..aea941054b9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.md index ca0e6f34384..07bb2948bcf 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 256a1bf08b1..3c59341eb30 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.md index e2c1bda1b89..1d691024550 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.md index 9fe4b563e54..d4c0500a8a2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index 857824cbe28..955888900a3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.md index 327ea9712dc..809d8828258 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.md index d7631210be5..a30f1b9b00c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.md index e3f9ab018c0..bc65c62494f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.md index 4083d8b5810..7e15127787b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.md index 3224cd37757..5d9ae3f2096 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.md index bda625625e0..bc60803db6c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.md index 07afc5080eb..374ef4f08e3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.md index 83fe3fc50a9..ec7450a3548 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.md index 0a9cda4b1b7..e020b01e98b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.md index 894541fbcd5..765cb88a8e1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.md index 9e48023d5fd..1aaf1207d98 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.md index 9dc4a0cfb9d..9f1d17b999f 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.md index 2855f535d10..d57442a45f6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.md index bfd7b52a9c2..d1d29800c84 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.md index 24f19f6c7da..4e7b3691cb4 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.md index d22938870ea..c34a64ee3d2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.md index adbd05d19c8..da9a3ed0678 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.md index f822a7771d4..f5b7d826952 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.md index 9d02a92cff6..3a198a75a40 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.md index ef73876d251..c0186bce3bd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.md index 1e3538c25c2..527002ac936 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.md index 0b1edf89806..fa7b01ac026 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.md index baf56833f21..394f4357fb6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.md index 57412e8b871..b685c2085bd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.md index 32513514c60..1d49f3848cc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.md index 9bde741d22a..03ece87de60 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.md index fe6ece2e004..a73e7097d93 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.42/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.md index 0e6c0e0b596..806a82cfdcf 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.AccountProvider.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.AccountProvider -`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider(credentials, factory)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -81,7 +81,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -150,7 +150,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.has_service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -178,7 +178,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -220,7 +220,7 @@ Runtime job. -`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.service(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -249,7 +249,7 @@ The specified service. -`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") +`AccountProvider.services()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.md index 17a8f280a65..3a9e9ac2018 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.BackendJobLimit.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/backendjoblimit.py "view source code") +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index b25d3ec7ab7..d7a64cdb999 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidFormat(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index cd6a57baa8d..c1a12a8a02e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidToken(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 8ea00a97320..002fd31583d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsInvalidUrl(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 84b8de0ec65..b7ac5c522bf 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountCredentialsNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.md index 643bf92da68..387e583fcb6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index c25adb85512..e88d0d6afc0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQAccountMultipleCredentialsFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.md index 9491167cd42..88c4c11f758 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackend.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend(configuration, provider, credentials, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -72,7 +72,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.active_jobs(limit=10)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -98,7 +98,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -122,7 +122,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -148,7 +148,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.job_limit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -188,7 +188,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -278,7 +278,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -331,7 +331,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.remaining_jobs_count()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -361,7 +361,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -390,7 +390,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -418,7 +418,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -537,7 +537,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") +`IBMQBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.md index d39ddfcd6e6..5042fe266a6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 2cef57dcf88..5271337feb9 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.md index fa201148834..885d9a33836 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.md index 6437c787f0b..bbb23ed6a64 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendService.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService -`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -102,7 +102,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -156,7 +156,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -229,7 +229,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.my_reservations()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -249,7 +249,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") +`IBMQBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.md index 19ddfe141f5..e9ff97473a3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.md index 3eb1eac3cd4..8d9c8976a02 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQError -`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.md index df5dabdf140..49aec72eb3d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQFactory.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory -`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -52,7 +52,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.delete_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -74,7 +74,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.disable_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -94,7 +94,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -143,7 +143,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.get_provider(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -173,7 +173,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.load_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -201,7 +201,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`IBMQFactory.providers(hub=None, group=None, project=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -227,7 +227,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -272,7 +272,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.stored_account()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -297,7 +297,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") +`static IBMQFactory.update_account(force=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.md index 0e16c7d54d9..f80dbe6dbe2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.IBMQProviderError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") +`IBMQProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.md index 591b45e5673..ada2e858b40 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.RunnerResult.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -68,7 +68,7 @@ dict -`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") +`classmethod RunnerResult.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -172,7 +172,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") +`RunnerResult.get_quasiprobabilities(experiment=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.md index d36957508be..2f03dfbee99 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.Credentials.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Credentials constructor. -`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.connection_parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -71,7 +71,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.is_ibmq()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -87,7 +87,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") +`Credentials.unique_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.md index ed6bef01122..864ef3c2fc0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index a184675e58f..0a73edca6a3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`CredentialsNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index 2b452ff59ce..d01c42a744b 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") +`InvalidCredentialsFormatError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.md index 269a5f73272..22d2bd6cdb6 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent -`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/device_component.py "view source code") +`DeviceComponent` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index a925238e2a5..06cfb3d5867 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryExists(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index 52f23f2551a..7341357d8da 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentEntryNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.md index eb24ac04da6..121f5bbaba7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") +`IBMExperimentError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.md index ae7b128cb28..f64556301c7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService -`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -70,7 +70,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_result(result_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -100,7 +100,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -170,7 +170,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.backends()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -190,7 +190,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -229,7 +229,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -288,7 +288,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -324,7 +324,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_analysis_result(result_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -352,7 +352,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_experiment(experiment_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -380,7 +380,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.delete_figure(experiment_id, figure_name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -409,7 +409,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.device_components(backend_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -437,7 +437,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiment(experiment_id, json_decoder=)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -467,7 +467,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -553,7 +553,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -584,7 +584,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.save_preferences(auto_save=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -610,7 +610,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -642,7 +642,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -691,7 +691,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.md index 056c0844049..f45a311125e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality -`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/constants.py "view source code") +`ResultQuality(value)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.md index 1d8e683a115..771adeb0eae 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJob.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -103,7 +103,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -125,7 +125,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -169,7 +169,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -189,7 +189,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -225,7 +225,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -245,7 +245,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -281,7 +281,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -301,7 +301,7 @@ Job ID. -`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -321,7 +321,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.properties()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -345,7 +345,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -369,7 +369,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -395,7 +395,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -423,7 +423,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -445,7 +445,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -515,7 +515,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -539,7 +539,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.share_level()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -561,7 +561,7 @@ The share level of the job. -`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -593,7 +593,7 @@ The status of the job. -`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -617,7 +617,7 @@ Unsupported method. -`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -637,7 +637,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -665,7 +665,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -694,7 +694,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -738,7 +738,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.md index 4df34a82064..b91dcfbf8be 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.md index bb6d202f593..ae83cb376ab 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.md index 3d85b78c2a7..1469089add5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 0ecbcbb394f..f456f47f054 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index c1ead0ab020..9ea63fead5d 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") +`IBMQJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.md index 25ab198806f..d0317fdc106 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.QueueInfo.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ QueueInfo constructor. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.job_monitor.md index 02258c0e57f..9bae3fa8d96 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.job.job_monitor.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.least_busy.md index 6f2ab3d12b5..e3d03e8b2a3 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.least_busy.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.least_busy -`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/__init__.py "view source code") +`least_busy(backends, reservation_lookahead=60)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.md index 3c2aa084a88..04da8a7f696 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager -`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.job_sets(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -95,7 +95,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -119,7 +119,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -150,7 +150,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index b42a0ccb577..6041ab44197 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 2746e10a94b..259f582afae 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index 56eed9caa99..f287a0945e5 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerJobNotFound(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index a4cc22c11d8..d81bc7d5cdd 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 3760f58b8c8..0d445a6fc94 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQJobManagerUnknownJobSet(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 3a3db678e9a..4b8c653398a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") +`IBMQManagedResultDataNotAvailable(*message)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.md index b0bf23bce54..1fb050e8496 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJob.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob -`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob(start_index, experiments_count, job=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ ManagedJob constructor. -`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -54,7 +54,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -74,7 +74,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -94,7 +94,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.result(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -124,7 +124,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -144,7 +144,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.md index cad9e0246fa..24851681cab 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet -`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet(name=None, short_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -55,7 +55,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.error_messages()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -77,7 +77,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -114,7 +114,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.job_set_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -134,7 +134,7 @@ ID of this job set. -`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -154,7 +154,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.managed_jobs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -174,7 +174,7 @@ A list of managed jobs. -`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.name()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -194,7 +194,7 @@ Name of this job set. -`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.qobjs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -214,7 +214,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -238,7 +238,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -289,7 +289,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.retrieve_jobs(provider, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -315,7 +315,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -344,7 +344,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.statuses()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -364,7 +364,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.tags()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -384,7 +384,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -408,7 +408,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.md index e498b520a46..a223237914c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.managed.ManagedResults.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults -`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults(job_set, backend_name, success)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.combine_results()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -82,7 +82,7 @@ all jobs. -`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.data(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -118,7 +118,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_counts(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -147,7 +147,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_memory(experiment)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -176,7 +176,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_statevector(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -206,7 +206,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") +`ManagedResults.get_unitary(experiment, decimals=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 20296614cd4..771408066d1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService -`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService(provider)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -79,7 +79,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -106,7 +106,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.delete_program(program_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -131,7 +131,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -160,7 +160,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -187,7 +187,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.logout()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -209,7 +209,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -232,7 +232,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.program(program_id, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -264,7 +264,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -292,7 +292,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -335,7 +335,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.set_program_visibility(program_id, public)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -361,7 +361,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -394,7 +394,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") +`IBMRuntimeService.upload_program(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 8836dda57db..cc1278fd918 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -38,7 +38,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`ParameterNamespace.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.md index d10f5c2176d..a4fa8374c47 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`ProgramBackend(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -146,7 +146,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.md index 6e759e9e2f5..aaa7c69817e 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder -`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`ResultDecoder` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") +`classmethod ResultDecoder.decode(data)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index 2948506732f..5e359114521 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -54,7 +54,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeDecoder.object_hook(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index fb09a789926..1e945e0919c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -48,7 +48,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") +`RuntimeEncoder.default(obj)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.md index 64c1788ecd1..b1844b49776 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.backend()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -83,7 +83,7 @@ Backend used for the job. -`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -104,7 +104,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.cancel_result_streaming()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -120,7 +120,7 @@ Cancel result streaming. -`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -140,7 +140,7 @@ Error message string or `None`. -`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -160,7 +160,7 @@ Job ID. -`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.logs()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -188,7 +188,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.result(timeout=None, wait=5, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -218,7 +218,7 @@ Runtime job result. -`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -238,7 +238,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.stream_results(callback, decoder=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -269,7 +269,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.md index 00bbef1ab94..ca3f33aa344 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions(backend_name=None, image=None, log_level=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") +`RuntimeOptions.validate()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.md index 08a9c28e13f..c35a33bee20 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -65,7 +65,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.parameters()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -89,7 +89,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") +`RuntimeProgram.to_dict()` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.md index 2b4d47ecec2..3838341f5b0 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger -`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") +`UserMessenger.publish(message, encoder=, final=False)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.seconds_to_duration.md index 41ee02fe391..f53110a8d43 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.to_python_identifier.md index 134192118f7..29e5961f6a2 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.update_qobj_config.md index 9b184dae9c9..d89a39176aa 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") +`update_qobj_config(qobj, backend_options=None, noise_model=None)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.utc_to_local.md index b9c254dcc61..1ed5dfb00f1 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.utc_to_local.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.validate_job_tags.md index caf5d797c8d..1873f45b3de 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.42/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.md index 03d432ab1a9..e597c938891 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.md index 23442453c57..7525fa58c41 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.md index 3e752eebd6e..a437d90d01a 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.Command.md b/docs/api/qiskit/0.42/qiskit.providers.models.Command.md index ff4919d535c..699b19574ae 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.md index d18bea2eda0..36991ea65c7 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.md index efaf5a8685d..b5cced46263 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.md index 3d2327ada84..e4998fa485c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.md index 9cec55a818d..fd21ef280ec 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.md index e11f0ae4e07..9ea71ee1fdc 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.md index ad04506ab73..6b2a53d276c 100644 --- a/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.42/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.md index 2bb3499aca8..6ba40a8b4ba 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -101,7 +101,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -122,7 +122,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -143,7 +143,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -155,7 +155,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -178,7 +178,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -200,7 +200,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -224,7 +224,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.42/qiskit.pulse.Schedule.md index b5ffc39f0ba..c4619232171 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.md index bdad0d68765..da3ee9c3efe 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -166,7 +166,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -192,7 +192,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -217,7 +217,7 @@ Schedule with updated parameters. -`ScheduleBlock.assign_references(subroutine_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_references(subroutine_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign schedules to references. @@ -277,7 +277,7 @@ Schedule block with assigned subroutine. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -339,7 +339,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -372,7 +372,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -403,7 +403,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -443,7 +443,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -468,7 +468,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -480,7 +480,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_referenced()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_referenced()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the current schedule block contains reference to subroutine. @@ -492,7 +492,7 @@ Return True iff the current schedule block contains reference to subroutine. -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -504,7 +504,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -526,7 +526,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.scoped_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.scoped_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return unassigned parameters with scoped names. @@ -542,7 +542,7 @@ Return unassigned parameters with scoped names. -`ScheduleBlock.search_parameters(parameter_regex)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.search_parameters(parameter_regex)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Search parameter with regular expression. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire.md index ddea77147e4..0ebbfcbc060 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire_channel.md index 4740c15d574..314c2b2a10b 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.acquire_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.active_backend.md index 70f5c6b76db..b66843c6f16 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.active_backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 85676e5fbe7..f5400d203e3 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.active_transpiler_settings.md index 8c050eead2a..f32e2b52cba 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.active_transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_equispaced.md index f7abb59f3b6..cfa99f11bc0 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_equispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_func.md index b8fa40f0dcf..dc61c006af4 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_func.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_left.md index 46e39b38363..446ecd7ff62 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_left.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_right.md index 85ad4f1cf25..2194a18b04f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_right.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_sequential.md index 32c77294ee5..0ba2a42cf86 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.align_sequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.barrier.md index 7c518c47f59..a2059dfc11f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.build.md index f5a80ba9fb6..af3d3eb6c9b 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.build.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.call.md index 289f4989ed7..b8c5778cb1d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.circuit_scheduler_settings.md index 2690f31f73f..ba7787a0be2 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.control_channels.md index f8f0dec1afe..2c96ac58364 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.control_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.cx.md index 18cc9c86811..d82c5273f13 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.cx.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.delay.md index 3bfc0a741ca..217759615b4 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.delay_qubits.md index b0d443000c6..1be65e269f2 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.delay_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.drive_channel.md index 4cc8985420a..f17619f438a 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.drive_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.frequency_offset.md index ab753bbf02d..3edc20543db 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.frequency_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.measure.md index 4ae5f943ab5..a36454365cd 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_all.md index 32d745d26a8..9b021c089aa 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_all.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_channel.md index b2a6a0b8364..9ccdf20d6b1 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.measure_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.num_qubits.md index 64db9937675..3ccffe81655 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.num_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.phase_offset.md index 554699927d6..621cff23924 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.phase_offset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.play.md index 84990b4aaa8..813325930c5 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.qubit_channels.md index 5538e667f20..b083ecfa413 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.qubit_channels.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.reference.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.reference.md index 09565a65d28..9a820a671a5 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.reference.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.reference -`reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.samples_to_seconds.md index 64f1c6dde90..8b0e59f4ba2 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.samples_to_seconds.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.seconds_to_samples.md index d8ac9114603..69aceaf9319 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.seconds_to_samples.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.set_frequency.md index 6531e9ad6b4..4197c39af10 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.set_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.set_phase.md index 28764fb92a6..d218e291d9d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.set_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_frequency.md index b86679ed11d..75f229e5e46 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_frequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_phase.md index 78a344c1396..a5382fa3c11 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.shift_phase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.snapshot.md index 459cc11755b..de5bad56d6f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.transpiler_settings.md index b86e8ce5c27..f36ee8c6f66 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.transpiler_settings.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.u1.md index 70b53383520..362007b9018 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.u1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.u2.md index 5689e9208c3..7e7fbc4653f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.u2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.u3.md index edd35910dd0..05b3a3e9544 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.u3.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.42/qiskit.pulse.builder.x.md index 50e44d8ee87..822353f3e65 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.builder.x.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.md index 9400a701fcc..45dbcde7a39 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`AcquireChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.md index cd5282bfb3f..91f4190a807 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`ControlChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.md index 84992f7a95f..bb41895914b 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`DriveChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.md index e936a32c145..cfe059a17f8 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`MeasureChannel(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.md index db97a471ae8..2c7605d2136 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`MemorySlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.md index 20a0d97ee87..53e159d873f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`RegisterSlot(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.md index 45dfe1c0bec..5b8d7c075c4 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.md index 2191c4ae4c0..8770200a38e 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.md index d3685c1768c..17af2b30b66 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.md index 6abf0349858..b52b069edf0 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.md index e81acb82b14..6d8547af3ef 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.md index 3dcba26e566..ba8067c2437 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") +`Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.md index e8cbe6f7f77..a22211e063c 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") +`RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.md index fc1bb6800f7..05633d42eea 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.md index afb67fae325..2e29282e996 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.md index 45312883111..8f45c1f5c93 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.md index d2346399342..c0fcb16d449 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.md index 9839824acd5..88308e8cb7b 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.md index 1ed2e91bdb3..d5a04eebd09 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") +`TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.md index 29561260fa0..75f005f9614 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Constant.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.md index 2b6e9dca0a5..22cb3d82c92 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Drag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.md index 8a0f7d07ad4..ce0d87d056d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Gaussian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.md index 4a1c157da9e..005a32c32f1 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquareDrag.md index acbc560e389..9534cdce9c7 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.GaussianSquareDrag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.md index 8a9d14e75ed..78c1ab8e881 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.md b/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.md index f0070f1fa30..e2bd0ee7371 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.ScalableSymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse -`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.md index 494b472a30c..c6fdaa077e7 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -159,7 +159,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -186,7 +186,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -198,7 +198,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.md index d2e2833ba34..baf3efa225a 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.42/qiskit.pulse.library.cos.md index 4f10e688a06..c872edb8c0c 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.cos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_deriv.md index d72fd09553d..a6cfa84e80b 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_square.md index 9443df2c001..0fbad854987 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.gaussian_square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.42/qiskit.pulse.library.sawtooth.md index 663df809e46..5329018b08f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.sawtooth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.42/qiskit.pulse.library.sech.md index 2bfc83e8347..64f99a12b4a 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.sech.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.42/qiskit.pulse.library.sech_deriv.md index a1beed16e39..8170bb0fe73 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.sech_deriv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.42/qiskit.pulse.library.sin.md index 20d23ba6db8..fe643787be3 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.sin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.square.md b/docs/api/qiskit/0.42/qiskit.pulse.library.square.md index a94da2f4f97..f2971a7bd98 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.square.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.42/qiskit.pulse.library.triangle.md index 4b68347968b..85034a516e0 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.triangle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.42/qiskit.pulse.library.zero.md index 63ddb1835a4..100b3ca756f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.library.zero.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.md index ab37294e2c0..d6792e1d865 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.md index 3533b01d489..c0ed60a47f6 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.md index 95dc46fa569..ad052551aec 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.md index 614bbd5203d..363a87257f6 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.md index d126a129ee6..ea5c8a90d41 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.add_implicit_acquires.md index 93ac699254f..aeafc86694d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.add_implicit_acquires.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.align_measures.md index ecb1edc1670..2a797760ccc 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.align_measures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_dag.md index 31b1e46df66..72bf309368d 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_dag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_schedule.md index 7e27aedcf7b..c1a9f0f5793 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.block_to_schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.compress_pulses.md index df3c3645df8..082a0982735 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.compress_pulses.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.flatten.md index 26a4ecd06e3..cf86924864f 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.flatten.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.inline_subroutines.md index 49a462a6d7e..81572cb8a85 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.inline_subroutines.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.pad.md index 2646f0c9e5c..e42a68e50fd 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.pad.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_directives.md index abba51e324b..89adb88b8da 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_directives.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_trivial_barriers.md index cd17656eac0..5bb8a1eaa0b 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.42/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.42/qiskit.pulse.transforms.target_qobj_transform.md index f884d7f88df..8bcfb76a998 100644 --- a/docs/api/qiskit/0.42/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.42/qiskit.pulse.transforms.target_qobj_transform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.md index 277a17572f0..730f35d42aa 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.42/qiskit.qasm.OpenQASMLexer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.OpenQASMLexer -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.42/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.42/qiskit.qasm.Qasm.md index 8b967c56cbc..9974221c41a 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.42/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.42/qiskit.qasm.QasmError.md index f46e5034371..76beddf5222 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.42/qiskit.qasm.QasmError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.md index 87382e3a5ac..09de69c1c07 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.42/qiskit.qasm.QasmHTMLStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmHTMLStyle -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.md index 28c44e92bb1..cf40a13868f 100644 --- a/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.42/qiskit.qasm.QasmTerminalStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.QasmTerminalStyle -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.md index 589e7c5f277..c882791084f 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.md index 2f24a336726..28a0da5e4b5 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.md index 11d6ef7a31b..57489fa5b4f 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.md index d2cf0167942..bdea2468934 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.md index 8c903a06dea..601a1532fd3 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.md index c5fbe60c869..eb81f8b2d05 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.md index b04251e571f..f2c28cffba8 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.md index d86cb15111f..ee37d0324d1 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.md index 99ccd488add..ff2b6087515 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.md index 3e51cfeecc5..37dfd6e29c9 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.md index 7c26e8cd34b..e31126b3359 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.md index 3c0e32aab9f..d4d925d48b4 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.md index ed61b696cc7..b949164483d 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.42/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.42/qiskit.qobj.Qobj.md index 3d0ab5f74d3..479ab7575c7 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.md index 798b1649b61..4b990e1c902 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.md index 4004a4d4b68..f34a4e4b725 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.md index 7d0288e4291..40c29287b13 100644 --- a/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.42/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.42/qiskit.qpy.dump.md b/docs/api/qiskit/0.42/qiskit.qpy.dump.md index fe1c9056406..c39d85fd2d8 100644 --- a/docs/api/qiskit/0.42/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.42/qiskit.qpy.dump.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.42/qiskit.qpy.load.md b/docs/api/qiskit/0.42/qiskit.qpy.load.md index 7df78086f70..52bfb57c427 100644 --- a/docs/api/qiskit/0.42/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.42/qiskit.qpy.load.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.md index f96d196e511..10071011251 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.md index 91c327f32eb..5c3eb978bfe 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.md index d212d17052e..59f643470c3 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.md index 37ae598234c..1f28b5b47a9 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin`, [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -123,7 +123,7 @@ Return the conjugate of the Clifford. -`Clifford.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Make a deep copy of current operator. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`classmethod Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_labels(array=False, mode='B')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_labels(array=False, mode='B')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert a Clifford to a list Pauli (de)stabilizer string labels. @@ -437,7 +437,7 @@ list or array -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -445,7 +445,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -453,7 +453,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.md index 50cfbc83179..cf09b1ee06f 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -600,7 +600,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -608,7 +608,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -635,7 +635,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.md index 4542b246e39..b8ebdf08ef0 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.md index 3abf9fd282e..39def6002c6 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -72,7 +72,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. @@ -92,7 +92,7 @@ tuple -`OneQubitEulerDecomposer.build_circuit(gates, global_phase)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.build_circuit(gates, global_phase)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the circuit or dag object from a list of gates. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.md index 2206cf56c8b..f93d1b2cfd8 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -202,7 +202,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -238,7 +238,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -254,7 +254,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -304,7 +304,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -322,7 +322,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -348,7 +348,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -356,7 +356,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to NumPy matrix. @@ -364,7 +364,7 @@ Convert operator to NumPy matrix. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -372,7 +372,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.md index c2e255b98af..dd8e7406ee1 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.md index 21b8cce21d7..a1fb315b744 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.md index ac85fb782f6..2c6fda58c9c 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.md index 2deff1d17db..7502b1cf412 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,7 +247,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,7 +388,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -582,7 +582,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -622,7 +622,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -651,7 +651,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -681,7 +681,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -689,7 +689,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.md index dadfbb98453..f5cfe627ee4 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.md index 3eb55199958..4c33d364797 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.md index 83967a82b4a..6d1dfcea294 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -74,7 +74,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -82,7 +82,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return indices for sorting the rows of the table. @@ -152,7 +152,7 @@ array -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -176,7 +176,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -208,7 +208,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -249,7 +249,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -270,7 +270,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -292,7 +292,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -330,7 +330,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -358,7 +358,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -405,7 +405,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -448,7 +448,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -469,7 +469,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -487,7 +487,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -567,7 +567,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -588,7 +588,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sort the rows of the table. @@ -661,7 +661,7 @@ a sorted copy of the original table. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -689,7 +689,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -715,7 +715,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -737,7 +737,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -757,7 +757,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -765,7 +765,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.md index 79887299f03..2e195282891 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.md index 0b597618db1..bba7aa75c71 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,7 +271,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,7 +433,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -632,7 +632,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -672,7 +672,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -705,7 +705,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -747,7 +747,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.md index 82e0e67a741..8e10c5f2461 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -116,7 +116,7 @@ sv.draw(output='hinton') -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -142,7 +142,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -167,7 +167,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -191,7 +191,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -212,7 +212,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -238,7 +238,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -266,7 +266,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -299,7 +299,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -323,7 +323,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -355,7 +355,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -453,7 +453,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -461,7 +461,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -485,7 +485,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -565,7 +565,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -589,7 +589,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -660,7 +660,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -668,7 +668,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.md index dde447577d0..72ce3cba3df 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.md index 20bc3a33619..2b70ab59c54 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 2eb121a3e84..ed30b833e35 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.md index 4502672b04e..41008b55f09 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.42/qiskit.quantum_info.average_gate_fidelity.md index 68b7ee87ff1..4c634359363 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.average_gate_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.42/qiskit.quantum_info.concurrence.md index 462b4510c77..8fbb8ebd566 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.concurrence.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.42/qiskit.quantum_info.decompose_clifford.md index 15a58126750..a327506a102 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.decompose_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.42/qiskit.quantum_info.diamond_norm.md index 4936b0ed129..0a3fbe5a1d2 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.diamond_norm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.42/qiskit.quantum_info.entanglement_of_formation.md index fb3690b3339..e12c9da1c4d 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.entanglement_of_formation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.42/qiskit.quantum_info.entropy.md index 4db0623c210..0a1ce28209c 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.42/qiskit.quantum_info.gate_error.md index bd50ef1b1f3..b0d21e55214 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.gate_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_distance.md index d112e6e18eb..0b3ee96fc38 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_distance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_fidelity.md index e42f1e60347..5541b159c90 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.hellinger_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.42/qiskit.quantum_info.mutual_information.md index 78bd05e08b2..0647dd165d7 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.mutual_information.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.42/qiskit.quantum_info.partial_trace.md index a5270830cd9..13b64aed669 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.partial_trace.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.42/qiskit.quantum_info.pauli_basis.md index 924486e0a87..ed47b8fc384 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.pauli_basis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.42/qiskit.quantum_info.process_fidelity.md index a8b83a95f9e..25f867150b4 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.process_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.42/qiskit.quantum_info.purity.md index 721d246209e..ca8b1cf76b4 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.purity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_clifford.md index d780529e235..e02d97989f7 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_cnotdihedral.md index 593d64f4d0f..77349e50bcc 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_cnotdihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_density_matrix.md index 3ca0fd49e5d..058d667a5ce 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_hermitian.md index 84fc7189411..d16fcf9868f 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_hermitian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli.md index d0919d4f951..dece2d04e34 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_list.md index 6574676d30e..7354dc4c3b8 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_list.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_table.md index 72695d21f9b..80697d3de2e 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_pauli_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_quantum_channel.md index 8e68bd61b9f..e5576b9adf9 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_quantum_channel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_stabilizer_table.md index 0169f9727cb..2e7fefffb9d 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_stabilizer_table.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_statevector.md index cce3ed138ff..2fea823b9be 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.42/qiskit.quantum_info.random_unitary.md index e80e975f973..c1c9cd87c14 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.random_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.42/qiskit.quantum_info.shannon_entropy.md index 9f2d208b746..12664888216 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.shannon_entropy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.42/qiskit.quantum_info.state_fidelity.md index 4d84e302629..13e96697dbe 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.state_fidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.md index 92980da2fff..1df3c2c2df0 100644 --- a/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.42/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.md index e90496ce5bb..045f1b24e9a 100644 --- a/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.42/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.42/qiskit.result.Counts.md b/docs/api/qiskit/0.42/qiskit.result.Counts.md index 7c496d84975..d5163fdefe4 100644 --- a/docs/api/qiskit/0.42/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.42/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.md index 3a5c5fe1cb8..107c90ab6d4 100644 --- a/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.42/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.md index 8152f25e4ab..5f43730ad42 100644 --- a/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.42/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.md index e6d5af563d4..335a080d578 100644 --- a/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.42/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.42/qiskit.result.Result.md b/docs/api/qiskit/0.42/qiskit.result.Result.md index 20b6e521d37..5f2f2755888 100644 --- a/docs/api/qiskit/0.42/qiskit.result.Result.md +++ b/docs/api/qiskit/0.42/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.42/qiskit.result.ResultError.md b/docs/api/qiskit/0.42/qiskit.result.ResultError.md index 5bdc8f10cc3..c895b528a26 100644 --- a/docs/api/qiskit/0.42/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.42/qiskit.result.ResultError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.42/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.42/qiskit.result.marginal_counts.md index 1d92d6fa354..a00214b1d87 100644 --- a/docs/api/qiskit/0.42/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.42/qiskit.result.marginal_counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.42/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.42/qiskit.result.marginal_distribution.md index 50fc45b68a3..ab34cd0bfd6 100644 --- a/docs/api/qiskit/0.42/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.42/qiskit.result.marginal_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.42/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.42/qiskit.result.marginal_memory.md index 90da19986ed..82f3e3cbe6e 100644 --- a/docs/api/qiskit/0.42/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.42/qiskit.result.marginal_memory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.42/qiskit.result.sampled_expectation_value.md b/docs/api/qiskit/0.42/qiskit.result.sampled_expectation_value.md index 9ae734e4bf5..9f4f50b50ad 100644 --- a/docs/api/qiskit/0.42/qiskit.result.sampled_expectation_value.md +++ b/docs/api/qiskit/0.42/qiskit.result.sampled_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.sampled_expectation_value -`sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") +`sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.md index 7c9c0f199da..41a349955d8 100644 --- a/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.md index 26150641b6f..b5b75ccec28 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.md index e8c9f0fc2ef..585dea0de89 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.md index c6465577a9b..5b6cd42fe7b 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.md index a4bf83b6681..286f6aa5327 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.md index 53da5f61b78..7783e8353b8 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") +`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -33,7 +33,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") +`QDrift.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.md index 7cc7e996aa4..2b0829e406b 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class is called recursively by the transpiler pass, which is why it is sepa -`SolovayKitaevDecomposition.find_basic_approximation(sequence)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.find_basic_approximation(sequence)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Finds gate in `self._basic_approximations` that best represents `sequence`. @@ -48,7 +48,7 @@ Gate in basic approximations that is closest to `sequence`. -`SolovayKitaevDecomposition.load_basic_approximations(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.load_basic_approximations(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Load basic approximations. @@ -72,7 +72,7 @@ A list of basic approximations as type `GateSequence`. -`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Run the algorithm. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.md index 9db1cf42d23..1d5c0ae9fc0 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.generate_basic_approximations.md b/docs/api/qiskit/0.42/qiskit.synthesis.generate_basic_approximations.md index ede4a1f8478..8fbf1204a39 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.generate_basic_approximations.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.generate_basic_approximations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.generate_basic_approximations -`generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_ag.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_ag.md index 7ecda249dd0..e1aaae1c985 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_ag.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_ag.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_ag -`synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_bm.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_bm.md index a1d81910e85..6d3cd19f73a 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_bm.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_bm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_bm -`synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_full.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_full.md index 2c745f2343a..9e8959acf90 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_full.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_full.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_full -`synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_greedy.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_greedy.md index 194d1106e23..e32855558e8 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_greedy.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_greedy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_greedy -`synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_layers.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_layers.md index 6c2b345a32e..b0e2f450f13 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_layers.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_clifford_layers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_clifford_layers -`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of \[1]. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_count_full_pmh.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_count_full_pmh.md index 9251417036d..e86465eaed4 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_count_full_pmh.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_count_full_pmh.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnot_count_full_pmh -`synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") +`synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_depth_line_kms.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_depth_line_kms.md index 98544e67b8d..db55fc4f16c 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_depth_line_kms.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnot_depth_line_kms.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnot_depth_line_kms -`synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_full.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_full.md index 15db6e4a8a9..98c049b1a55 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_full.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_full.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_full -`synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_general.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_general.md index 24d2abc96ce..aa69990e9b1 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_general.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_general.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_general -`synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_two_qubits.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_two_qubits.md index c8537d21d00..e4bf92ecdf6 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_two_qubits.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_cnotdihedral_two_qubits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_two_qubits -`synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_acg.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_acg.md index 81998640617..1d1c0f22a07 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_acg.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_acg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_acg -`synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_basic.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_basic.md index bfee99f7bb3..d69f554b049 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_basic.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_basic.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_basic -`synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. diff --git a/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_depth_lnn_kms.md b/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_depth_lnn_kms.md index ddbf659d603..9a3383f7897 100644 --- a/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_depth_lnn_kms.md +++ b/docs/api/qiskit/0.42/qiskit.synthesis.synth_permutation_depth_lnn_kms.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.synth_permutation_depth_lnn_kms -`synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.42/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.42/qiskit.tools.backend_monitor.md index 8f375df262c..1ddce8a7a59 100644 --- a/docs/api/qiskit/0.42/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.42/qiskit.tools.backend_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.42/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.42/qiskit.tools.backend_overview.md index ae943e14bf9..ac23d602074 100644 --- a/docs/api/qiskit/0.42/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.42/qiskit.tools.backend_overview.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.md b/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.md index 60bde9bf4f9..e18b1653f3b 100644 --- a/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.md +++ b/docs/api/qiskit/0.42/qiskit.tools.events.TextProgressBar.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.events.TextProgressBar -`TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Bases: `qiskit.tools.events.progressbar.BaseProgressBar` @@ -70,7 +70,7 @@ Run when progress bar has completed. -`TextProgressBar.start(iterations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.start(iterations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Start the progress bar. @@ -134,7 +134,7 @@ Unsubscribe a pair event-callback, so the callback will not be called anymore wh -`TextProgressBar.update(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.update(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Update status of progress bar. diff --git a/docs/api/qiskit/0.42/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.42/qiskit.tools.job_monitor.md index d5eab415f1d..71d4758982b 100644 --- a/docs/api/qiskit/0.42/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.42/qiskit.tools.job_monitor.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.42/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.42/qiskit.tools.parallel_map.md index 1ba7ea05678..b36d87976cc 100644 --- a/docs/api/qiskit/0.42/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.42/qiskit.tools.parallel_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.md index 01e7684f560..1c45c1a75dd 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.md index b8ed6c8a159..2d8adbffb78 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.md index c57c7beaa47..e72248e6d59 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -108,7 +108,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -120,7 +120,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -132,7 +132,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -157,7 +157,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -182,7 +182,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -204,7 +204,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -216,7 +216,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -228,7 +228,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -244,7 +244,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -254,7 +254,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -262,7 +262,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -270,7 +270,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -280,7 +280,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -304,7 +304,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -329,7 +329,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -337,7 +337,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.md index 7d7c7964781..72ec446a408 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.md index 61563412856..3bff2984c83 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.md index d1cebbf5482..e9a90ddaab3 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.md index 60c8a1ace31..a7f11da6240 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.md index 0ee681ef048..5551484296c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.md index e70f16f17b4..a85be55c5a5 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.42/qiskit.transpiler.Layout.md index aec70a2f0a1..14964a123a5 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit. @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.md index 6e348546fac..31111124cb2 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. @@ -194,7 +194,7 @@ The transformed circuit(s). -`PassManager.to_flow_controller()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`PassManager.to_flow_controller()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Linearize this manager into a single [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController"), so that it can be nested inside another [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.md index 2a39e258f7f..cbf0a9d6c9d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.md index 7b3bf1e21fb..01dfb47fd6c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.md index 602c9d7c334..aa1a696cbb5 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.Target.md b/docs/api/qiskit/0.42/qiskit.transpiler.Target.md index 83ad12c4808..8335d4bf32a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -136,7 +136,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -165,7 +165,7 @@ for this target. If there are no connectivity constraints in the target this wil -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -189,7 +189,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -211,7 +211,7 @@ List\[str] -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -251,7 +251,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -267,7 +267,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -308,19 +308,19 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -340,7 +340,7 @@ The Instruction instance corresponding to the name. This also can also be the cl -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -364,7 +364,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -388,7 +388,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -408,7 +408,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -424,7 +424,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -463,7 +463,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -481,7 +481,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.md index b3311265ad7..d0460a05000 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.md index 29397d4512e..e69533bbb3e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerAccessError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.md index b7b747e5dac..8c9e8295a97 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.TranspilerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.md index 59f494ffa32..dbb7b9a8767 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ACGSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation -`ACGSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`ACGSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"acg: {qct.size() = }, {qct.depth() = }") -`ACGSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`ACGSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.md index 2e3b1ecf22a..e93944c4342 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index c7a5f92d706..ea147fb7acd 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.md index 46d46e4b721..6fc7ce5a907 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index f5aa9f097b4..b22f0a9ea6e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.md index 845d19175fd..b9f8c655973 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.md index 8cf3523dd09..bcf0526bd9f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.md index 32439b51fa6..693247ec22a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 69e1d864cd7..35dc0299028 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.md index 990f47be323..e342a320e18 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.md index 232c3735abe..c9b1cb0faee 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasicSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation -`BasicSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`BasicSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"basic: {qct.size() = }, {qct.depth() = }") -`BasicSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`BasicSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.md index c1903025a90..07b56710424 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.md index e1799c68b4d..b3ce0a7e154 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.md index c6da41a4cb8..8b4573e4095 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.md index 4f5b996a7bd..941a9d1df72 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.md index 6a13f74c626..18947416521 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.md index c0d427193ff..417fb39de05 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.md index 734b1c13232..95f37340c7a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.md index 96b384f9e91..48f07fb44fc 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.md index 39e06123f91..93fcd5f6b6a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.md index 28504c2a6a6..18d0192a47f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectAndCollapse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse -`CollectAndCollapse(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") +`CollectAndCollapse(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CollectAndCollapse.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") +`CollectAndCollapse.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.md index 95bfe86f3e7..143a93fe3ed 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.md index dbf672a7d46..fa2970a57c9 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.md index b00674be2b8..47f5f9b43f5 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.md index e82a960ed69..38eacf2c366 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.md index 687cceab07e..855f64ef4bb 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.md index b645f918dc1..1a630c74482 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CommutativeInverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Run the CommutativeInverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.md index 9fcde788733..086150dc013 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -92,7 +92,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -118,7 +118,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.md index ac98e454891..3ae9e41b527 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.md index b2996b923a7..6de96092f47 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.md index bb0a6a7e261..8a6f1c504e6 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(instruction_name, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(instruction_name, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 2b0445928bc..3d0fed2a85d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ConvertConditionsToIfOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.md index 24153ce7fd6..0f4823aa9a1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.md index 82f8ffd2890..d30d7b390e1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index d12bbe32b93..8a78c0ae9fe 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.md index ada5bb2b01f..ebf2655234e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.md index 6c031c6c758..1d62e001b9e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.md index 71a9e9e3d33..d961a155323 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(gates_to_decompose=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.md index 67cb56d7a6b..7898f248bf4 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.md index 4090dc1b76f..dd1cc7c64d6 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.md index 5be66a7613a..706303a481e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -94,7 +94,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 3b38a4c450f..57e48f3d8ec 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.md index b957cc8f92a..992916723a1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.md index 40f2ff0ebc2..5d281273b2c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.md index 2189ad9f1a5..0e2d84bfdb6 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.md index 196c151ac92..3797351bb05 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.md index 9320420c64f..db2870a6858 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.md index c47de4326d1..c958afbfee7 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`HighLevelSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run the HighLevelSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.md index 305486d0d0f..81ff05a6a62 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.md index 0d79135232d..c139ee26726 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.md index 542209b6847..2325be9ec36 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(gates_to_cancel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.md index f0a0084a78d..023af163b4c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.KMSSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation -`KMSSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`KMSSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -43,7 +43,7 @@ print(f"kms: {qct.size() = }, {qct.depth() = }") -`KMSSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`KMSSynthesisPermutation.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.md index ca74ca67b4e..7d16dae6a5e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index e58d7e51aa9..e0203a9fee0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 0e941d8d9e6..a4829829d5b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.md index 1864eea3199..f7c3608eb76 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 65666f25189..c230cd4e93a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index de45437444d..fd5ff86a3c3 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -80,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.md index ca00260f50d..be25890ba40 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.md index f06ef2692a9..895b23e352d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 323bb4c6971..17913f7772d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index cdb89beeeb9..078d5a08ca5 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.md index 550684b2578..6b79a03ebf0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`OptimizeCliffords.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Run the OptimizeCliffords pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.md index 1a5fbf4d4f4..e807df0bf6d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(fill_very_end=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 2176f4ebf53..1203896a093 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.md index 52516d51c0d..04bd9d6fff3 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates(inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 028009112cc..772f08f5b66 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -69,7 +69,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") A builder macro to play stretched pulse. @@ -115,7 +115,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index dc933889fd9..a08808a1d03 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.md index 584db8e7671..ae795fbb815 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -49,7 +49,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index f7be66080e1..66e85cf41ed 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.md index ee3a43885ec..6fc40af2574 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.md index 44d7f6dd71b..65bfefda67d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 860f3b34919..fecd5772a73 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ResetAfterMeasureSimplification.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Run the pass on a dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.md index eb3e36b5d62..d811c9b9abf 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.md index 8274d0b0798..c5ef57c3a3c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -90,7 +90,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.md index 465dcc939e1..146cceb5cfe 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.md index af55e1faf61..411bb0252a1 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.md index c07b8b5bc77..cccb5928bde 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.md index af91286dbf6..d8d7e2d093c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -119,7 +119,7 @@ Return the name of the pass. -`SolovayKitaev.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run the `SolovayKitaev` pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index da3fdb354f1..2955f9d148b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -44,7 +44,7 @@ The number of times the decomposition is recursively improved. If None, defaults -`SolovayKitaevSynthesis.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.md index 19b0f4ee58c..0f50785342a 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.md index 185337b2581..57856f53189 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.md index c4dfe0bbd72..c28e5ad4f64 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(inst_durations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.md index 81a007a7f6b..6d62effca24 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -87,7 +87,7 @@ Return the name of the pass. -`TranslateParameterizedGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Run the transpiler pass. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.md index f1af0f14b1c..c806187a689 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.md index 3eaffbdc737..f9b5689de79 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on `dag`. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.md index c87f7fb0563..6d129e33194 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.md index fa05395e7ae..afc79925d0c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.md index 84c61bf79af..e45545cc668 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.md index 3092315c2b5..f65576eaf3f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -66,7 +66,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.md index a75552dfac1..e003368cf7c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.md index d190bc870bf..5b335b7cb06 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(granularity=1, min_length=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.md index 19873d0bd78..dbe275e60ff 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 9a52ea85f26..b01c3684350 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for high-level synthesis plugins. -`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given Operation. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index af10d36ed2c..d7415a3a075 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Class tracking the installed high-level-synthesis plugins. -`HighLevelSynthesisPluginManager.method(op_name, method_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method(op_name, method_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns the plugin for `op_name` and `method_name`. @@ -30,7 +30,7 @@ Returns the plugin for `op_name` and `method_name`. -`HighLevelSynthesisPluginManager.method_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns plugin methods for op\_name. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 2cf4289ae62..c1d11823144 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 15399e0b525..25de05436cb 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 462219d3000..d67a884247f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md index b961b11ed3d..1289536654c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_control_f -`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md index 3577f57d722..2678d3cea07 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_embed_pas -`generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md index 50b0183bcc7..8709024f9ec 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_error_on_ -`generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md index 3046853434f..63a0d72b1af 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_pre_op_pa -`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md index c857d4369c4..342cccf7247 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_routing_p -`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md index 9305e8bbe94..fd4e089c291 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_schedulin -`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md index ee1cf236416..40d90559d25 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_translati -`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md index 51818ed723a..cb58578454c 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q -`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 7aea9ae57c8..60ca848fb50 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index a0dda418fd9..e0579ef614b 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 38cca4e2f22..2f1ea5e7360 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 39231c12d04..5ac56445836 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 41c2dc88a0c..ce5f111daab 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 0080a0e8f7c..5855105eb0e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ A `PassManagerStagePlugin` object can be added to an external package and integr -`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index aa63be7fc5a..a995d332298 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Manager class for preset pass manager stage plugins. -`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a stage diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md index 5a9675b4640..aa138691116 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins -`list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.md index 76d9428b676..98789b1cc3d 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 3265c21d977..4dce5d70fc7 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index c2f783f4b9a..6f5e01b9f86 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 0554e706307..5890367487f 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 89b09b8389a..71b8c4448c0 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 1f5c277f498..32ffac2995e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 95a96991071..ff92c7f410e 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index 6771c2c1d2f..c4bb79bda70 100644 --- a/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.42/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ Implementation of objective function and gradient calculator, which is similar t -`FastCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the gradient of objective function. See description of the base class method. @@ -39,7 +39,7 @@ Computes the gradient of objective function. See description of the base class m -`FastCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. diff --git a/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.md index 13a7db21a1d..15ac8b68196 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.42/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.42/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.42/qiskit.utils.apply_prefix.md index 18e4bc1cafd..8b1ba545b00 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.42/qiskit.utils.apply_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.42/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.42/qiskit.utils.deprecate_arguments.md index 48db8a0fa56..5dd443b550d 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.42/qiskit.utils.deprecate_arguments.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.42/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.42/qiskit.utils.deprecate_function.md index 26966ec6081..23238733546 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.42/qiskit.utils.deprecate_function.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2, category=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.42/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.42/qiskit.utils.detach_prefix.md index a0c0354e4ab..7a741d8468c 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.42/qiskit.utils.detach_prefix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.42/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.42/qiskit.utils.get_entangler_map.md index eb57125b4f7..fc664fd00b1 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.42/qiskit.utils.get_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.42/qiskit.utils.has_aer.md b/docs/api/qiskit/0.42/qiskit.utils.has_aer.md index ee3848bebff..8a189fa5680 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.42/qiskit.utils.has_aer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.42/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.42/qiskit.utils.has_ibmq.md index 63a48b4f364..4b6b1df9958 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.42/qiskit.utils.has_ibmq.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.42/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.42/qiskit.utils.is_main_process.md index a77586ad017..da0011a1c2d 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.42/qiskit.utils.is_main_process.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.42/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.42/qiskit.utils.local_hardware_info.md index d52fb33fc04..6243359925a 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.42/qiskit.utils.local_hardware_info.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.md index 58df10dae46..9e31829a9f8 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.42/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.md index 3652cadf5e8..72b3ee82603 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.42/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. @@ -81,7 +81,7 @@ The on-diagonal elements of the calibration matrices are the probabilities of me -`TensoredMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.42/qiskit.utils.name_args.md b/docs/api/qiskit/0.42/qiskit.utils.name_args.md index 6be1349c741..3b90eb8825c 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.42/qiskit.utils.name_args.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.42/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.42/qiskit.utils.summarize_circuits.md index 0b1d9a1e7bf..f463de57651 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.42/qiskit.utils.summarize_circuits.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.42/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.42/qiskit.utils.validate_entangler_map.md index a1e0f8b0677..bb379d3cb7d 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.42/qiskit.utils.validate_entangler_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.42/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.42/qiskit.utils.wrap_method.md index 5fa0d0601de..e860c3ce79d 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.42/qiskit.utils.wrap_method.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.md index d9c3c13769e..aa7eea04a46 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.VisualizationError.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.42/qiskit.visualization.array_to_latex.md index 8f5384af8ba..71527502656 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.array_to_latex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.42/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.42/qiskit.visualization.circuit_drawer.md index 459ee6a298a..42c05a96a07 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.circuit_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.42/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.42/qiskit.visualization.dag_drawer.md index c483aa5f639..52b4abc4a80 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.dag_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.42/qiskit.visualization.pass_manager_drawer.md index 3eeac3b5ed3..323213b421b 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.pass_manager_drawer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_multivector.md index 43e9ce1e952..65e438bca7e 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_multivector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_vector.md index ccefaa74522..0a1a40db998 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_bloch_vector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_circuit_layout.md index bcb7bdd67f4..ed1ad1163be 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_circuit_layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_coupling_map.md index a3e99874c88..a3e332eeb6d 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_coupling_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_distribution.md index 2dc23ff408a..08c25c0835d 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_distribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_distribution -`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") +`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_error_map.md index 132f17092bc..f50b9abb35e 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_error_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_gate_map.md index 0b6fac9ddd7..cc8a7538c5f 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_gate_map.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_histogram.md index 608d838d1de..1033f63155f 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_histogram.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_city.md index bed55de3f05..834e1128f8a 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_city.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_hinton.md index 60b63d0fe5a..28f02acacf7 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_hinton.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_paulivec.md index 4819ac72f73..d73005705ef 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_paulivec.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_qsphere.md index a5ecbfac212..d69d887bf6e 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.plot_state_qsphere.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.md index 4be541bcafe..10061567376 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.md index 0abf720b463..156b4f2baef 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.md index 192b14169dd..fdfbccc9883 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.md index 02cf563453c..e377904c072 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.42/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.42/qiskit.visualization.visualize_transition.md index 321fbb35f33..797171e5b42 100644 --- a/docs/api/qiskit/0.42/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.42/qiskit.visualization.visualize_transition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.42/qiskit_aer.AerError.md b/docs/api/qiskit/0.42/qiskit_aer.AerError.md index 221eb8d9a50..2974b4a8c76 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.AerError.md +++ b/docs/api/qiskit/0.42/qiskit_aer.AerError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerError -`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aererror.py "view source code") +`AerError(*message)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.42/qiskit_aer.AerProvider.md b/docs/api/qiskit/0.42/qiskit_aer.AerProvider.md index 908e7d46927..90273e6c859 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.AerProvider.md +++ b/docs/api/qiskit/0.42/qiskit_aer.AerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerProvider -`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aerprovider.py "view source code") +`AerProvider` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aerprovider.py "view source code") +`AerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aerprovider.py "view source code") +`AerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.md b/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.md index b4d12b54b8c..22722829df6 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.md +++ b/docs/api/qiskit/0.42/qiskit_aer.AerSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -212,7 +212,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -220,7 +220,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -236,7 +236,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -270,7 +270,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`classmethod AerSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -278,7 +278,7 @@ Initialize simulator from backend. -`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.name()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -366,7 +366,7 @@ The simulation job. -`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") +`AerSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.md b/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.md index 850dcd3a1e9..ff85edbc21e 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.md +++ b/docs/api/qiskit/0.42/qiskit_aer.PulseSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -153,7 +153,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") +`classmethod PulseSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -211,7 +211,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.run(schedules, validate=True, **run_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -237,7 +237,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") +`PulseSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.md b/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.md index da108382d28..1e5588e0340 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.md +++ b/docs/api/qiskit/0.42/qiskit_aer.QasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.configuration()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") +`classmethod QasmSimulator.from_backend(backend, **options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") +`QasmSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.md b/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.md index 58ea2f04aa2..2eb5f0128ce 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.42/qiskit_aer.StatevectorSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") +`StatevectorSimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.md b/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.md index 624070f3a71..bf2f66ae881 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.42/qiskit_aer.UnitarySimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_devices()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.available_methods()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") +`UnitarySimulator.set_option(key, value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.md b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.md index f06e9e1b26e..2e7f68f62c6 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJob -`AerJob(backend, job_id, fn, qobj=None, circuits=None, noise_model=None, config=None, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob(backend, job_id, fn, qobj=None, circuits=None, noise_model=None, config=None, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -39,7 +39,7 @@ Initializes the asynchronous job. -`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.backend()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -47,7 +47,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -67,7 +67,7 @@ Return whether the job has been cancelled. -`AerJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Return the list of QuantumCircuit submitted for this job. @@ -95,7 +95,7 @@ Return whether the job has successfully run. -`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -127,7 +127,7 @@ Return a unique id identifying the job. -`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.qobj()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -143,7 +143,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.status()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -203,7 +203,7 @@ The current JobStatus -`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") +`AerJob.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.md b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.md index f7dadca1f4f..17d47594688 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.42/qiskit_aer.jobs.AerJobSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.jobs.AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet(backend, job_id, fn, experiments, executor=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.cancel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.executor()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.job(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.status(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.submit()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker(experiment)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_job(worker)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") +`AerJobSet.worker_results(worker, timeout=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.md index 06faba3d3f9..e36cd027af5 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.md index a97c02f37e6..0fa39a40102 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveAmplitudesSquared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.md index a2771b7d2dd..6e56f0112da 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`SaveClifford(num_qubits, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.md index 32148b01ba7..584d1d4c452 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.md index bc8532443fc..b0fd8f5f1ac 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValue.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.md index 96cabbebadd..0f0567dd59f 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveExpectationValueVariance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.md index 80e31515e88..01c44eebcb3 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.md index 1ebca1200f1..1286240bdd8 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.md index 5e468ff4b1e..064ec124c6c 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveProbabilitiesDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.md index 746ceedee86..3cec3cec8f3 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.md index bbf8f0c1436..2de2c9f5dbc 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_state.py "view source code") +`SaveState(num_qubits, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.md index 1a3549154b0..415050c40ca 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.md index cc25165d6c2..b5112e9c646 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveStatevectorDict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.md index 60e9e456862..dcca553c16e 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`SaveSuperOp(num_qubits, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.md b/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.md index 5fe66db3245..18c36582a7d 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SaveUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`SaveUnitary(num_qubits, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.md index bf8ac341ac8..e6dd74b36cd 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetDensityMatrix -`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`SetDensityMatrix(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.md index 9cb173c6c7d..1d18d4deccd 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetMatrixProductState.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetMatrixProductState -`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`SetMatrixProductState(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.md b/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.md index 63b145bdc93..6550e184bbf 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetStabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStabilizer -`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`SetStabilizer(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.md b/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.md index d97d030b2ba..dcab2b05a04 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetStatevector -`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`SetStatevector(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.md b/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.md index 95203e03ef3..7c603c6eaf7 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetSuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetSuperOp -`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`SetSuperOp(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.md b/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.md index 7c7a60b3751..ffc335b35b7 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.SetUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.SetUnitary -`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`SetUnitary(state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes.md index c61d649f970..6801cace9ff 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes_squared.md index faaae303f99..499dda1645a 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_amplitudes_squared.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_amplitudes_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_clifford.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_clifford.md index 343ad285409..21b709dd6f9 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_clifford.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_clifford -`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_clifford.py "view source code") +`save_clifford(self, label='clifford', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_density_matrix.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_density_matrix.md index a1206f71be9..6a60c9c9c97 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_density_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value.md index 09196e41fd9..62ab3fe6e28 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value_variance.md index d2ba681e336..c989706d27a 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_expectation_value_variance.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_expectation_value_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_matrix_product_state.md index 3f303ad114e..e55e4b04a9c 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_matrix_product_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities.md index fe49c67404c..3badad58803 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities_dict.md index 2d39def63f6..4685ac423e7 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_probabilities_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_probabilities_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_stabilizer.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_stabilizer.md index 1b54acc9bbe..10f94f0f15b 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_state.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_state.md index b04315050b8..230968f5e86 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_state.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_state -`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_state.py "view source code") +`save_state(self, label=None, pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector.md index 4f4769a191f..3d200d26493 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector_dict.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector_dict.md index 8c6c4d56be4..bebcd3fbdc5 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_statevector_dict.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_statevector_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_superop.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_superop.md index a442c5e11a3..5e556c73bb3 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_superop.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_superop -`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_superop.py "view source code") +`save_superop(self, label='superop', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.save_unitary.md b/docs/api/qiskit/0.42/qiskit_aer.library.save_unitary.md index 87d753a8086..62bef0d89ce 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.save_unitary.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.save_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.save_unitary -`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_unitary.py "view source code") +`save_unitary(self, label='unitary', pershot=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.set_density_matrix.md b/docs/api/qiskit/0.42/qiskit_aer.library.set_density_matrix.md index d0136d05723..dd4f198e134 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.set_density_matrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_density_matrix -`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") +`set_density_matrix(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.42/qiskit_aer.library.set_matrix_product_state.md index a99ee4b2a83..51e14c58f4b 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.set_matrix_product_state.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_matrix_product_state -`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") +`set_matrix_product_state(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.set_stabilizer.md b/docs/api/qiskit/0.42/qiskit_aer.library.set_stabilizer.md index f3d0ae7d5f6..04ecdb55243 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.set_stabilizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_stabilizer -`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") +`set_stabilizer(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.set_statevector.md b/docs/api/qiskit/0.42/qiskit_aer.library.set_statevector.md index 3100fbc57ba..633e12fc268 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.set_statevector.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.set_statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_statevector -`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_statevector.py "view source code") +`set_statevector(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.set_superop.md b/docs/api/qiskit/0.42/qiskit_aer.library.set_superop.md index 25a54a00e87..5387987a082 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.set_superop.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.set_superop.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_superop -`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_superop.py "view source code") +`set_superop(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.library.set_unitary.md b/docs/api/qiskit/0.42/qiskit_aer.library.set_unitary.md index 2b97783c844..a8dc6e1cd47 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.library.set_unitary.md +++ b/docs/api/qiskit/0.42/qiskit_aer.library.set_unitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.library.set_unitary -`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_unitary.py "view source code") +`set_unitary(self, state)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.md index 488edd98335..61a91bd6797 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.LocalNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass(func, op_types=None, method='append')` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/passes/local_noise_pass.py "view source code") +`LocalNoisePass.run(dag)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.md b/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.md index 28858724d2c..96253a1b649 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.NoiseModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.NoiseModel -`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel(basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_basis_gates(instructions)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -125,7 +125,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -148,7 +148,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.add_readout_error(error, qubits, warnings=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -170,7 +170,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', warnings=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', warnings=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -235,7 +235,7 @@ An approximate noise model for the device backend. -`classmethod NoiseModel.from_backend_properties(backend_properties, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`classmethod NoiseModel.from_backend_properties(backend_properties, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a backend properties. @@ -268,7 +268,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`static NoiseModel.from_dict(noise_dict)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -292,7 +292,7 @@ the noise model. -`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.is_ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -300,7 +300,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.reset()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Reset the noise model. @@ -308,7 +308,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") +`NoiseModel.to_dict(serializable=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.md b/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.md index 14b2ab08522..f65036fbe40 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.QuantumError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.QuantumError -`QuantumError(noise_ops)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError(noise_ops)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -61,7 +61,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -93,7 +93,7 @@ CLASS -`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -126,7 +126,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.error_term(position)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -151,7 +151,7 @@ tuple -`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -173,7 +173,7 @@ CLASS -`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -247,7 +247,7 @@ BaseOperator -`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -273,7 +273,7 @@ CLASS -`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -281,7 +281,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -289,7 +289,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") +`QuantumError.to_quantumchannel()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.md b/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.md index 27b0cb7a824..3cb2a68d854 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.ReadoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.ReadoutError -`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError(probabilities, atol=1e-08)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.compose(other, front=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.copy()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.dot(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.ideal()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.power(n)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_atol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`classmethod ReadoutError.set_rtol(value)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_dict()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") +`ReadoutError.to_instruction()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.md index 9a7e2bfc2e2..a3718fb9755 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.RelaxationNoisePass.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.amplitude_damping_error.md index 1fd71730976..4aec9d57284 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.amplitude_damping_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.coherent_unitary_error.md index f746501decc..20568c2e124 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.coherent_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.coherent_unitary_error -`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`coherent_unitary_error(unitary)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.depolarizing_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.depolarizing_error.md index 2eadd4adafe..4d633ac9728 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.depolarizing_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.depolarizing_error -`depolarizing_error(param, num_qubits)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`depolarizing_error(param, num_qubits)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_gate_errors.md index d570d2a5502..7a3b0db043c 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_gate_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_gate_errors -`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, warnings=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/models.py "view source code") +`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, warnings=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/models.py "view source code") Return QuantumErrors derived from either of a devices BackendProperties or Target. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_readout_errors.md index 3e4d752cd54..dd26744f7ff 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.basic_device_readout_errors.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.basic_device_readout_errors -`basic_device_readout_errors(properties=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/models.py "view source code") +`basic_device_readout_errors(properties=None, target=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/models.py "view source code") Return readout error parameters from either of device Target or BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_error_values.md index 2a8d8249730..e30c45e2de9 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_error_values -`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") +`gate_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_length_values.md index 82dba111828..9dac20f8afa 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_length_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_length_values -`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") +`gate_length_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_param_values.md index 5dd260a8c7e..8dd857714ba 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.gate_param_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.gate_param_values -`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") +`gate_param_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.readout_error_values.md index 91676f231c9..d0f1d5f4a91 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.readout_error_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.readout_error_values -`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") +`readout_error_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.42/qiskit_aer.noise.device.thermal_relaxation_values.md index 36582cafbe7..dca9d71e4f9 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.device.thermal_relaxation_values.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.device.thermal_relaxation_values -`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") +`thermal_relaxation_values(properties)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.kraus_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.kraus_error.md index 62270f36fb4..0023a17faa8 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.kraus_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.kraus_error -`kraus_error(noise_ops, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`kraus_error(noise_ops, canonical_kraus=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.mixed_unitary_error.md index 5756847d43b..f44d6f2a1ba 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.mixed_unitary_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.mixed_unitary_error -`mixed_unitary_error(noise_ops)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`mixed_unitary_error(noise_ops)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.pauli_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.pauli_error.md index 5ebc0796f89..09813dce08e 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.pauli_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.pauli_error -`pauli_error(noise_ops)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`pauli_error(noise_ops)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.phase_amplitude_damping_error.md index 609823d0232..05d1de97b0b 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.phase_amplitude_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_amplitude_damping_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.phase_damping_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.phase_damping_error.md index 4533d80fc36..ed3762b0ef9 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.phase_damping_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.phase_damping_error -`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`phase_damping_error(param_phase, canonical_kraus=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.reset_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.reset_error.md index 647b631e272..18356496132 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.reset_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.reset_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.reset_error -`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`reset_error(prob0, prob1=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.42/qiskit_aer.noise.thermal_relaxation_error.md index 802207ee98d..28c5f9f6bba 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.noise.thermal_relaxation_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.noise.thermal_relaxation_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.md b/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.md index 8296904dfb1..93e4f83d35c 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.md +++ b/docs/api/qiskit/0.42/qiskit_aer.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Estimator -`Estimator(*, backend_options=None, transpile_options=None, run_options=None, approximation=False, skip_transpilation=False, abelian_grouping=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/primitives/estimator.py "view source code") +`Estimator(*, backend_options=None, transpile_options=None, run_options=None, approximation=False, skip_transpilation=False, abelian_grouping=True)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") diff --git a/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.md b/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.md index f31fdd89609..2543500c687 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.md +++ b/docs/api/qiskit/0.42/qiskit_aer.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.primitives.Sampler -`Sampler(*, backend_options=None, transpile_options=None, run_options=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/primitives/sampler.py "view source code") +`Sampler(*, backend_options=None, transpile_options=None, run_options=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -43,7 +43,7 @@ Aer implementation of Sampler class. -`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/primitives/sampler.py "view source code") +`Sampler.close()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.md index e5ea209f934..8fe5f3948d7 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.42/qiskit_aer.pulse.PulseSystemModel.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`PulseSystemModel.control_channel_index(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.42/qiskit_aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.42/qiskit_aer.pulse.duffing_system_model.md index dd9df5fc285..34f60e9c7c7 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.42/qiskit_aer.pulse.duffing_system_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.pulse.duffing_system_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.md b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.md index adb2f4884d8..7ff8bf2d31f 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.md +++ b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerDensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.quantum_info.AerDensityMatrix -`AerDensityMatrix(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix(data, dims=None, **configs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Bases: [`qiskit.quantum_info.states.densitymatrix.DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.states.densitymatrix.DensityMatrix") @@ -36,7 +36,7 @@ The `dims` kwarg is used to `AerDensityMatrix` constructor. -`AerDensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -120,7 +120,7 @@ QuantumState -`AerDensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return the tensor product state other ⊗ self. :param other: a quantum state object. :type other: AerDensityMatrix @@ -161,7 +161,7 @@ complex -`classmethod AerDensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`classmethod AerDensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -187,7 +187,7 @@ the final density matrix. -`static AerDensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`static AerDensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -215,7 +215,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerDensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`classmethod AerDensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -280,7 +280,7 @@ tuple -`AerDensityMatrix.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.metadata()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return result metadata of an operation that executed lastly. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`AerDensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -463,7 +463,7 @@ Additional Information: -`AerDensityMatrix.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -490,7 +490,7 @@ Additional Information: -`AerDensityMatrix.seed(value=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.seed(value=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Set the seed for the quantum state RNG. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`AerDensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return the tensor product state self ⊗ other. :param other: a quantum state object. :type other: AerDensityMatrix @@ -604,7 +604,7 @@ Convert to Operator -`AerDensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") +`AerDensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_densitymatrix.py "view source code") Return a statevector from a pure density matrix. :param atol: Absolute tolerance for checking operation validity. :type atol: float :param rtol: Relative tolerance for checking operation validity. :type rtol: float diff --git a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.md b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.md index 3d083d13572..d355e0d0c45 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.md +++ b/docs/api/qiskit/0.42/qiskit_aer.quantum_info.AerStatevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.quantum_info.AerStatevector -`AerStatevector(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector(data, dims=None, **configs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") @@ -38,7 +38,7 @@ The `dims` kwarg is used to `Statevector` constructor. -`AerStatevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the conjugate of the operator. @@ -210,7 +210,7 @@ complex -`classmethod AerStatevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the output statevector of an instruction. @@ -236,7 +236,7 @@ The final statevector. -`static AerStatevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`static AerStatevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a computational basis statevector. @@ -264,7 +264,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerStatevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`classmethod AerStatevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -353,7 +353,7 @@ tuple -`AerStatevector.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.metadata()` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return result metadata of an operation that executed lastly. @@ -536,7 +536,7 @@ Additional Information: -`AerStatevector.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -563,7 +563,7 @@ Additional Information: -`AerStatevector.seed(value=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") +`AerStatevector.seed(value=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_noise_model.md index 33c6c712125..e5cbf8bf71c 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_noise_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_quantum_error.md index 783714da0a8..c7805d39626 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.utils.approximate_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.approximate_quantum_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.42/qiskit_aer.utils.insert_noise.md b/docs/api/qiskit/0.42/qiskit_aer.utils.insert_noise.md index d4147b3b11c..6bdf4432e0b 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.42/qiskit_aer.utils.insert_noise.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.insert_noise -`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_model_inserter.py "view source code") +`insert_noise(circuits, noise_model, transpile=False)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.42/qiskit_aer.utils.transform_noise_model.md b/docs/api/qiskit/0.42/qiskit_aer.utils.transform_noise_model.md index 32ad09982a8..ae6c919a2f1 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.42/qiskit_aer.utils.transform_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transform_noise_model -`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") +`transform_noise_model(noise_model, func)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_noise_model.md index 877d431fdb1..69dccfc8467 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_noise_model.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_noise_model -`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_noise_model(noise_model, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_quantum_error.md index 542d9dc354f..a99af476618 100644 --- a/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.42/qiskit_aer.utils.transpile_quantum_error.md @@ -10,7 +10,7 @@ python_api_name: qiskit_aer.utils.transpile_quantum_error -`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") +`transpile_quantum_error(error, **transpile_kwargs)` [GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.12/qiskit_aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.42/synthesis_aqc.md b/docs/api/qiskit/0.42/synthesis_aqc.md index c80989b3801..e2d66c0a490 100644 --- a/docs/api/qiskit/0.42/synthesis_aqc.md +++ b/docs/api/qiskit/0.42/synthesis_aqc.md @@ -128,7 +128,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.42/utils.md b/docs/api/qiskit/0.42/utils.md index ba14cb76640..c8663b82d29 100644 --- a/docs/api/qiskit/0.42/utils.md +++ b/docs/api/qiskit/0.42/utils.md @@ -111,7 +111,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -232,7 +232,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -246,7 +246,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From 1a5fdbad35a5986646c7a7bed11c5390b14fa380 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:57:00 +0100 Subject: [PATCH 23/41] Regenerate qiskit 0.43.0 --- docs/api/qiskit/0.43/execute.md | 2 +- docs/api/qiskit/0.43/pulse.md | 8 +- docs/api/qiskit/0.43/qasm.md | 6 +- docs/api/qiskit/0.43/qasm2.md | 10 +- docs/api/qiskit/0.43/qasm3.md | 16 +- .../0.43/qiskit.algorithms.AlgorithmError.md | 2 +- .../0.43/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 4 +- .../qiskit.algorithms.AmplitudeEstimation.md | 12 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 4 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.43/qiskit.algorithms.Eigensolver.md | 6 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 4 +- .../qiskit.algorithms.EvolutionProblem.md | 4 +- .../0.43/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 6 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.43/qiskit.algorithms.Grover.md | 8 +- .../0.43/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 4 +- ...rithms.HamiltonianPhaseEstimationResult.md | 4 +- .../qiskit.algorithms.ImaginaryEvolver.md | 4 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 4 +- ...algorithms.IterativeAmplitudeEstimation.md | 6 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 6 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 10 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 6 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 6 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 6 +- .../api/qiskit/0.43/qiskit.algorithms.PVQD.md | 8 +- .../0.43/qiskit.algorithms.PVQDResult.md | 2 +- .../0.43/qiskit.algorithms.PhaseEstimation.md | 8 +- ...qiskit.algorithms.PhaseEstimationResult.md | 4 +- .../qiskit.algorithms.PhaseEstimationScale.md | 8 +- .../api/qiskit/0.43/qiskit.algorithms.QAOA.md | 2 +- .../0.43/qiskit.algorithms.RealEvolver.md | 4 +- .../0.43/qiskit.algorithms.RealTimeEvolver.md | 4 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 4 +- .../qiskit.algorithms.SciPyRealEvolver.md | 4 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 4 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.43/qiskit.algorithms.TrotterQRTE.md | 6 +- docs/api/qiskit/0.43/qiskit.algorithms.VQD.md | 14 +- .../0.43/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.43/qiskit.algorithms.VQE.md | 14 +- .../qiskit/0.43/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.43/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 6 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 6 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 6 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- .../qiskit.algorithms.estimate_observables.md | 2 +- .../qiskit.algorithms.eval_observables.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 6 +- .../qiskit.algorithms.gradients.BaseQGT.md | 6 +- ...lgorithms.gradients.BaseSamplerGradient.md | 6 +- ...kit.algorithms.gradients.DerivativeType.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.43/qiskit.algorithms.gradients.QFI.md | 6 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 6 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 6 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 6 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 6 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 6 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 6 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.43/qiskit.algorithms.optimizers.ADAM.md | 10 +- .../0.43/qiskit.algorithms.optimizers.AQGD.md | 6 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 6 +- .../0.43/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.43/qiskit.algorithms.optimizers.CRS.md | 4 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 4 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 4 +- .../0.43/qiskit.algorithms.optimizers.ESCH.md | 4 +- .../0.43/qiskit.algorithms.optimizers.GSLS.md | 14 +- ...t.algorithms.optimizers.GradientDescent.md | 16 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 6 +- .../qiskit.algorithms.optimizers.ISRES.md | 4 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.43/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 16 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 4 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 4 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 6 +- .../0.43/qiskit.algorithms.optimizers.SPSA.md | 12 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 6 +- ...lgorithms.optimizers.SteppableOptimizer.md | 18 +- .../0.43/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.43/qiskit.algorithms.optimizers.UMDA.md | 6 +- ...optimizers.optimizer_utils.LearningRate.md | 6 +- ...thms.state_fidelities.BaseStateFidelity.md | 6 +- ...ithms.state_fidelities.ComputeUncompute.md | 6 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 6 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 4 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 4 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 6 +- .../qiskit/0.43/qiskit.assembler.RunConfig.md | 6 +- .../qiskit.assembler.assemble_circuits.md | 2 +- .../qiskit.assembler.assemble_schedules.md | 2 +- .../0.43/qiskit.assembler.disassemble.md | 2 +- .../0.43/qiskit.circuit.AncillaQubit.md | 2 +- .../0.43/qiskit.circuit.AncillaRegister.md | 2 +- docs/api/qiskit/0.43/qiskit.circuit.Bit.md | 2 +- .../qiskit/0.43/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.43/qiskit.circuit.CircuitInstruction.md | 6 +- .../0.43/qiskit.circuit.ClassicalRegister.md | 4 +- docs/api/qiskit/0.43/qiskit.circuit.Clbit.md | 2 +- .../0.43/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.43/qiskit.circuit.ControlFlowOp.md | 4 +- .../0.43/qiskit.circuit.ControlledGate.md | 4 +- docs/api/qiskit/0.43/qiskit.circuit.Delay.md | 12 +- .../0.43/qiskit.circuit.EquivalenceLibrary.md | 16 +- .../qiskit/0.43/qiskit.circuit.ForLoopOp.md | 4 +- docs/api/qiskit/0.43/qiskit.circuit.Gate.md | 12 +- .../qiskit/0.43/qiskit.circuit.IfElseOp.md | 6 +- .../qiskit/0.43/qiskit.circuit.Instruction.md | 26 +- .../0.43/qiskit.circuit.InstructionSet.md | 8 +- .../qiskit/0.43/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.43/qiskit.circuit.Parameter.md | 4 +- .../qiskit.circuit.ParameterExpression.md | 32 +-- .../0.43/qiskit.circuit.ParameterVector.md | 6 +- .../0.43/qiskit.circuit.QuantumCircuit.md | 224 +++++++++--------- .../0.43/qiskit.circuit.QuantumRegister.md | 4 +- docs/api/qiskit/0.43/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.43/qiskit.circuit.Register.md | 4 +- .../0.43/qiskit.circuit.SwitchCaseOp.md | 10 +- .../qiskit/0.43/qiskit.circuit.WhileLoopOp.md | 6 +- ...uit.classicalfunction.BooleanExpression.md | 8 +- ...uit.classicalfunction.ClassicalFunction.md | 10 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.AND.md | 2 +- .../0.43/qiskit.circuit.library.Barrier.md | 8 +- .../0.43/qiskit.circuit.library.C3SXGate.md | 4 +- .../0.43/qiskit.circuit.library.C3XGate.md | 6 +- .../0.43/qiskit.circuit.library.C4XGate.md | 6 +- .../0.43/qiskit.circuit.library.CCXGate.md | 6 +- .../0.43/qiskit.circuit.library.CCZGate.md | 4 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.43/qiskit.circuit.library.CHGate.md | 4 +- .../0.43/qiskit.circuit.library.CPhaseGate.md | 8 +- .../0.43/qiskit.circuit.library.CRXGate.md | 4 +- .../0.43/qiskit.circuit.library.CRYGate.md | 4 +- .../0.43/qiskit.circuit.library.CRZGate.md | 4 +- .../0.43/qiskit.circuit.library.CSGate.md | 6 +- .../0.43/qiskit.circuit.library.CSXGate.md | 2 +- .../0.43/qiskit.circuit.library.CSdgGate.md | 6 +- .../0.43/qiskit.circuit.library.CSwapGate.md | 4 +- .../0.43/qiskit.circuit.library.CU1Gate.md | 6 +- .../0.43/qiskit.circuit.library.CU3Gate.md | 4 +- .../0.43/qiskit.circuit.library.CUGate.md | 4 +- .../0.43/qiskit.circuit.library.CXGate.md | 6 +- .../0.43/qiskit.circuit.library.CYGate.md | 4 +- .../0.43/qiskit.circuit.library.CZGate.md | 4 +- .../0.43/qiskit.circuit.library.DCXGate.md | 2 +- .../0.43/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.43/qiskit.circuit.library.ECRGate.md | 6 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.GRZ.md | 2 +- .../qiskit.circuit.library.GlobalPhaseGate.md | 4 +- .../0.43/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.43/qiskit.circuit.library.HGate.md | 6 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.43/qiskit.circuit.library.IGate.md | 6 +- .../qiskit/0.43/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 4 +- .../qiskit.circuit.library.LinearFunction.md | 10 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.43/qiskit.circuit.library.MCMT.md | 6 +- .../0.43/qiskit.circuit.library.MCMTVChain.md | 4 +- .../qiskit.circuit.library.MCPhaseGate.md | 6 +- .../0.43/qiskit.circuit.library.MCXGate.md | 8 +- .../qiskit.circuit.library.MCXGrayCode.md | 4 +- .../qiskit.circuit.library.MCXRecursive.md | 6 +- .../0.43/qiskit.circuit.library.MCXVChain.md | 6 +- .../0.43/qiskit.circuit.library.MSGate.md | 2 +- .../0.43/qiskit.circuit.library.Measure.md | 4 +- .../0.43/qiskit.circuit.library.NLocal.md | 12 +- .../qiskit/0.43/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 4 +- .../qiskit.circuit.library.PauliFeatureMap.md | 6 +- .../0.43/qiskit.circuit.library.PauliGate.md | 6 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 6 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.43/qiskit.circuit.library.PhaseGate.md | 8 +- .../qiskit.circuit.library.PhaseOracle.md | 6 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 4 +- ...brary.PiecewisePolynomialPauliRotations.md | 4 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.43/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.43/qiskit.circuit.library.QFT.md | 6 +- .../qiskit.circuit.library.QuadraticForm.md | 4 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.43/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.43/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.43/qiskit.circuit.library.RGate.md | 6 +- .../0.43/qiskit.circuit.library.RVGate.md | 6 +- .../0.43/qiskit.circuit.library.RXGate.md | 8 +- .../0.43/qiskit.circuit.library.RXXGate.md | 6 +- .../0.43/qiskit.circuit.library.RYGate.md | 8 +- .../0.43/qiskit.circuit.library.RYYGate.md | 6 +- .../0.43/qiskit.circuit.library.RZGate.md | 8 +- .../0.43/qiskit.circuit.library.RZXGate.md | 6 +- .../0.43/qiskit.circuit.library.RZZGate.md | 6 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.43/qiskit.circuit.library.Reset.md | 4 +- .../0.43/qiskit.circuit.library.SGate.md | 6 +- .../0.43/qiskit.circuit.library.SXGate.md | 6 +- .../0.43/qiskit.circuit.library.SXdgGate.md | 4 +- .../0.43/qiskit.circuit.library.SdgGate.md | 6 +- ...qiskit.circuit.library.StatePreparation.md | 8 +- .../0.43/qiskit.circuit.library.SwapGate.md | 6 +- .../0.43/qiskit.circuit.library.TGate.md | 6 +- .../0.43/qiskit.circuit.library.TdgGate.md | 6 +- .../0.43/qiskit.circuit.library.TwoLocal.md | 4 +- .../0.43/qiskit.circuit.library.U1Gate.md | 6 +- .../0.43/qiskit.circuit.library.U2Gate.md | 4 +- .../0.43/qiskit.circuit.library.U3Gate.md | 6 +- .../0.43/qiskit.circuit.library.UGate.md | 6 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.43/qiskit.circuit.library.XGate.md | 6 +- .../qiskit/0.43/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 6 +- .../qiskit.circuit.library.XXPlusYYGate.md | 6 +- .../0.43/qiskit.circuit.library.YGate.md | 6 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.43/qiskit.circuit.library.ZGate.md | 8 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.clifford_2_1.md | 2 +- .../qiskit.circuit.library.clifford_2_2.md | 2 +- .../qiskit.circuit.library.clifford_2_3.md | 2 +- .../qiskit.circuit.library.clifford_2_4.md | 2 +- .../qiskit.circuit.library.clifford_3_1.md | 2 +- .../qiskit.circuit.library.clifford_4_1.md | 2 +- .../qiskit.circuit.library.clifford_4_2.md | 2 +- .../qiskit.circuit.library.clifford_4_3.md | 2 +- .../qiskit.circuit.library.clifford_4_4.md | 2 +- .../qiskit.circuit.library.clifford_5_1.md | 2 +- .../qiskit.circuit.library.clifford_6_1.md | 2 +- .../qiskit.circuit.library.clifford_6_2.md | 2 +- .../qiskit.circuit.library.clifford_6_3.md | 2 +- .../qiskit.circuit.library.clifford_6_4.md | 2 +- .../qiskit.circuit.library.clifford_6_5.md | 2 +- .../qiskit.circuit.library.clifford_8_1.md | 2 +- .../qiskit.circuit.library.clifford_8_2.md | 2 +- .../qiskit.circuit.library.clifford_8_3.md | 2 +- .../0.43/qiskit.circuit.library.iSwapGate.md | 4 +- .../0.43/qiskit.circuit.library.rzx_cy.md | 2 +- .../0.43/qiskit.circuit.library.rzx_xz.md | 2 +- .../0.43/qiskit.circuit.library.rzx_yz.md | 2 +- .../0.43/qiskit.circuit.library.rzx_zz1.md | 2 +- .../0.43/qiskit.circuit.library.rzx_zz2.md | 2 +- .../0.43/qiskit.circuit.library.rzx_zz3.md | 2 +- ...library.templates.nct.template_nct_2a_1.md | 2 +- ...library.templates.nct.template_nct_2a_2.md | 2 +- ...library.templates.nct.template_nct_2a_3.md | 2 +- ...library.templates.nct.template_nct_4a_1.md | 2 +- ...library.templates.nct.template_nct_4a_2.md | 2 +- ...library.templates.nct.template_nct_4a_3.md | 2 +- ...library.templates.nct.template_nct_4b_1.md | 2 +- ...library.templates.nct.template_nct_4b_2.md | 2 +- ...library.templates.nct.template_nct_5a_1.md | 2 +- ...library.templates.nct.template_nct_5a_2.md | 2 +- ...library.templates.nct.template_nct_5a_3.md | 2 +- ...library.templates.nct.template_nct_5a_4.md | 2 +- ...library.templates.nct.template_nct_6a_1.md | 2 +- ...library.templates.nct.template_nct_6a_2.md | 2 +- ...library.templates.nct.template_nct_6a_3.md | 2 +- ...library.templates.nct.template_nct_6a_4.md | 2 +- ...library.templates.nct.template_nct_6b_1.md | 2 +- ...library.templates.nct.template_nct_6b_2.md | 2 +- ...library.templates.nct.template_nct_6c_1.md | 2 +- ...library.templates.nct.template_nct_7a_1.md | 2 +- ...library.templates.nct.template_nct_7b_1.md | 2 +- ...library.templates.nct.template_nct_7c_1.md | 2 +- ...library.templates.nct.template_nct_7d_1.md | 2 +- ...library.templates.nct.template_nct_7e_1.md | 2 +- ...library.templates.nct.template_nct_9a_1.md | 2 +- ...library.templates.nct.template_nct_9c_1.md | 2 +- ...ibrary.templates.nct.template_nct_9c_10.md | 2 +- ...ibrary.templates.nct.template_nct_9c_11.md | 2 +- ...ibrary.templates.nct.template_nct_9c_12.md | 2 +- ...library.templates.nct.template_nct_9c_2.md | 2 +- ...library.templates.nct.template_nct_9c_3.md | 2 +- ...library.templates.nct.template_nct_9c_4.md | 2 +- ...library.templates.nct.template_nct_9c_5.md | 2 +- ...library.templates.nct.template_nct_9c_6.md | 2 +- ...library.templates.nct.template_nct_9c_7.md | 2 +- ...library.templates.nct.template_nct_9c_8.md | 2 +- ...library.templates.nct.template_nct_9c_9.md | 2 +- ...library.templates.nct.template_nct_9d_1.md | 2 +- ...ibrary.templates.nct.template_nct_9d_10.md | 2 +- ...library.templates.nct.template_nct_9d_2.md | 2 +- ...library.templates.nct.template_nct_9d_3.md | 2 +- ...library.templates.nct.template_nct_9d_4.md | 2 +- ...library.templates.nct.template_nct_9d_5.md | 2 +- ...library.templates.nct.template_nct_9d_6.md | 2 +- ...library.templates.nct.template_nct_9d_7.md | 2 +- ...library.templates.nct.template_nct_9d_8.md | 2 +- ...library.templates.nct.template_nct_9d_9.md | 2 +- .../qiskit.circuit.random.random_circuit.md | 2 +- .../qiskit/0.43/qiskit.compiler.assemble.md | 2 +- .../qiskit/0.43/qiskit.compiler.schedule.md | 2 +- .../qiskit/0.43/qiskit.compiler.sequence.md | 2 +- .../qiskit/0.43/qiskit.compiler.transpile.md | 2 +- .../0.43/qiskit.converters.ast_to_dag.md | 2 +- .../0.43/qiskit.converters.circuit_to_dag.md | 2 +- ...kit.converters.circuit_to_dagdependency.md | 2 +- .../0.43/qiskit.converters.circuit_to_gate.md | 2 +- ...iskit.converters.circuit_to_instruction.md | 2 +- .../0.43/qiskit.converters.dag_to_circuit.md | 2 +- .../qiskit.converters.dag_to_dagdependency.md | 2 +- ...kit.converters.dagdependency_to_circuit.md | 2 +- .../qiskit.converters.dagdependency_to_dag.md | 2 +- .../0.43/qiskit.dagcircuit.DAGCircuit.md | 130 +++++----- .../0.43/qiskit.dagcircuit.DAGCircuitError.md | 2 +- .../0.43/qiskit.dagcircuit.DAGDepNode.md | 6 +- .../0.43/qiskit.dagcircuit.DAGDependency.md | 46 ++-- .../0.43/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.43/qiskit.dagcircuit.DAGNode.md | 4 +- .../0.43/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.43/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.43/qiskit.extensions.HamiltonianGate.md | 14 +- .../0.43/qiskit.extensions.Initialize.md | 6 +- .../qiskit.extensions.SingleQubitUnitary.md | 6 +- .../qiskit/0.43/qiskit.extensions.Snapshot.md | 8 +- .../0.43/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.43/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.43/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.43/qiskit.extensions.UCRZGate.md | 2 +- .../0.43/qiskit.extensions.UnitaryGate.md | 14 +- .../qiskit/0.43/qiskit.opflow.OperatorBase.md | 42 ++-- .../qiskit/0.43/qiskit.opflow.OpflowError.md | 2 +- .../0.43/qiskit.opflow.anti_commutator.md | 2 +- .../qiskit/0.43/qiskit.opflow.commutator.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 6 +- ...qiskit.opflow.converters.CircuitSampler.md | 8 +- .../qiskit.opflow.converters.ConverterBase.md | 4 +- ...skit.opflow.converters.DictToCircuitSum.md | 4 +- ...skit.opflow.converters.PauliBasisChange.md | 22 +- ...kit.opflow.converters.TwoQubitReduction.md | 4 +- .../0.43/qiskit.opflow.double_commutator.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 4 +- ...skit.opflow.evolutions.EvolutionFactory.md | 4 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 30 +-- ...iskit.opflow.evolutions.MatrixEvolution.md | 4 +- ...opflow.evolutions.PauliTrotterEvolution.md | 8 +- .../0.43/qiskit.opflow.evolutions.QDrift.md | 4 +- .../0.43/qiskit.opflow.evolutions.Suzuki.md | 4 +- .../0.43/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 4 +- ...opflow.evolutions.TrotterizationFactory.md | 4 +- ...opflow.expectations.AerPauliExpectation.md | 6 +- ...kit.opflow.expectations.CVaRExpectation.md | 6 +- ...kit.opflow.expectations.ExpectationBase.md | 6 +- ....opflow.expectations.ExpectationFactory.md | 4 +- ...t.opflow.expectations.MatrixExpectation.md | 6 +- ...it.opflow.expectations.PauliExpectation.md | 6 +- ...qiskit.opflow.gradients.CircuitGradient.md | 4 +- .../qiskit.opflow.gradients.CircuitQFI.md | 4 +- .../qiskit.opflow.gradients.DerivativeBase.md | 8 +- .../0.43/qiskit.opflow.gradients.Gradient.md | 6 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.43/qiskit.opflow.gradients.Hessian.md | 6 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 6 +- .../0.43/qiskit.opflow.gradients.QFI.md | 4 +- .../0.43/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.43/qiskit.opflow.list_ops.ComposedOp.md | 16 +- .../0.43/qiskit.opflow.list_ops.ListOp.md | 46 ++-- .../0.43/qiskit.opflow.list_ops.SummedOp.md | 16 +- .../0.43/qiskit.opflow.list_ops.TensoredOp.md | 12 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 30 +-- .../qiskit.opflow.primitive_ops.MatrixOp.md | 26 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 30 +-- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 40 ++-- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 42 ++-- ....opflow.primitive_ops.TaperedPauliSumOp.md | 4 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 16 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 30 +-- .../qiskit.opflow.state_fns.CircuitStateFn.md | 36 +-- .../qiskit.opflow.state_fns.DictStateFn.md | 26 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 24 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 24 +- .../0.43/qiskit.opflow.state_fns.StateFn.md | 40 ++-- .../qiskit.opflow.state_fns.VectorStateFn.md | 26 +- .../qiskit.primitives.BackendEstimator.md | 4 +- .../0.43/qiskit.primitives.BackendSampler.md | 4 +- .../0.43/qiskit.primitives.BaseEstimator.md | 4 +- .../0.43/qiskit.primitives.BaseSampler.md | 4 +- .../0.43/qiskit.primitives.Estimator.md | 2 +- .../0.43/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.43/qiskit.primitives.Sampler.md | 2 +- .../0.43/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.43/qiskit.providers.Backend.md | 2 +- .../qiskit.providers.BackendPropertyError.md | 2 +- .../qiskit/0.43/qiskit.providers.BackendV1.md | 16 +- .../qiskit/0.43/qiskit.providers.BackendV2.md | 16 +- .../qiskit.providers.BackendV2Converter.md | 12 +- docs/api/qiskit/0.43/qiskit.providers.Job.md | 2 +- .../qiskit/0.43/qiskit.providers.JobError.md | 2 +- .../qiskit/0.43/qiskit.providers.JobStatus.md | 2 +- .../0.43/qiskit.providers.JobTimeoutError.md | 2 +- .../api/qiskit/0.43/qiskit.providers.JobV1.md | 24 +- .../qiskit/0.43/qiskit.providers.Options.md | 6 +- .../qiskit/0.43/qiskit.providers.Provider.md | 2 +- .../0.43/qiskit.providers.ProviderV1.md | 6 +- ...it.providers.QiskitBackendNotFoundError.md | 2 +- .../0.43/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 10 +- ...kit.providers.basicaer.BasicAerProvider.md | 6 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 6 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 6 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 6 +- .../qiskit.providers.fake_provider.Fake1Q.md | 6 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 4 +- ...t.providers.fake_provider.FakeBackendV2.md | 4 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 4 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 6 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 6 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 4 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 4 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 6 +- ....fake_provider.FakeProviderForBackendV2.md | 6 +- ...oviders.fake_provider.FakeQasmSimulator.md | 4 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 4 +- ...iskit.providers.fake_provider.FakeTokyo.md | 4 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 32 +-- .../qiskit.providers.models.BackendStatus.md | 6 +- .../0.43/qiskit.providers.models.Command.md | 6 +- .../qiskit.providers.models.GateConfig.md | 6 +- .../0.43/qiskit.providers.models.JobStatus.md | 6 +- ...viders.models.PulseBackendConfiguration.md | 20 +- .../qiskit.providers.models.PulseDefaults.md | 6 +- ...oviders.models.QasmBackendConfiguration.md | 6 +- .../qiskit.providers.models.UchannelLO.md | 6 +- .../qiskit.pulse.InstructionScheduleMap.md | 22 +- docs/api/qiskit/0.43/qiskit.pulse.Schedule.md | 28 +-- .../qiskit/0.43/qiskit.pulse.ScheduleBlock.md | 30 +-- .../0.43/qiskit.pulse.builder.acquire.md | 2 +- .../qiskit.pulse.builder.acquire_channel.md | 2 +- .../qiskit.pulse.builder.active_backend.md | 2 +- ...ilder.active_circuit_scheduler_settings.md | 2 +- ...ulse.builder.active_transpiler_settings.md | 2 +- .../qiskit.pulse.builder.align_equispaced.md | 2 +- .../0.43/qiskit.pulse.builder.align_func.md | 2 +- .../0.43/qiskit.pulse.builder.align_left.md | 2 +- .../0.43/qiskit.pulse.builder.align_right.md | 2 +- .../qiskit.pulse.builder.align_sequential.md | 2 +- .../0.43/qiskit.pulse.builder.barrier.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.build.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.call.md | 2 +- ...ulse.builder.circuit_scheduler_settings.md | 2 +- .../qiskit.pulse.builder.control_channels.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.cx.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.delay.md | 2 +- .../0.43/qiskit.pulse.builder.delay_qubits.md | 2 +- .../qiskit.pulse.builder.drive_channel.md | 2 +- .../qiskit.pulse.builder.frequency_offset.md | 2 +- .../0.43/qiskit.pulse.builder.measure.md | 2 +- .../0.43/qiskit.pulse.builder.measure_all.md | 2 +- .../qiskit.pulse.builder.measure_channel.md | 2 +- .../0.43/qiskit.pulse.builder.num_qubits.md | 2 +- .../0.43/qiskit.pulse.builder.phase_offset.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.play.md | 2 +- .../qiskit.pulse.builder.qubit_channels.md | 2 +- .../0.43/qiskit.pulse.builder.reference.md | 2 +- ...qiskit.pulse.builder.samples_to_seconds.md | 2 +- ...qiskit.pulse.builder.seconds_to_samples.md | 2 +- .../qiskit.pulse.builder.set_frequency.md | 2 +- .../0.43/qiskit.pulse.builder.set_phase.md | 2 +- .../qiskit.pulse.builder.shift_frequency.md | 2 +- .../0.43/qiskit.pulse.builder.shift_phase.md | 2 +- .../0.43/qiskit.pulse.builder.snapshot.md | 2 +- ...iskit.pulse.builder.transpiler_settings.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.u1.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.u2.md | 2 +- .../qiskit/0.43/qiskit.pulse.builder.u3.md | 2 +- .../api/qiskit/0.43/qiskit.pulse.builder.x.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.43/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.43/qiskit.pulse.instructions.Acquire.md | 4 +- .../0.43/qiskit.pulse.instructions.Call.md | 4 +- .../0.43/qiskit.pulse.instructions.Delay.md | 2 +- .../0.43/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 4 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- ...qiskit.pulse.library.Constant_class.rst.md | 2 +- .../qiskit.pulse.library.Cos_class.rst.md | 2 +- .../qiskit.pulse.library.Drag_class.rst.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- ...qiskit.pulse.library.Gaussian_class.rst.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 8 +- ...qiskit.pulse.library.Sawtooth_class.rst.md | 2 +- .../qiskit.pulse.library.Sin_class.rst.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 8 +- ...qiskit.pulse.library.Triangle_class.rst.md | 2 +- .../0.43/qiskit.pulse.library.Waveform.md | 4 +- .../0.43/qiskit.pulse.library.constant.md | 2 +- .../qiskit/0.43/qiskit.pulse.library.cos.md | 2 +- .../qiskit/0.43/qiskit.pulse.library.drag.md | 2 +- .../0.43/qiskit.pulse.library.gaussian.md | 2 +- .../qiskit.pulse.library.gaussian_deriv.md | 2 +- .../qiskit.pulse.library.gaussian_square.md | 2 +- .../0.43/qiskit.pulse.library.sawtooth.md | 2 +- .../qiskit/0.43/qiskit.pulse.library.sech.md | 2 +- .../0.43/qiskit.pulse.library.sech_deriv.md | 2 +- .../qiskit/0.43/qiskit.pulse.library.sin.md | 2 +- .../0.43/qiskit.pulse.library.square.md | 2 +- .../0.43/qiskit.pulse.library.triangle.md | 2 +- .../qiskit/0.43/qiskit.pulse.library.zero.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 6 +- .../0.43/qiskit.pulse.transforms.AlignFunc.md | 6 +- .../0.43/qiskit.pulse.transforms.AlignLeft.md | 4 +- .../qiskit.pulse.transforms.AlignRight.md | 4 +- ...qiskit.pulse.transforms.AlignSequential.md | 4 +- ....pulse.transforms.add_implicit_acquires.md | 2 +- .../qiskit.pulse.transforms.align_measures.md | 2 +- .../qiskit.pulse.transforms.block_to_dag.md | 2 +- ...skit.pulse.transforms.block_to_schedule.md | 2 +- ...qiskit.pulse.transforms.compress_pulses.md | 2 +- .../0.43/qiskit.pulse.transforms.flatten.md | 2 +- ...kit.pulse.transforms.inline_subroutines.md | 2 +- .../0.43/qiskit.pulse.transforms.pad.md | 2 +- ...skit.pulse.transforms.remove_directives.md | 2 +- ...ulse.transforms.remove_trivial_barriers.md | 2 +- ....pulse.transforms.target_qobj_transform.md | 2 +- docs/api/qiskit/0.43/qiskit.qasm.Qasm.md | 8 +- docs/api/qiskit/0.43/qiskit.qasm.QasmError.md | 2 +- .../0.43/qiskit.qobj.GateCalibration.md | 6 +- .../0.43/qiskit.qobj.PulseLibraryItem.md | 6 +- docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.md | 6 +- .../0.43/qiskit.qobj.PulseQobjConfig.md | 6 +- .../0.43/qiskit.qobj.PulseQobjExperiment.md | 6 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.43/qiskit.qobj.PulseQobjInstruction.md | 6 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 6 +- docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.md | 6 +- .../qiskit/0.43/qiskit.qobj.QasmQobjConfig.md | 6 +- .../0.43/qiskit.qobj.QasmQobjExperiment.md | 6 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 6 +- .../0.43/qiskit.qobj.QasmQobjInstruction.md | 6 +- docs/api/qiskit/0.43/qiskit.qobj.Qobj.md | 2 +- .../0.43/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.43/qiskit.qobj.QobjHeader.md | 2 +- .../0.43/qiskit.qobj.QobjMeasurementOption.md | 6 +- docs/api/qiskit/0.43/qiskit.qpy.dump.md | 2 +- docs/api/qiskit/0.43/qiskit.qpy.load.md | 2 +- .../0.43/qiskit.quantum_info.CNOTDihedral.md | 22 +- .../qiskit/0.43/qiskit.quantum_info.Chi.md | 14 +- .../qiskit/0.43/qiskit.quantum_info.Choi.md | 12 +- .../0.43/qiskit.quantum_info.Clifford.md | 40 ++-- .../0.43/qiskit.quantum_info.DensityMatrix.md | 40 ++-- .../qiskit/0.43/qiskit.quantum_info.Kraus.md | 16 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 8 +- .../0.43/qiskit.quantum_info.Operator.md | 32 +-- .../qiskit/0.43/qiskit.quantum_info.PTM.md | 14 +- .../qiskit/0.43/qiskit.quantum_info.Pauli.md | 38 +-- .../0.43/qiskit.quantum_info.PauliList.md | 54 ++--- .../0.43/qiskit.quantum_info.PauliTable.md | 40 ++-- .../0.43/qiskit.quantum_info.Quaternion.md | 14 +- .../0.43/qiskit.quantum_info.ScalarOp.md | 20 +- .../0.43/qiskit.quantum_info.SparsePauliOp.md | 48 ++-- .../qiskit.quantum_info.StabilizerState.md | 32 +-- .../qiskit.quantum_info.StabilizerTable.md | 32 +-- .../0.43/qiskit.quantum_info.Statevector.md | 40 ++-- .../0.43/qiskit.quantum_info.Stinespring.md | 14 +- .../0.43/qiskit.quantum_info.SuperOp.md | 14 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 14 +- .../0.43/qiskit.quantum_info.XXDecomposer.md | 4 +- .../0.43/qiskit.quantum_info.Z2Symmetries.md | 12 +- .../qiskit.quantum_info.anti_commutator.md | 2 +- ...skit.quantum_info.average_gate_fidelity.md | 2 +- .../0.43/qiskit.quantum_info.commutator.md | 2 +- .../0.43/qiskit.quantum_info.concurrence.md | 2 +- .../qiskit.quantum_info.decompose_clifford.md | 2 +- .../0.43/qiskit.quantum_info.diamond_norm.md | 2 +- .../qiskit.quantum_info.double_commutator.md | 2 +- ....quantum_info.entanglement_of_formation.md | 2 +- .../0.43/qiskit.quantum_info.entropy.md | 2 +- .../0.43/qiskit.quantum_info.gate_error.md | 2 +- .../qiskit.quantum_info.hellinger_distance.md | 2 +- .../qiskit.quantum_info.hellinger_fidelity.md | 2 +- .../qiskit.quantum_info.mutual_information.md | 2 +- .../0.43/qiskit.quantum_info.partial_trace.md | 2 +- .../0.43/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.quantum_info.process_fidelity.md | 2 +- .../qiskit/0.43/qiskit.quantum_info.purity.md | 2 +- .../qiskit.quantum_info.random_clifford.md | 2 +- ...qiskit.quantum_info.random_cnotdihedral.md | 2 +- ...skit.quantum_info.random_density_matrix.md | 2 +- .../qiskit.quantum_info.random_hermitian.md | 2 +- .../0.43/qiskit.quantum_info.random_pauli.md | 2 +- .../qiskit.quantum_info.random_pauli_list.md | 2 +- .../qiskit.quantum_info.random_pauli_table.md | 2 +- ...kit.quantum_info.random_quantum_channel.md | 2 +- ...it.quantum_info.random_stabilizer_table.md | 2 +- .../qiskit.quantum_info.random_statevector.md | 2 +- .../qiskit.quantum_info.random_unitary.md | 2 +- .../qiskit.quantum_info.shannon_entropy.md | 2 +- .../qiskit.quantum_info.state_fidelity.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 6 +- ...iskit.result.CorrelatedReadoutMitigator.md | 12 +- docs/api/qiskit/0.43/qiskit.result.Counts.md | 10 +- .../qiskit.result.LocalReadoutMitigator.md | 12 +- .../0.43/qiskit.result.ProbDistribution.md | 6 +- .../0.43/qiskit.result.QuasiDistribution.md | 8 +- docs/api/qiskit/0.43/qiskit.result.Result.md | 16 +- .../qiskit/0.43/qiskit.result.ResultError.md | 2 +- .../0.43/qiskit.result.marginal_counts.md | 2 +- .../qiskit.result.marginal_distribution.md | 2 +- .../0.43/qiskit.result.marginal_memory.md | 2 +- ...qiskit.result.sampled_expectation_value.md | 2 +- .../0.43/qiskit.scheduler.ScheduleConfig.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 4 +- .../0.43/qiskit.synthesis.LieTrotter.md | 4 +- .../qiskit.synthesis.MatrixExponential.md | 4 +- .../0.43/qiskit.synthesis.ProductFormula.md | 2 +- .../qiskit/0.43/qiskit.synthesis.QDrift.md | 4 +- ...it.synthesis.SolovayKitaevDecomposition.md | 8 +- .../0.43/qiskit.synthesis.SuzukiTrotter.md | 4 +- ...synthesis.generate_basic_approximations.md | 2 +- .../qiskit.synthesis.synth_clifford_ag.md | 2 +- .../qiskit.synthesis.synth_clifford_bm.md | 2 +- ...skit.synthesis.synth_clifford_depth_lnn.md | 2 +- .../qiskit.synthesis.synth_clifford_full.md | 2 +- .../qiskit.synthesis.synth_clifford_greedy.md | 2 +- .../qiskit.synthesis.synth_clifford_layers.md | 2 +- ...kit.synthesis.synth_cnot_count_full_pmh.md | 2 +- ...kit.synthesis.synth_cnot_depth_line_kms.md | 2 +- ...iskit.synthesis.synth_cnotdihedral_full.md | 2 +- ...it.synthesis.synth_cnotdihedral_general.md | 2 +- ...synthesis.synth_cnotdihedral_two_qubits.md | 2 +- ...qiskit.synthesis.synth_cz_depth_line_mr.md | 2 +- .../qiskit.synthesis.synth_permutation_acg.md | 2 +- ...iskit.synthesis.synth_permutation_basic.md | 2 +- ...nthesis.synth_permutation_depth_lnn_kms.md | 2 +- ...it.synthesis.synth_stabilizer_depth_lnn.md | 2 +- ...iskit.synthesis.synth_stabilizer_layers.md | 2 +- .../0.43/qiskit.tools.backend_monitor.md | 2 +- .../0.43/qiskit.tools.backend_overview.md | 2 +- .../qiskit.tools.events.TextProgressBar.md | 6 +- .../qiskit/0.43/qiskit.tools.job_monitor.md | 2 +- .../qiskit/0.43/qiskit.tools.parallel_map.md | 2 +- .../0.43/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.43/qiskit.transpiler.CouplingMap.md | 46 ++-- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.43/qiskit.transpiler.FlowController.md | 10 +- .../qiskit.transpiler.InstructionDurations.md | 10 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.43/qiskit.transpiler.Layout.md | 30 +-- .../0.43/qiskit.transpiler.PassManager.md | 16 +- .../qiskit.transpiler.PassManagerConfig.md | 4 +- .../0.43/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 14 +- .../qiskit/0.43/qiskit.transpiler.Target.md | 42 ++-- .../qiskit.transpiler.TransformationPass.md | 2 +- .../0.43/qiskit.transpiler.TranspileLayout.md | 2 +- ...qiskit.transpiler.TranspilerAccessError.md | 2 +- .../0.43/qiskit.transpiler.TranspilerError.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 4 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 4 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 4 +- .../qiskit.transpiler.passes.AlignMeasures.md | 4 +- .../qiskit.transpiler.passes.ApplyLayout.md | 4 +- .../qiskit.transpiler.passes.BIPMapping.md | 4 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 4 +- .../qiskit.transpiler.passes.BasicSwap.md | 4 +- ...iskit.transpiler.passes.BasisTranslator.md | 4 +- .../qiskit.transpiler.passes.CSPLayout.md | 4 +- ...qiskit.transpiler.passes.CXCancellation.md | 4 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 4 +- .../0.43/qiskit.transpiler.passes.CheckMap.md | 4 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 4 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 4 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 8 +- ...t.transpiler.passes.CommutationAnalysis.md | 4 +- ...anspiler.passes.CommutativeCancellation.md | 4 +- ...r.passes.CommutativeInverseCancellation.md | 4 +- ...transpiler.passes.Commuting2qGateRouter.md | 6 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 4 +- ...transpiler.passes.ConstrainedReschedule.md | 4 +- ...t.transpiler.passes.ContainsInstruction.md | 4 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 4 +- .../0.43/qiskit.transpiler.passes.CountOps.md | 4 +- ...t.transpiler.passes.CountOpsLongestPath.md | 4 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 56 ++--- .../qiskit.transpiler.passes.DAGFixedPoint.md | 4 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 4 +- .../qiskit.transpiler.passes.Decompose.md | 4 +- .../qiskit.transpiler.passes.DenseLayout.md | 4 +- .../0.43/qiskit.transpiler.passes.Depth.md | 4 +- ...t.transpiler.passes.DynamicalDecoupling.md | 4 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 4 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 4 +- .../qiskit.transpiler.passes.FixedPoint.md | 4 +- ...transpiler.passes.FullAncillaAllocation.md | 6 +- .../qiskit.transpiler.passes.GateDirection.md | 4 +- .../qiskit.transpiler.passes.GatesInBasis.md | 4 +- ...it.transpiler.passes.HighLevelSynthesis.md | 4 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 4 +- ...nspiler.passes.InstructionDurationCheck.md | 4 +- ...t.transpiler.passes.InverseCancellation.md | 4 +- ...skit.transpiler.passes.Layout2qDistance.md | 4 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 4 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 4 +- ...transpiler.passes.MergeAdjacentBarriers.md | 4 +- .../qiskit.transpiler.passes.MinimumPoint.md | 4 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 4 +- ...skit.transpiler.passes.NumTensorFactors.md | 4 +- ...iskit.transpiler.passes.Optimize1qGates.md | 8 +- ...ler.passes.Optimize1qGatesDecomposition.md | 4 +- ...passes.Optimize1qGatesSimpleCommutation.md | 4 +- ...kit.transpiler.passes.OptimizeCliffords.md | 4 +- .../0.43/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 6 +- ...transpiler.passes.RZXCalibrationBuilder.md | 8 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 4 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 4 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 4 +- ...anspiler.passes.RemoveFinalMeasurements.md | 4 +- ...ranspiler.passes.RemoveResetInZeroState.md | 4 +- ....passes.ResetAfterMeasureSimplification.md | 4 +- .../qiskit.transpiler.passes.SabreLayout.md | 4 +- .../qiskit.transpiler.passes.SabreSwap.md | 4 +- .../qiskit.transpiler.passes.SetIOLatency.md | 4 +- .../qiskit.transpiler.passes.SetLayout.md | 4 +- .../0.43/qiskit.transpiler.passes.Size.md | 4 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 4 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 4 +- ...qiskit.transpiler.passes.StochasticSwap.md | 4 +- ....transpiler.passes.TemplateOptimization.md | 4 +- ...it.transpiler.passes.TimeUnitConversion.md | 4 +- ...iler.passes.TranslateParameterizedGates.md | 4 +- .../qiskit.transpiler.passes.TrivialLayout.md | 4 +- ...skit.transpiler.passes.UnitarySynthesis.md | 4 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 4 +- ...anspiler.passes.UnrollCustomDefinitions.md | 4 +- ...qiskit.transpiler.passes.UnrollForLoops.md | 4 +- .../0.43/qiskit.transpiler.passes.Unroller.md | 4 +- .../qiskit.transpiler.passes.VF2Layout.md | 4 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 4 +- ...it.transpiler.passes.ValidatePulseGates.md | 4 +- .../0.43/qiskit.transpiler.passes.Width.md | 4 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 4 +- ....plugin.HighLevelSynthesisPluginManager.md | 6 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 4 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...mon.generate_control_flow_options_check.md | 2 +- ...agers.common.generate_embed_passmanager.md | 2 +- ...s.common.generate_error_on_control_flow.md | 2 +- ...gers.common.generate_pre_op_passmanager.md | 2 +- ...ers.common.generate_routing_passmanager.md | 2 +- ...passmanagers.common.generate_scheduling.md | 2 +- ...common.generate_translation_passmanager.md | 2 +- ..._passmanagers.common.generate_unroll_3q.md | 2 +- ...ssmanagers.generate_preset_pass_manager.md | 2 +- ...reset_passmanagers.level_0_pass_manager.md | 2 +- ...reset_passmanagers.level_1_pass_manager.md | 2 +- ...reset_passmanagers.level_2_pass_manager.md | 2 +- ...reset_passmanagers.level_3_pass_manager.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 4 +- ...rs.plugin.PassManagerStagePluginManager.md | 4 +- ..._passmanagers.plugin.list_stage_plugins.md | 2 +- ...nagers.plugin.passmanager_stage_plugins.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 4 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 4 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 4 +- ...er.synthesis.aqc.ApproximatingObjective.md | 6 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 4 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 6 +- ...ler.synthesis.aqc.FastCNOTUnitObjective.md | 6 +- .../0.43/qiskit.utils.QuantumInstance.md | 16 +- ...skit.utils.add_deprecation_to_docstring.md | 2 +- .../qiskit/0.43/qiskit.utils.apply_prefix.md | 2 +- .../qiskit/0.43/qiskit.utils.deprecate_arg.md | 2 +- .../0.43/qiskit.utils.deprecate_arguments.md | 2 +- .../0.43/qiskit.utils.deprecate_func.md | 2 +- .../0.43/qiskit.utils.deprecate_function.md | 2 +- .../qiskit/0.43/qiskit.utils.detach_prefix.md | 2 +- .../0.43/qiskit.utils.get_entangler_map.md | 2 +- docs/api/qiskit/0.43/qiskit.utils.has_aer.md | 2 +- docs/api/qiskit/0.43/qiskit.utils.has_ibmq.md | 2 +- .../0.43/qiskit.utils.is_main_process.md | 2 +- .../0.43/qiskit.utils.local_hardware_info.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 8 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 8 +- .../api/qiskit/0.43/qiskit.utils.name_args.md | 2 +- .../0.43/qiskit.utils.summarize_circuits.md | 2 +- .../qiskit.utils.validate_entangler_map.md | 2 +- .../qiskit/0.43/qiskit.utils.wrap_method.md | 2 +- ...qiskit.visualization.VisualizationError.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.43/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.43/synthesis_aqc.md | 2 +- docs/api/qiskit/0.43/utils.md | 6 +- 990 files changed, 2622 insertions(+), 2622 deletions(-) diff --git a/docs/api/qiskit/0.43/execute.md b/docs/api/qiskit/0.43/execute.md index 799c8fdf315..7e270f2b221 100644 --- a/docs/api/qiskit/0.43/execute.md +++ b/docs/api/qiskit/0.43/execute.md @@ -22,7 +22,7 @@ python_api_name: qiskit.execute_function -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/execute_function.py "view source code") +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.43/pulse.md b/docs/api/qiskit/0.43/pulse.md index 2214063d715..3cfeb6884f0 100644 --- a/docs/api/qiskit/0.43/pulse.md +++ b/docs/api/qiskit/0.43/pulse.md @@ -73,7 +73,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/instruction.py "view source code") +`Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -182,7 +182,7 @@ All channels are children of the same abstract base class: -`Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`Channel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -237,7 +237,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -686,7 +686,7 @@ There are 1e-06 seconds in 4500 samples. -`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/exceptions.py "view source code") +`PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.43/qasm.md b/docs/api/qiskit/0.43/qasm.md index 1d4d6241f9c..a84100c0274 100644 --- a/docs/api/qiskit/0.43/qasm.md +++ b/docs/api/qiskit/0.43/qasm.md @@ -29,19 +29,19 @@ python_api_name: qiskit.qasm -`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code") +`OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. -`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code") +`QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). -`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code") +`QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.43/qasm2.md b/docs/api/qiskit/0.43/qasm2.md index bfef9a9b1d5..8c246c3a51c 100644 --- a/docs/api/qiskit/0.43/qasm2.md +++ b/docs/api/qiskit/0.43/qasm2.md @@ -32,7 +32,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/__init__.py "view source code") +`load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -57,7 +57,7 @@ A circuit object representing the same OpenQASM 2 program. -`loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/__init__.py "view source code") +`loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -87,7 +87,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/parse.py "view source code") +`CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/parse.py "view source code") Information about a custom instruction that should be defined during the parse. @@ -123,7 +123,7 @@ This module defines a generic error type that derives from `QiskitError` that ca -`QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/exceptions.py "view source code") +`QASM2Error(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/exceptions.py "view source code") A general error raised by the OpenQASM 2 interoperation layer. @@ -135,7 +135,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/exceptions.py "view source code") +`QASM2ParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to parse an OpenQASM 2 file. diff --git a/docs/api/qiskit/0.43/qasm3.md b/docs/api/qiskit/0.43/qasm3.md index 02c7594ad38..fb5205e99b8 100644 --- a/docs/api/qiskit/0.43/qasm3.md +++ b/docs/api/qiskit/0.43/qasm3.md @@ -28,7 +28,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") +`dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. @@ -42,7 +42,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") +`dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. @@ -63,7 +63,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=False, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exporter.py "view source code") +`Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=False, indent='  ', experimental=ExperimentalFeatures.None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -98,7 +98,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exceptions.py "view source code") +`QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -110,7 +110,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/experimental.py "view source code") +`ExperimentalFeatures(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/experimental.py "view source code") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -171,7 +171,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") +`load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -195,7 +195,7 @@ a circuit representation of the OpenQASM 3 program. -`loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") +`loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -221,7 +221,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exceptions.py "view source code") +`QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.md index 416d1b8777c..ab10ff884e4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/exceptions.py "view source code") +`AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.md index 44f82148bfd..e5c1f986a32 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/algorithm_job.py "view source code") +`AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/algorithm_job.py "view source code") Bases: `PrimitiveJob` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.md index 8ec3d31ac80..554da93e037 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.md index ea595cd5be9..ff23b3d4966 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`abstract AmplitudeAmplifier.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.md index c9327a80996..965c37f4d53 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -64,7 +64,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -93,7 +93,7 @@ tuple\[float, float] -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -116,7 +116,7 @@ float -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -139,7 +139,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -167,7 +167,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.md index 772489be99d..b20b7bf226e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.md index 928cb582b45..5e241b6f092 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`abstract AmplitudeEstimator.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.md index 1b5a9f80cc5..c240fd0e0c4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.md index 873ee4a7359..13bd007e99b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `ABC` @@ -32,7 +32,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -55,7 +55,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.md index 4c9ca4b0acd..8b1c2662358 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.md index 791b5126cd2..85aac8540f7 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`EstimationProblem.rescale(scaling_factor)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.md index 3f4c200ac60..78158d96d51 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`EvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.md index 7f650d9551d..428fee96f9a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.md index 24c01ad6a05..5e2b9d75bfa 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -58,7 +58,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -84,7 +84,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.md index c6ae3a4b071..971ea8104fa 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.43/qiskit.algorithms.Grover.md index e679daa2645..febc02b6cc9 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -100,7 +100,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.amplify(amplification_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -129,7 +129,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`Grover.construct_circuit(problem, power=None, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -157,7 +157,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`static Grover.optimal_num_iterations(num_solutions, num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.md index c3a20a52059..0d3997ff056 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.md index 4cc7e31e947..d2ccf7dcc1b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -64,7 +64,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 9271ecfd12b..f380f849995 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :param re -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.md index 5b62e17aafe..fbf7e89a232 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `ABC` @@ -30,7 +30,7 @@ The ImaginaryEvolver interface has been superseded by the `qiskit.algorithms.tim -`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`abstract ImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.md index e5731120ab3..e50ad8516c4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`abstract ImaginaryTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.md index 4907f504732..1ce0986029d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -60,7 +60,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -86,7 +86,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index ad53dde98e1..a7a5c97c05a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.md index 0b3128dd5cd..cc03dc60c25 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `PhaseEstimator` @@ -45,7 +45,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -73,7 +73,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`IterativePhaseEstimation.estimate(unitary, state_preparation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 86408baca3c..e5144a33dcb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -51,7 +51,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -83,7 +83,7 @@ tuple\[float, float] -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -110,7 +110,7 @@ float | tuple\[float, list\[float]] -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -133,7 +133,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 1db98d92c0a..8899cc9a6fd 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.md index ecaaff4af5c..57d47df008b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `ABC` @@ -32,7 +32,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -55,7 +55,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.md index a621c85fbb4..c01acfec70f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.md index ad6d3a5ac59..6d242fd6834 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -41,7 +41,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -64,7 +64,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.md index cc9125316bf..d0e12628a91 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -34,7 +34,7 @@ The NumPyMinimumEigensolver class has been superseded by the [`qiskit.algorithms -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -57,7 +57,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.md index c17aacd566f..de4af71a9c4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -160,7 +160,7 @@ quantum algorithm for the time evolution of parameterized circuits, [Quantum 5, -`PVQD.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. @@ -189,7 +189,7 @@ A result object containing the evolution information and evaluated observables. -`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Get a function to evaluate the infidelity between Trotter step and ansatz. @@ -216,7 +216,7 @@ tuple\[Callable\[\[np.ndarray], float], Callable\[\[np.ndarray], np.ndarray]] | -`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform a single time step. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.md index 26acbe8b0cc..de92f2eb624 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.md index 94cf8eb7d51..6ca0c78eaf7 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `PhaseEstimator` @@ -72,7 +72,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -88,7 +88,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate(unitary, state_preparation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -111,7 +111,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.md index 34cd73b055f..264d877516a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :param re -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.md index c1942621d59..42eedadb040 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -62,7 +62,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -87,7 +87,7 @@ float -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.md index ee0fb0b5ad5..0f6094e7726 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.md index 5c487563077..1b9a091ffcb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `ABC` @@ -30,7 +30,7 @@ The RealEvolver interface has been superseded by the `qiskit.algorithms.time_evo -`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`abstract RealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.md index 0dc81a1e008..ecd78141a1d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`abstract RealTimeEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.md index f5fe0e95fcd..05d5f9ba1e2 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") @@ -34,7 +34,7 @@ Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau = it$ under -`SciPyImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`SciPyImaginaryEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.md index 5dc76aab362..4844ccb793a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -34,7 +34,7 @@ Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, -`SciPyRealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`SciPyRealEvolver.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.md index a3175e8fec7..c3e81540e37 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: `object` @@ -100,7 +100,7 @@ dict\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), complex] -`TimeEvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`TimeEvolutionProblem.validate_params()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.md index 901e20a5279..696fab96208 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.md index 6844af47f27..25a89faa175 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -57,7 +57,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -88,7 +88,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.43/qiskit.algorithms.VQD.md index c8930b5479d..a0a5d7c59b8 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -54,7 +54,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -77,7 +77,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -100,7 +100,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -129,7 +129,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -161,7 +161,7 @@ Callable\[\[np.ndarray], float | list\[float]] | tuple\[Callable\[\[np.ndarray], -`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQD.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -179,7 +179,7 @@ str -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.md index dcc559ab6d9..1239f4c102f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.43/qiskit.algorithms.VQE.md index 769a2c9c813..dae709f1a75 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -82,7 +82,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -105,7 +105,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_circuit(parameter, operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -128,7 +128,7 @@ list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.construct_expectation(parameter, operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -157,7 +157,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.get_energy_evaluation(operator, return_expectation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -186,7 +186,7 @@ Callable\[\[np.ndarray], float | list\[float]] | tuple\[Callable\[\[np.ndarray], -`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`VQE.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -204,7 +204,7 @@ str -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.md index e1c2a5b2510..cba6dd11f02 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.md index fd1e49e9ec8..a985ae1cafd 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.md index 8f662085795..8115013b5f3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `ABC` @@ -26,7 +26,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -49,7 +49,7 @@ An eigensolver result. -`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`classmethod Eigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.md index 4d1b2a8a1be..58cec04dd3f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index 4489d7921ea..59a0dc24caf 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -35,7 +35,7 @@ The NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valu -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -58,7 +58,7 @@ An eigensolver result. -`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`classmethod NumPyEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index daee23ed646..3fb80899e6d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.md index 409f141ea9b..3fdabfc3611 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -130,7 +130,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQD.compute_eigenvalues(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -153,7 +153,7 @@ An eigensolver result. -`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`classmethod VQD.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.md index 8cff1bc440f..83ef732e6b4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.estimate_observables.md b/docs/api/qiskit/0.43/qiskit.algorithms.estimate_observables.md index dcf53f2386a..60fdf03b732 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.estimate_observables.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.estimate_observables.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.estimate_observables -`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/observables_evaluator.py "view source code") +`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.43/qiskit.algorithms.eval_observables.md index 41459feac67..01626ad1555 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.eval_observables.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.eval_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/aux_ops_evaluator.py "view source code") Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.md index b2734a8a9c9..fccbe54f899 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Bases: `ABC` @@ -40,7 +40,7 @@ Base class for an `EstimatorGradient` to compute the gradients of the expectatio -`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Run the job of the estimator gradient on the given circuits. @@ -70,7 +70,7 @@ The job object of the gradients of the expectation values. The i-th result corre -`BaseEstimatorGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") +`BaseEstimatorGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.md index e616e760e65..fe2207c3c59 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_qgt.py "view source code") Bases: `ABC` @@ -62,7 +62,7 @@ $$ -`BaseQGT.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_qgt.py "view source code") Run the job of the QGTs on the given circuits. @@ -91,7 +91,7 @@ The job object of the QGTs of the expectation values. The i-th result correspond -`BaseQGT.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_qgt.py "view source code") +`BaseQGT.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_qgt.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.md index 6f5f9be940c..a00255ee6c5 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Bases: `ABC` @@ -29,7 +29,7 @@ Base class for a `SamplerGradient` to compute the gradients of the sampling prob -`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Run the job of the sampler gradient on the given circuits. @@ -58,7 +58,7 @@ The job object of the gradients of the sampling probability. The i-th result cor -`BaseSamplerGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") +`BaseSamplerGradient.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.md index bd3e08f2269..077926889a0 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.DerivativeType.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.DerivativeType -`DerivativeType(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/utils.py "view source code") +`DerivativeType(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/utils.py "view source code") Bases: `Enum` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.md index 2c4aed03649..5c2bad01120 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") +`EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 03dc6a3a03c..a5e06b5628d 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") +`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index f450023296c..895002390cb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") +`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index bcdd11c01d3..d09d9e46292 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") +`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.md index 23055e77da0..c0ef6f5eb93 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") +`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.md index ee4b77687ab..c900eeffd16 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") +`LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index b6a21d274c0..86afe3f4c81 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") +`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 8b58a86f605..1409853c128 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") +`ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.md index 4bf0978ffd3..93e03a27608 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi.py "view source code") Bases: `ABC` @@ -34,7 +34,7 @@ $$ -`QFI.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.run(circuits, parameter_values, parameters=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi.py "view source code") Run the job of the QFIs on the given circuits. @@ -59,7 +59,7 @@ The job object of the QFIs of the expectation values. The i-th result correspond -`QFI.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi.py "view source code") +`QFI.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.md index 193eaa08ca6..a101d95f36e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi_result.py "view source code") +`QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.md index a5639392ada..92046c9a32b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qgt_result.py "view source code") +`QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/qgt_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index f536887b7b3..75685c5d4b4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") +`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.md index 85c010a802e..3e605ce44df 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") +`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index cb02a3f17cf..ec56b10463f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") +`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.md index 748f48ea11a..73dddd69223 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") +`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.md index 21de67e5c3f..42c5b38a68e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") +`SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index b63ed3810fd..39efb415a27 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -83,7 +83,7 @@ the maximum number of iterations for the adaptive loop. If `None`, the algorithm -`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Computes the minimum eigenvalue. @@ -111,7 +111,7 @@ An [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qis -`classmethod AdaptVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`classmethod AdaptVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 4b15506953c..4df2373011e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index fa4345f645b..09213d4aa10 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `ABC` @@ -26,7 +26,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -49,7 +49,7 @@ A minimum eigensolver result. -`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`classmethod MinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 69f9626af02..0a90b763106 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 4d523395b15..0c3315fa107 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -28,7 +28,7 @@ The NumPy minimum eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -51,7 +51,7 @@ A minimum eigensolver result. -`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`classmethod NumPyMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 9702ae1f97e..461750a2c26 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.md index 3fd273bdd22..938a364a31a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 5f3dc687751..e54f59a852e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ The Sampling Minimum Eigensolver Interface. -`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -47,7 +47,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`classmethod SamplingMinimumEigensolver.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 52fb12969ba..e37705c1d83 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 368418b757c..cf3151caed3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") @@ -125,7 +125,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -148,7 +148,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`classmethod SamplingVQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index ca7e2c26857..e5cbf02a6cb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.md index f9be7800f2a..07c78c0ee0a 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -131,7 +131,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -154,7 +154,7 @@ A minimum eigensolver result. -`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`classmethod VQE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 6b19a5ea000..49935fbbede 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.md index daecc0d4f47..1dca43ce2ba 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -54,7 +54,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -89,7 +89,7 @@ grad -`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.load_params(load_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -103,7 +103,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -153,7 +153,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`ADAM.save_params(snapshot_dir)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.md index 3124405145b..a0bb80841a9 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -46,7 +46,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -91,7 +91,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/aqgd.py "view source code") +`AQGD.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.md index 2a724ec9f72..44ee33af3aa 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.md index f257b155691..ed628e006ab 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -36,7 +36,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -71,7 +71,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.md index 3711ec20117..75d7217e676 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/cg.py "view source code") +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.md index 57177883bbb..89f34dbc00e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/cobyla.py "view source code") +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.md index 7c4e3b19ecf..cd9d5eef265 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`CRS.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.md index 4b3a579e228..79c6d0668bf 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `NLoptOptimizer` @@ -38,7 +38,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`DIRECT_L.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index c471b9ac1a2..76be018c7b5 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `NLoptOptimizer` @@ -38,7 +38,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`DIRECT_L_RAND.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.md index baf17f40064..2b21adacb83 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `NLoptOptimizer` @@ -38,7 +38,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`ESCH.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.md index 0efe8dff924..2635eb9197e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -62,7 +62,7 @@ dict\[str, int] -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -114,7 +114,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -144,7 +144,7 @@ tuple\[np.ndarray, float, int, float] -`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -179,7 +179,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_points(n, x, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -205,7 +205,7 @@ tuple\[np.ndarray, np.ndarray] -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.md index 5b52e2b1ae3..6e020aa9fd4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") @@ -143,7 +143,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`GradientDescent.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Returns an object with the data needed to evaluate the gradient. @@ -159,7 +159,7 @@ If this object contains a gradient function the gradient can be evaluated direct -`GradientDescent.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Condition that indicates the optimization process should come to an end. @@ -179,7 +179,7 @@ bool -`GradientDescent.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Creates a result of the optimization process. @@ -199,7 +199,7 @@ The result of the optimization process. -`GradientDescent.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Evaluates the gradient. @@ -223,7 +223,7 @@ The data containing the gradient evaluation. -`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -321,7 +321,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`GradientDescent.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -350,7 +350,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.GradientDescent#ask -`GradientDescent.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescent.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Updates `x` by an ammount proportional to the learning rate and value of the gradient at that point. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.md index e894dff6696..db85dfaae4c 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.md index 334b12af787..a64e352e943 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -36,7 +36,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -71,7 +71,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/imfil.py "view source code") +`IMFIL.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.md index 4b540a4fa85..fa9a15747d3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`ISRES.get_nlopt_optimizer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.md index 4f833a9b2f6..e3040c64e68 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.md index a710676a51f..f728bdf8cf8 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.md index f0b30150a59..e05a5f8193c 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.md index c75fd0d406b..078dbd3d6a4 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nft.py "view source code") +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.md index 37bc6a7db3a..7f6d3c0f6cc 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `ABC` @@ -26,7 +26,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -36,7 +36,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -61,7 +61,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -86,7 +86,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.print_options()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -96,7 +96,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_max_evals_grouped(limit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -106,7 +106,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`Optimizer.set_options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -122,7 +122,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`static Optimizer.wrap_function(function, args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.md index d93f835b6c0..a91daf50c42 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.md index a03a6561af7..310a2d156ac 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 3273c03711b..815e6cd61f3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") +`OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `IntEnum` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.md index 19451c6fffe..3255c31d492 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/powell.py "view source code") +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.md index c3bc6dc6668..0ab5772343e 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.P_BFGS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -75,7 +75,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.md index f197c7bc7e9..a7cd1ae00bc 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -160,7 +160,7 @@ float -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.md index f0ed325e1d1..88dadb1e926 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/slsqp.py "view source code") +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.md index 7b6a23663de..2db0734b1d1 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -40,7 +40,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -75,7 +75,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/snobfit.py "view source code") +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.md index b924447a794..f2a0c670f49 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -136,7 +136,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -174,7 +174,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -188,7 +188,7 @@ float -`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -223,7 +223,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -248,7 +248,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.md index b185ec33bce..b95f2351a65 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -33,7 +33,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -68,7 +68,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.md index c9b67f895a4..381d4ff3476 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -79,7 +79,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`SteppableOptimizer.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.ask()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Ask the optimizer for a set of points to evaluate. @@ -99,7 +99,7 @@ An object containing the data needed to make the funciton evaluation to advance -`SteppableOptimizer.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.continue_condition()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Condition that indicates the optimization process should continue. @@ -117,7 +117,7 @@ bool -`abstract SteppableOptimizer.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.create_result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Returns the result of the optimization. @@ -137,7 +137,7 @@ The result of the optimization process. -`abstract SteppableOptimizer.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.evaluate(ask_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Evaluates the function according to the instructions contained in `ask_data`. @@ -196,7 +196,7 @@ grad -`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Minimizes the function. @@ -259,7 +259,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -276,7 +276,7 @@ Populates the state of the optimizer with the data provided and sets all the cou -`SteppableOptimizer.step()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.step()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Performs one step in the optimization process. @@ -288,7 +288,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#a -`SteppableOptimizer.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`SteppableOptimizer.tell(ask_data, tell_data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Updates the optimization state using the results of the function evaluation. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.md index a0263a4b501..f5a55ad1ff3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/tnc.py "view source code") +`TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.md index f617a75b957..b5dbb6186b3 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.md index 6c1a416096b..162c27d9c1b 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA(maxiter=100, size_gen=20, alpha=0.5)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -91,7 +91,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.get_support_level()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -126,7 +126,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/umda.py "view source code") +`UMDA.minimize(fun, x0, jac=None, bounds=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 582ad0d2954..4f83e8be8ba 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: `Generator` @@ -38,7 +38,7 @@ Raise GeneratorExit inside generator. -`LearningRate.send(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.send(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Send a value into the generator. Return next yielded value or raise StopIteration. @@ -48,7 +48,7 @@ Send a value into the generator. Return next yielded value or raise StopIteratio -`LearningRate.throw(typ, val=None, tb=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`LearningRate.throw(typ, val=None, tb=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Raise an exception in the generator. Return next yielded value or raise StopIteration. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index 73483cd238a..075e69c0127 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: `ABC` @@ -30,7 +30,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. @@ -53,7 +53,7 @@ The fidelity quantum circuit corresponding to `circuit_1` and `circuit_2`. -`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.md index 90e5d4246e0..6719e1193fb 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`ComputeUncompute(sampler, options=None, local=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute(sampler, options=None, local=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") @@ -52,7 +52,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Combines `circuit_1` and `circuit_2` to create the fidelity circuit following the compute-uncompute method. @@ -101,7 +101,7 @@ Primitive job for the fidelity calculation. The job’s result is an instance of -`ComputeUncompute.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`ComputeUncompute.update_default_options(**options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Update the fidelity’s default options setting. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.md index cb10201c801..2d1ffe6598c 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index a8e14cdf6b0..a4efa3493a7 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -50,7 +50,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`TrotterQRTE.evolve(evolution_problem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on the `init_state` and on the evolved state at every step (`num_timesteps` times) using an estimator primitive provided. @@ -79,7 +79,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`classmethod TrotterQRTE.supports_aux_operators()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index 6009036330b..cc577a00c9c 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `OdeSolver` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index 71b521447c8..8d5a3b76fb9 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") @@ -33,7 +33,7 @@ Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize -`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index cd56aeffc1b..47703635592 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index 4167b117579..c9f92a3b295 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") @@ -33,7 +33,7 @@ Class for a Real McLachlan’s Variational Principle. It aims to minimize the di -`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index cdf30bfad8c..6ff90bb0fa0 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index bb10a85c59e..e1747f35475 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.43/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: `ABC` @@ -49,7 +49,7 @@ Instance of a class used to compute the state gradient. -`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. @@ -74,7 +74,7 @@ np.ndarray -`VariationalPrinciple.metric_tensor(ansatz, param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`VariationalPrinciple.metric_tensor(ansatz, param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates a metric tensor according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.md index 283e3235af9..7feaaa27415 100644 --- a/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.43/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/run_config.py "view source code") +`RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/run_config.py "view source code") Bases: `SimpleNamespace` @@ -74,7 +74,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/run_config.py "view source code") +`classmethod RunConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -96,7 +96,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/run_config.py "view source code") +`RunConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.43/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.43/qiskit.assembler.assemble_circuits.md index 354b2722ba3..46c06dee5ac 100644 --- a/docs/api/qiskit/0.43/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.43/qiskit.assembler.assemble_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.assemble_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/assemble_circuits.py "view source code") +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.43/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.43/qiskit.assembler.assemble_schedules.md index c94ffdf291a..72e44d8b7d6 100644 --- a/docs/api/qiskit/0.43/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.43/qiskit.assembler.assemble_schedules.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.assemble_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/assemble_schedules.py "view source code") +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.43/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.43/qiskit.assembler.disassemble.md index cb9d033ecc4..a310d9e14e6 100644 --- a/docs/api/qiskit/0.43/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.43/qiskit.assembler.disassemble.md @@ -12,7 +12,7 @@ python_api_name: qiskit.assembler.disassemble -`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/disassemble.py "view source code") +`disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.md index f6e60d359f7..d0ff3f6f144 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") +`AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.md index eb48a42f3fb..c7d754a2e4c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") +`AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Bit.md b/docs/api/qiskit/0.43/qiskit.circuit.Bit.md index 5b8f5c8f141..9aaa5459fc5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/bit.py "view source code") +`Bit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/bit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.md index 090b479d275..37fd28b3e8b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/break_loop.py "view source code") +`BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.md index bcc55833707..5074b475ae8 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -50,7 +50,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuitdata.py "view source code") +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.md index 0587506f34d..af0561aceae 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") @@ -52,7 +52,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalregister.py "view source code") +`ClassicalRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.43/qiskit.circuit.Clbit.md index b2754b4bd34..4548bc2fb02 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalregister.py "view source code") +`Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.md index 28973e458d4..c45b3a95fda 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/continue_loop.py "view source code") +`ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.md index d5c45cb73ff..a3c4f562225 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/control_flow.py "view source code") +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `ABC` @@ -194,7 +194,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/control_flow.py "view source code") +`abstract ControlFlowOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.md index 6d71ae0c9e1..0fb7778e461 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlledgate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -218,7 +218,7 @@ a copy of the current instruction, with the name updated if it was provided -`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlledgate.py "view source code") +`ControlledGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Delay.md b/docs/api/qiskit/0.43/qiskit.circuit.Delay.md index fa5a5dec83b..fff844047d6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") +`Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -46,7 +46,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") +`Delay.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -69,7 +69,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") +`Delay.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -105,7 +105,7 @@ a copy of the current instruction, with the name updated if it was provided -`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") +`Delay.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -207,7 +207,7 @@ bool -`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") +`Delay.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -225,7 +225,7 @@ np.ndarray -`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") +`Delay.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.md index 3ee3dae530b..23e6f372cab 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -47,7 +47,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.draw(filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -75,7 +75,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.get_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -103,7 +103,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.has_entry(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -127,7 +127,7 @@ Bool -`EquivalenceLibrary.keys()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.keys()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Return list of keys to key to node index map. @@ -145,7 +145,7 @@ List -`EquivalenceLibrary.node_index(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.node_index(key)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Return node index for a given key. @@ -167,7 +167,7 @@ Int -`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") +`EquivalenceLibrary.set_entry(gate, entry)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.md index 752d49c98d1..f8f3ce9ba5f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -215,7 +215,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/for_loop.py "view source code") +`ForLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Gate.md b/docs/api/qiskit/0.43/qiskit.circuit.Gate.md index 9156faf252c..355edd77f4d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") +`Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") +`Gate.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -124,7 +124,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -210,7 +210,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") +`Gate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -318,7 +318,7 @@ bool -`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") +`Gate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -340,7 +340,7 @@ np.ndarray -`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") +`Gate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.md index e53ef2b1a14..80ce35fef02 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -109,7 +109,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -219,7 +219,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py "view source code") +`IfElseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.43/qiskit.circuit.Instruction.md index 6ff9845131b..859873b048d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -41,7 +41,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.add_decomposition(decomposition)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -51,7 +51,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -61,7 +61,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -84,7 +84,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -98,7 +98,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -120,7 +120,7 @@ a copy of the current instruction, with the name updated if it was provided -`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -146,7 +146,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -156,7 +156,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -168,7 +168,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.repeat(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -194,7 +194,7 @@ Containing the definition. -`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -216,7 +216,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.soft_compare(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -238,7 +238,7 @@ bool -`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") +`Instruction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.md index 86cdf2f27d6..ddbda2598db 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") +`InstructionSet(circuit_cregs=None, *, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (`qargs` and `cargs` that each instruction is attached to) is also s -`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.add(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -58,7 +58,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -111,7 +111,7 @@ qc.draw('mpl') -`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") +`InstructionSet.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Operation.md b/docs/api/qiskit/0.43/qiskit.circuit.Operation.md index 806f0585725..9557adf2d5e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/operation.py "view source code") +`Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/operation.py "view source code") Bases: `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.43/qiskit.circuit.Parameter.md index caab023fddc..02a5f753897 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`Parameter(name, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameter.py "view source code") +`Parameter(name, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameter.py "view source code") Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -229,7 +229,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameter.py "view source code") +`Parameter.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.md index 49bbc5603ef..bbdd375c889 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arccos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -43,7 +43,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arcsin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -53,7 +53,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.arctan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -63,7 +63,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.assign(parameter, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -86,7 +86,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -119,7 +119,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -133,7 +133,7 @@ Return the conjugate. -`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.cos()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -143,7 +143,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.exp()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -153,7 +153,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.gradient(param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -175,7 +175,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.is_real()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -185,7 +185,7 @@ Return whether the expression is real -`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.log()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -195,7 +195,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sin()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -205,7 +205,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -234,7 +234,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.sympify()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -250,7 +250,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") +`ParameterExpression.tan()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.md index 30bd7f1c4f3..de5f56bb193 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parametervector.py "view source code") +`ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.index(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -34,7 +34,7 @@ Returns first index of value. -`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parametervector.py "view source code") +`ParameterVector.resize(length)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.md index a699641234e..04460489d6b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -109,7 +109,7 @@ qc.draw('mpl') -`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -119,7 +119,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -140,7 +140,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.add_register(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -150,7 +150,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.append(instruction, qargs=None, cargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -182,7 +182,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[False] = False) → QuantumCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[False] = False) → QuantumCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[True] = False) → None` @@ -254,7 +254,7 @@ circuit.draw('mpl') -`QuantumCircuit.barrier(*qargs, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.barrier(*qargs, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Barrier`](qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier"). If `qargs` is empty, applies to all qubits in the circuit. @@ -277,7 +277,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.bind_parameters(values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -308,7 +308,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.break_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp"). @@ -334,7 +334,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.cast(value, type_)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -348,7 +348,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cbit_argument_conversion(clbit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -370,7 +370,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -397,7 +397,7 @@ A handle to the instructions created. -`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). @@ -425,7 +425,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -452,7 +452,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.clear()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -464,7 +464,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_instances()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -478,7 +478,7 @@ int -`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`classmethod QuantumCircuit.cls_prefix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -492,7 +492,7 @@ str -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -523,7 +523,7 @@ A handle to the instructions created. -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -581,7 +581,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.continue_loop()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp"). @@ -607,7 +607,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -635,7 +635,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -657,7 +657,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.copy_empty_like(name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -685,7 +685,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.count_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -703,7 +703,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -731,7 +731,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -759,7 +759,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -787,7 +787,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -815,7 +815,7 @@ A handle to the instructions created. -`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). @@ -842,7 +842,7 @@ A handle to the instructions created. -`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). @@ -869,7 +869,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -897,7 +897,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -924,7 +924,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -955,7 +955,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -982,7 +982,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -1009,7 +1009,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -1036,7 +1036,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.dcx(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1061,7 +1061,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1084,7 +1084,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.delay(duration, qarg=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is `None`, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1112,7 +1112,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.depth(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1167,7 +1167,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1243,7 +1243,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ecr(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1268,7 +1268,7 @@ A handle to the instructions created. -`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.find_bit(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit"). @@ -1305,7 +1305,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.for_loop.ForLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet` @@ -1362,7 +1362,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1392,7 +1392,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Construct a circuit from an iterable of CircuitInstructions. @@ -1419,7 +1419,7 @@ The quantum circuit. -`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_file(path)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1441,7 +1441,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`static QuantumCircuit.from_qasm_str(qasm_str)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1463,7 +1463,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.get_instructions(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1485,7 +1485,7 @@ list(tuple) -`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.h(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1540,7 +1540,7 @@ The quantum circuit. -`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_calibration_for(instr_context)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1550,7 +1550,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.has_register(register)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1572,7 +1572,7 @@ bool -`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.i(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1596,7 +1596,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.id(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1624,7 +1624,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp"). @@ -1672,7 +1672,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.if_else.IfContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None = None) → InstructionSet` @@ -1830,7 +1830,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1938,7 +1938,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.iswap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1963,7 +1963,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -2057,7 +2057,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2100,7 +2100,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2139,7 +2139,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure(qubit, cbit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`). @@ -2219,7 +2219,7 @@ circuit.measure(qreg[1], creg[1]) -`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_active(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2243,7 +2243,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.measure_all(inplace=True, add_bits=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2274,7 +2274,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ms(theta, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). @@ -2299,7 +2299,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_connected_components(unitary_only=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2321,7 +2321,7 @@ int -`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_nonlocal_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2337,7 +2337,7 @@ int -`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2355,7 +2355,7 @@ int -`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.num_unitary_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2369,7 +2369,7 @@ int -`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.p(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2394,7 +2394,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.pauli(pauli_string, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2417,7 +2417,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.power(power, matrix_power=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2547,7 +2547,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2576,7 +2576,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qbit_argument_conversion(qubit_representation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2598,7 +2598,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_duration(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2620,7 +2620,7 @@ float -`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_start_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2649,7 +2649,7 @@ float -`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.qubit_stop_time(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2678,7 +2678,7 @@ float -`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.r(theta, phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2704,7 +2704,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2731,7 +2731,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2757,7 +2757,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.remove_final_measurements(inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2781,7 +2781,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.repeat(reps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2803,7 +2803,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reset(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2825,7 +2825,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2881,7 +2881,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2923,7 +2923,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rv(vx, vy, vz, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2952,7 +2952,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rx(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2978,7 +2978,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rxx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -3004,7 +3004,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ry(theta, qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -3030,7 +3030,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.ryy(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -3056,7 +3056,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rz(phi, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -3081,7 +3081,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzx(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -3107,7 +3107,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.rzz(theta, qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -3133,7 +3133,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.s(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3157,7 +3157,7 @@ A handle to the instructions created. -`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3181,7 +3181,7 @@ A handle to the instructions created. -`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.size(filter_function=>)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3265,7 +3265,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.swap(qubit1, qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3290,7 +3290,7 @@ A handle to the instructions created. -`QuantumCircuit.switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.switch_case.SwitchContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.switch_case.SwitchContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: Iterable[Tuple[Any, QuantumCircuit]], qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet` @@ -3343,7 +3343,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sx(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3367,7 +3367,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.sxdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3391,7 +3391,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.t(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3415,7 +3415,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tdg(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3439,7 +3439,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.tensor(other, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3490,7 +3490,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_gate(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3513,7 +3513,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.to_instruction(parameter_map=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3536,7 +3536,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3566,7 +3566,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.u(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3756,7 +3756,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: tuple[ClassicalRegister | Clbit, int], body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.while_loop(condition: tuple[ClassicalRegister | Clbit, int], body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") `QuantumCircuit.while_loop(condition: tuple[ClassicalRegister | Clbit, int], body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet` @@ -3803,7 +3803,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -3821,7 +3821,7 @@ int -`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.x(qubit, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -3846,7 +3846,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.y(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -3870,7 +3870,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") +`QuantumCircuit.z(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.md index 5b731fab7b1..b94616c3e37 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") @@ -52,7 +52,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") +`QuantumRegister.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.43/qiskit.circuit.Qubit.md index 7a6e16ee8bd..fac6af7271f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") +`Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/quantumregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.Register.md b/docs/api/qiskit/0.43/qiskit.circuit.Register.md index 236518aa363..40fe5580c65 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.Register.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/register.py "view source code") +`Register(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/register.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None -`Register.index(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/register.py "view source code") +`Register.index(bit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/register.py "view source code") Find the index of the provided bit within this register. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.md index 0ee1ee954f8..958770a8fa1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") +`SwitchCaseOp(target, cases, *, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -91,7 +91,7 @@ Validation of the arguments. -`SwitchCaseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") +`SwitchCaseOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -105,7 +105,7 @@ Set a classical equality condition on this instruction between the register or c -`SwitchCaseOp.cases()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") +`SwitchCaseOp.cases()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") Return a lookup table from case labels to the circuit that would be executed in that case. This object is not generally suitable for creating a new [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") because any keys that point to the same object will not be grouped. @@ -121,7 +121,7 @@ Return a lookup table from case labels to the circuit that would be executed in -`SwitchCaseOp.cases_specifier()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") +`SwitchCaseOp.cases_specifier()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") Return an iterable where each element is a 2-tuple whose first element is a tuple of jump values, and whose second is the single circuit block that is associated with those values. @@ -239,7 +239,7 @@ Containing the definition. -`SwitchCaseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") +`SwitchCaseOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/switch_case.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.md index 08f1335561f..83a9481cb68 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -106,7 +106,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -216,7 +216,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/while_loop.py "view source code") +`WhileLoopOp.replace_blocks(blocks)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.md index cff0a89a6dc..bb88ff86302 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression(expression, name=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `ClassicalElement` @@ -171,7 +171,7 @@ a copy of the current instruction, with the name updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`classmethod BooleanExpression.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format. @@ -315,7 +315,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -361,7 +361,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`BooleanExpression.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.md index 51d1a8acb8b..6975817971c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `ClassicalElement` @@ -128,7 +128,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.compile()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -310,7 +310,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -334,7 +334,7 @@ bool -`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.simulate_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -374,7 +374,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`ClassicalFunction.synth(registerless=True, synthesizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 032824aa36a..bd5ab315b97 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 3aeec85a6d4..aae306971d1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.43/qiskit.circuit.library.AND.md index 9ee839ef5b1..5106a095762 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.md index ff6aa06a90f..5bec4df51c9 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") +`Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -57,7 +57,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") +`Barrier.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -80,7 +80,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") +`Barrier.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -116,7 +116,7 @@ a copy of the current instruction, with the name updated if it was provided -`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") +`Barrier.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.md index f9e6c5ed3c2..b110de64b31 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -37,7 +37,7 @@ Create a new 3-qubit controlled sqrt-X gate. -`C3SXGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3SXGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return a default OpenQASM string for the instruction. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.md index d4dc84d2a28..ae6d83e55d1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -28,7 +28,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C3XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.md index 1ae5af0d7f0..691b6ae7f27 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -32,7 +32,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -56,7 +56,7 @@ controlled version of this gate. -`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`C4XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.md index 5455112617e..742a4978a3f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -84,7 +84,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -108,7 +108,7 @@ controlled version of this gate. -`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`CCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.md index 8d9c1f6fda1..c6c759a0101 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`CCZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`CCZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -59,7 +59,7 @@ Create new CCZ gate. -`CCZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`CCZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CCZ gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.md index 8847a94c5ed..c311adb0fc3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.md index 54668f09af2..ea3b4cfbb09 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CH gate. -`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") +`CHGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.md index 28ce2808ba0..72658df8857 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -55,7 +55,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda)^{\dagger} = CPhase(-\lambda)$) @@ -89,7 +89,7 @@ Return inverted CPhase gate ($CPhase(\lambda)^{\dagger} = CPhase(-\lambda)$) -`CPhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`CPhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.md index 8e94ebbb385..08928b633c7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CRX gate. -`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") +`CRXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.md index f5ad831c956..1dc3bacc12f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CRY gate. -`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") +`CRYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.md index fdd7b529c6d..069bd06ac04 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -78,7 +78,7 @@ Create new CRZ gate. -`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") +`CRZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.md index 4a1445180a6..3a51b5b31bf 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`CSGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -50,7 +50,7 @@ Create new CS gate. -`CSGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of CSGate (CSdgGate). @@ -60,7 +60,7 @@ Return inverse of CSGate (CSdgGate). -`CSGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.md index f66e4f35d23..8124d950347 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") +`CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.md index 1e572dc3027..a756b401b62 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`CSdgGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSdgGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -50,7 +50,7 @@ Create new CSdg gate. -`CSdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of CSdgGate (CSGate). @@ -60,7 +60,7 @@ Return inverse of CSdgGate (CSGate). -`CSdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`CSdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.md index d1f26b008b2..f2074a485c9 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -91,7 +91,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") +`CSwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.md index 0be693affed..b61e0dced2e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -77,7 +77,7 @@ controlled version of this gate. -`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") +`CU1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda)^{\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.md index 65e39292195..0955e648fcd 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU3 gate. -`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") +`CU3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.md index 4f2659b9524..eb93655793e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CU gate. -`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") +`CUGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.md index db5b7330d69..3230c6e0c82 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -78,7 +78,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -102,7 +102,7 @@ controlled version of this gate. -`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`CXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.md index c1052c701d6..e9ad780ea2e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CY gate. -`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") +`CYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.md index c72883cf1ad..0b04e8f4099 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CZ gate. -`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`CZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.md index bb664efc6be..44d7133f525 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.md index 5fc1a5014e5..33f8173f7ed 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.md index 39a7197cd21..7b406106d42 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.md index 25ec563ec80..1b2509f37f3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ Create new ECR gate. -`ECRGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return inverse ECR gate (itself). @@ -84,7 +84,7 @@ Return inverse ECR gate (itself). -`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`ECRGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.md index 1aaa0ffb821..b3647095e06 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 93d920c4f68..d7f400b41ae 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.md index 63ad26c116a..c18307a22c3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.md index b958cbf3e0c..c75d5a83a8c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.md index 35f12835253..30d7fa42f44 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/fourier_checking.py "view source code") +`FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.md index eae9b182ad5..4e95c32a12b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `BlueprintCircuit`, `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.md index a8a9bb0bc80..a7f1411a743 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GR.md index 92adc8ce4e1..da2c828379e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.md index 4fe5e244ca7..0851374b44a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.md index feb6af0a2dd..ef0f045c107 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.md index 74388d01854..0fec8cf3016 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.md index 4a91ad485df..14cae0375dc 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`GlobalPhaseGate(phase, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`GlobalPhaseGate(phase, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -40,7 +40,7 @@ $$ -`GlobalPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`GlobalPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Return inverted GLobalPhaseGate gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.md index dd45de57d89..f81c1198b64 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/graph_state.py "view source code") +`GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/graph_state.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.md index b361f29a5ce..22ef4df87b2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/grover_operator.py "view source code") +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.md index 1cd91cb4806..8678eef563c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -48,7 +48,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -74,7 +74,7 @@ controlled version of this gate. -`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") +`HGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.md index bed14fd615b..cd20f5a0664 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.md index 979fe963fac..ea77ac86dc6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/hidden_linear_function.py "view source code") +`HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.md index e14c17f97e3..c2bc758cb1a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ Create new Identity gate. -`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. @@ -57,7 +57,7 @@ Invert this gate. -`IGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/i.py "view source code") +`IGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/i.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.md index c26f7e5a77e..74d2add3e80 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/iqp.py "view source code") +`IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/iqp.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.md index 54c74d53ed8..520b06f19b4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.md index 1ccef59e06f..6acbbc31906 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.md index 0afe7c50591..1f350a371fa 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -76,7 +76,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`LinearAmplitudeFunction.post_processing(scaled_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.md index 4974044f53c..29f0467f48e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -65,7 +65,7 @@ Create a new linear function. -`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.is_permutation()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -79,7 +79,7 @@ bool -`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.permutation_pattern()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -89,7 +89,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.synthesize()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -107,7 +107,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`LinearFunction.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.md index a4cc0ad6da0..344fec78ca6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.md index b840e4dda54..3b8ab9a8944 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -54,7 +54,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -64,7 +64,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.md index f982254b6b4..8c72a228065 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -78,7 +78,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`MCMTVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.md index 16688ed7617..3beb392c703 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -47,7 +47,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -71,7 +71,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`MCPhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda)^{\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.md index 2f538a8cb1e..12cc2881bde 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -28,7 +28,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -52,7 +52,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -68,7 +68,7 @@ int -`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.md index 7fe1a88baca..964337a76d8 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -28,7 +28,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXGrayCode.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.md index 5e4070ea986..5a4aac27112 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -28,7 +28,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -38,7 +38,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXRecursive.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.md index f1c4c6624f9..6847c485dde 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -36,7 +36,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`MCXVChain.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.md index dc49357afce..9f373c9d761 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.md index e21309d540a..edc6b8f4e87 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/measure.py "view source code") +`Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/measure.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -46,7 +46,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/measure.py "view source code") +`Measure.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.md index e3f270e75a8..d543fc3a5f2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `BlueprintCircuit` @@ -76,7 +76,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.add_layer(other, entanglement=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -104,7 +104,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -128,7 +128,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -173,7 +173,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.get_unentangled_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -191,7 +191,7 @@ set\[int] -`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") +`NLocal.print_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.43/qiskit.circuit.library.OR.md index de4be201866..1c932baca0e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.md index 3e4e3a42eef..839cbf5b8ff 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -76,7 +76,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/pauli_evolution.py "view source code") +`PauliEvolutionGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.md index 2271b3ae617..c55651b497c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -120,7 +120,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_block(pauli_string)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -130,7 +130,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`PauliFeatureMap.pauli_evolution(pauli_string, time)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.md index 1bf31b8e98b..e8aa81287b1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -39,7 +39,7 @@ Create a new gate. -`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -49,7 +49,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`PauliGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.md index c82bb9b066a..1029a218bf5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.md index f8c397ffe31..b7c36f362e3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.md index 442c434c8e4..b6082d71d37 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Return a permutation gate. -`PermutationGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Returns the inverse of the permutation. @@ -52,7 +52,7 @@ Returns the inverse of the permutation. -`PermutationGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`PermutationGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Parameter validation. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.md index 1f1ceb225a2..2e585412bc5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_estimation.py "view source code") +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.md index ee6b7834f3f..ba34a484652 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -96,7 +96,7 @@ controlled version of this gate. -`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda)^{\dagger} = Phase(-\lambda)$) @@ -106,7 +106,7 @@ Return inverted Phase gate ($Phase(\lambda)^{\dagger} = Phase(-\lambda)$) -`PhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") +`PhaseGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.md index 6464c8ad4a0..ecc34a7d298 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle(expression, synthesizer=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -38,7 +38,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_oracle.py "view source code") +`PhaseOracle.evaluate_bitstring(bitstring)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -60,7 +60,7 @@ bool -`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_oracle.py "view source code") +`classmethod PhaseOracle.from_dimacs_file(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.md index fe47e23addf..0139c20bfea 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 688b3dcee71..76ffccb2c89 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -46,7 +46,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`PiecewiseLinearPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index c46e9ac9fea..f7e6245693e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -90,7 +90,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`PiecewisePolynomialPauliRotations.evaluate(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.md index f445139a62a..e4f5ae4df54 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.md index d145388c7f6..05ac89c4d25 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.md index e69d09f0d49..c2699af1d3d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `BlueprintCircuit` @@ -57,7 +57,7 @@ Construct a new QFT circuit. -`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -75,7 +75,7 @@ The inverted circuit. -`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/basis_change/qft.py "view source code") +`QFT.is_inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.md index f7cf1da906c..bb7ff0f4bc0 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -63,7 +63,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.md index d9eaa193d89..24174843bc9 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/quantum_volume.py "view source code") +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.md index 4675acecaaa..ea54993595f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.md index 82aad14cdf2..b1deb3ace12 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.md index 1539951831a..17d4235fd2a 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.md index ca343a4508d..84559e62c51 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new r single-qubit gate. -`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. @@ -58,7 +58,7 @@ r(θ, φ)^dagger = r(-θ, φ) -`RGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/r.py "view source code") +`RGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/r.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.md index b30d96c7070..5867dd79c68 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -57,7 +57,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -67,7 +67,7 @@ Invert this gate. -`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`RVGate.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.md index 642c94b8607..859af6c45c7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. @@ -82,7 +82,7 @@ $RX(\lambda)^{\dagger} = RX(-\lambda)$ -`RXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") +`RXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.md index 202818ea6da..30ff38629d7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new RXX gate. -`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). @@ -82,7 +82,7 @@ Return inverse RXX gate (i.e. with the negative rotation angle). -`RXXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`RXXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rxx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.md index ac4d89d518d..e4353f2e5d4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. @@ -82,7 +82,7 @@ $RY(\lambda)^{\dagger} = RY(-\lambda)$ -`RYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") +`RYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ry.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.md index 41d5a9f3eb0..7b1bc6a17dc 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new RYY gate. -`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). @@ -82,7 +82,7 @@ Return inverse RYY gate (i.e. with the negative rotation angle). -`RYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`RYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/ryy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.md index c6171adeed6..5439ce0c42b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -82,7 +82,7 @@ controlled version of this gate. -`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate @@ -94,7 +94,7 @@ $RZ(\lambda)^{\dagger} = RZ(-\lambda)$ -`RZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") +`RZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.md index 56737172e80..5a7be972ad2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -110,7 +110,7 @@ Create new RZX gate. -`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). @@ -120,7 +120,7 @@ Return inverse RZX gate (i.e. with the negative rotation angle). -`RZXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`RZXGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.md index 6c4cb457f8d..03bc82778ff 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -84,7 +84,7 @@ Create new RZZ gate. -`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). @@ -94,7 +94,7 @@ Return inverse RZZ gate (i.e. with the negative rotation angle). -`RZZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`RZZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/rzz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.md index 15b7fc0cdee..8c748621df7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.md index 16263eb5b33..02fd95d6d16 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/reset.py "view source code") +`Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/reset.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -46,7 +46,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/reset.py "view source code") +`Reset.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.md index 24c78c3c1d0..8bec3e9a072 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -51,7 +51,7 @@ Create new S gate. -`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). @@ -61,7 +61,7 @@ Return inverse of S (SdgGate). -`SGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`SGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.md index fe3a3bf2dd2..e1f4d39a31c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -57,7 +57,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -83,7 +83,7 @@ controlled version of this gate. -`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.md index 327a6326dba..b342305a596 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ Create new SXdg gate. -`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") +`SXdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.md index aff92f0b5b5..1108d3127b4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -51,7 +51,7 @@ Create new Sdg gate. -`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). @@ -61,7 +61,7 @@ Return inverse of Sdg (SGate). -`SdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") +`SdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.md index cbad5945648..ab8906f59f3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation(params, num_qubits=None, inverse=False, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -102,7 +102,7 @@ A tuple with single arguments. -`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -112,7 +112,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`StatePreparation.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.md index ec5c7c425d1..9524c341f0d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -82,7 +82,7 @@ controlled version of this gate. -`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") +`SwapGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.md index 0bbc69ed97c..faa3b791f16 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -51,7 +51,7 @@ Create new T gate. -`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). @@ -61,7 +61,7 @@ Return inverse T gate (i.e. Tdg). -`TGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") +`TGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.md index 9fb1428ed67..c48cdb1941f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -51,7 +51,7 @@ Create new Tdg gate. -`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). @@ -61,7 +61,7 @@ Return inverse Tdg gate (i.e. T). -`TdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") +`TdgGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.md index ff588553e1f..be47f5d2a2b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -136,7 +136,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/two_local.py "view source code") +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.md index d8edf28f5e0..178e5f623d6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -85,7 +85,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -109,7 +109,7 @@ controlled version of this gate. -`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") +`U1Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda)^{\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.md index 9678770493e..cd26e149e49 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -84,7 +84,7 @@ Create new U2 gate. -`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u2.py "view source code") +`U2Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.md index 82f7a69d568..3d593cbbc15 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -76,7 +76,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -100,7 +100,7 @@ controlled version of this gate. -`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") +`U3Gate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.md index 1b4943117f8..0c21a381b38 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -60,7 +60,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -84,7 +84,7 @@ controlled version of this gate. -`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") +`UGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.md index dd9c4443614..adfa80a50d6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.md index 5085d5c0cbb..77be983508d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.md index 00e714235ca..a28450ad07f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -66,7 +66,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") +`XGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.md index bf72bc8a3c7..205a60ab981 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.md index 1df080856d4..d12dc569fea 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -80,7 +80,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. @@ -90,7 +90,7 @@ Inverse gate. -`XXMinusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`XXMinusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.md index 14ad6056a16..7167d22859d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -80,7 +80,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). @@ -90,7 +90,7 @@ Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase -`XXPlusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`XXPlusYYGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.md index 9a38e7988d2..d6b4c7bd305 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -66,7 +66,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") +`YGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y^{\dagger} = Y$) diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.md index 9059349cbf3..14d995730e3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.md index 6eed5ef3378..2d1e6a2c58c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -66,7 +66,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). @@ -102,7 +102,7 @@ Return inverted Z gate (itself). -`ZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") +`ZGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/z.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.md index 4044d94e1e5..46abba5a5f7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_1.md index 4f01e6e0c97..2cb294f1b01 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_2_1 -`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_2.md index ac47ff6b335..3c500c730e8 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_2_2 -`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_3.md index c9d35a627f4..2c107b690a5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_2_3 -`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_4.md index dcffb84260e..f71a6dbb481 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_2_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_2_4 -`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_3_1.md index 728667795c9..008544b7c74 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_3_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_3_1 -`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_1.md index fa4a6a17017..dd1618f36e7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_4_1 -`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_2.md index a252e3075b2..49babcedd54 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_4_2 -`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_3.md index e86d5e52447..5fe88ee69fe 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_4_3 -`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_4.md index 9ece06c7cd2..6a201f79329 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_4_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_4_4 -`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_5_1.md index 44162c0078d..a15dc6a6764 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_5_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_5_1 -`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_1.md index b254de943be..ec03d2f629e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_6_1 -`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_2.md index 68caa0a33b7..2f3e9027cf1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_6_2 -`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_3.md index ca251472f63..839a0cacff5 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_6_3 -`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_4.md index 3f37f787644..1abf567d22d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_6_4 -`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_5.md index c70d172f835..8539a3e894e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_6_5.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_6_5 -`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_1.md index 7872f41ef88..b4228cadec3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_8_1 -`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_2.md index ef623587fff..89ec6484768 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_8_2 -`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_3.md index 4dcee6f64ac..b8aaa3723ff 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.clifford_8_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.clifford_8_3 -`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.md index 765aa47c4fb..558d7198d62 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -79,7 +79,7 @@ Create new iSwap gate. -`iSwapGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`iSwapGate.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/iswap.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_cy.md index 640f13244b4..9bcb7150599 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_cy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.rzx_cy -`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_xz.md index a0092e14b5f..c152b8130e2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_xz.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.rzx_xz -`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_yz.md index 3fea16013f9..8d66d3e01e1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_yz.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.rzx_yz -`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz1.md index f93f770bb59..0141a8817f0 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.rzx_zz1 -`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz2.md index 51d5dc70112..45a7378972f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.rzx_zz2 -`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz3.md index 342b8c994f2..910a5fc632f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.rzx_zz3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.rzx_zz3 -`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 7ede2d932be..91a9098a154 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 -`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 43fcc97e5ab..ff7d2b56141 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 -`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 042cb71b09e..21246b54576 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 -`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index 0cd495b0ab9..2ac478da204 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 -`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 63a1af678c9..86750b8c51e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 -`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index a7e092cb950..07234e098b0 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 -`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 0909c39cd8d..83002859eb7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 -`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index 0be71e13383..954f0e1892c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 -`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index be76db3e7d5..81234990be7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 -`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index c4ce2b3133e..a05a21066c4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 -`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index ce5166638ec..b81569fa436 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 -`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index 2acb094c78d..b90a0a60100 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 -`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 633c10321c4..dc91a862cbf 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 -`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index f045146799e..6f907ddcea3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 -`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index d9ea2d69f0c..c1688b464a1 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 -`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 5ca011f6a9c..0dbd876da95 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 -`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 2bfbe3496b3..73e8fa93186 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 -`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index ab333611485..d80d3ead757 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 -`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 3d911724909..472bdc2e48d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 -`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 29aa16034e9..fbf0f07f5ca 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 -`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index 0592a8fc023..40cfbb9e9c3 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 -`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index 09822ee6671..0aa308844bf 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 -`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 31954095a38..9faff3e9764 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 -`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index ea164a272b8..cc04dcecf49 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 -`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index e2db253d7d3..daba1099ad7 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 -`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 648158e7e0d..faeadc97c1f 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 -`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 96a829899ba..f2ed83c54ec 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 -`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index cf0c9466963..e7e99786e5e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 -`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index 935f206b242..df1b0f5496d 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 -`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 7cbff88d311..1ea7d5451ea 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 -`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 0205e9cd56a..1160eb9fa84 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 -`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 1920876430a..03d874e98d4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 -`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index 670bf10b76e..abf29e2a253 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 -`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index 73060cba3aa..1cec00ba9e6 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 -`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index c2d3c714866..3973a7ead0b 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 -`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 764839a1cf7..72b8fb7639e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 -`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index 2fb14f4f011..4c135e7e981 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 -`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 01f56eeac09..44c108ac1ac 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 -`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index b7a3b463517..4663086f8e4 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 -`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index 2c4f3ef428e..4cbe0b9a489 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 -`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 014b1e77b48..f4c386f9e8e 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 -`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index 63ddd973572..9d7990cb414 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 -`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 99234d002d7..dd42f6a52ab 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 -`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index deb46dfdb05..31f0d149fd2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 -`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index dd926ed3f7b..de6814873d2 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 -`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 32de2d598fe..db6ddea8720 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 -`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 80f44f4fffb..deb117dec4c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 -`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.43/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.43/qiskit.circuit.random.random_circuit.md index 235bfd6462a..0d29104624c 100644 --- a/docs/api/qiskit/0.43/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.43/qiskit.circuit.random.random_circuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.random.random_circuit -`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/random/utils.py "view source code") +`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.43/qiskit.compiler.assemble.md b/docs/api/qiskit/0.43/qiskit.compiler.assemble.md index 1bcd899b6c4..1fb2975cc18 100644 --- a/docs/api/qiskit/0.43/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.43/qiskit.compiler.assemble.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/assembler.py "view source code") +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.43/qiskit.compiler.schedule.md b/docs/api/qiskit/0.43/qiskit.compiler.schedule.md index e08ad4ede00..7d8ddcf0073 100644 --- a/docs/api/qiskit/0.43/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.43/qiskit.compiler.schedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/scheduler.py "view source code") +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.43/qiskit.compiler.sequence.md b/docs/api/qiskit/0.43/qiskit.compiler.sequence.md index a57f733c56e..4fefda39b4c 100644 --- a/docs/api/qiskit/0.43/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.43/qiskit.compiler.sequence.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/sequencer.py "view source code") +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.43/qiskit.compiler.transpile.md b/docs/api/qiskit/0.43/qiskit.compiler.transpile.md index c5a53365d2c..b99b206717e 100644 --- a/docs/api/qiskit/0.43/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.43/qiskit.compiler.transpile.md @@ -12,7 +12,7 @@ python_api_name: qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/transpiler.py "view source code") +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.43/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.43/qiskit.converters.ast_to_dag.md index 5fcc705fa39..35189331665 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.43/qiskit.converters.ast_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.ast_to_dag -`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/ast_to_dag.py "view source code") +`ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dag.md index 78c61d47383..52fe51c65b3 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_dag -`circuit_to_dag(circuit, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_dag.py "view source code") +`circuit_to_dag(circuit, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dagdependency.md index 93a75200ebd..6b9c53dded6 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_dagdependency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_dagdependency -`circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_dagdependency.py "view source code") +`circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_gate.md index 9c5d196e069..13dd1b7bef2 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_gate.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_gate.py "view source code") +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_instruction.md index d9314d0d604..1721e8778fa 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.43/qiskit.converters.circuit_to_instruction.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.circuit_to_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_instruction.py "view source code") +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.43/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.43/qiskit.converters.dag_to_circuit.md index c54b1f29220..6921e4078e2 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.43/qiskit.converters.dag_to_circuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dag_to_circuit -`dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dag_to_circuit.py "view source code") +`dag_to_circuit(dag, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.43/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.43/qiskit.converters.dag_to_dagdependency.md index 3b937ae413b..7222249fe8d 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.43/qiskit.converters.dag_to_dagdependency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dag_to_dagdependency -`dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dag_to_dagdependency.py "view source code") +`dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_circuit.md index bf731b8e4f5..aebce9ca550 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_circuit.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dagdependency_to_circuit -`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dagdependency_to_circuit.py "view source code") +`dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_dag.md index 3cd47fb12c5..f22ffa8d0c2 100644 --- a/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.43/qiskit.converters.dagdependency_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.converters.dagdependency_to_dag -`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dagdependency_to_dag.py "view source code") +`dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.md index 1990d6bc961..407544a37e6 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -49,7 +49,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -59,7 +59,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -69,7 +69,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -79,7 +79,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -89,7 +89,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.ancestors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -99,7 +99,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -127,7 +127,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -155,7 +155,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.bfs_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -165,7 +165,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_1q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -175,7 +175,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_2q_runs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -185,7 +185,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.collect_runs(namelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -199,7 +199,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -233,7 +233,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.copy_empty_like()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -258,7 +258,7 @@ An empty copy of self. -`DAGCircuit.count_ops(*, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops(*, recurse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -280,7 +280,7 @@ Mapping\[str, int] -`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.count_ops_longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -292,7 +292,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.depth(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be staticly known. @@ -319,7 +319,7 @@ int -`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.descendants(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -329,7 +329,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -355,7 +355,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.edges(nodes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -379,7 +379,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.front_layer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -389,7 +389,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.gate_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -407,7 +407,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.has_calibration_for(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -417,7 +417,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.idle_wires(ignore=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -439,7 +439,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_predecessor(node, node_pred)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -449,7 +449,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.is_successor(node, node_succ)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -459,7 +459,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -475,7 +475,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.longest_path()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -485,7 +485,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multi_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -495,7 +495,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.multigraph_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -505,7 +505,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.named_nodes(*names)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -515,7 +515,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -537,7 +537,7 @@ node -`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -551,7 +551,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.nodes_on_wire(wire, only_ops=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -574,7 +574,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_clbits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -584,7 +584,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -594,7 +594,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.num_tensor_factors()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -604,7 +604,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.op_nodes(op=None, include_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -627,7 +627,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -637,7 +637,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -647,7 +647,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_predecessors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -657,7 +657,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.quantum_successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -667,7 +667,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_all_ops_named(opname)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -677,7 +677,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_ancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -687,7 +687,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_clbits(*clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -705,7 +705,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_cregs(*cregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -720,7 +720,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_descendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -730,7 +730,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nonancestors_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -740,7 +740,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_nondescendants_of(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -750,7 +750,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_op_node(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -762,7 +762,7 @@ Add edges from predecessors to successors. -`DAGCircuit.remove_qregs(*qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qregs(*qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -777,7 +777,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_qubits(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.remove_qubits(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Remove quantum bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -795,7 +795,7 @@ Remove quantum bits from the circuit. All bits MUST be idle. Any registers with -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single node. @@ -826,7 +826,7 @@ The op node that replaces the block. -`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.reverse_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -844,7 +844,7 @@ the reversed dag. -`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.serial_layers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -856,7 +856,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.size(*, recurse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be statically known. @@ -882,7 +882,7 @@ int -`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node(node, op, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single operation. qargs, cargs and conditions for the new operation will be inferred from the node to be replaced. The new operation will be checked to match the shape of the replaced operation. @@ -911,7 +911,7 @@ the new node containing the added operation. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -940,7 +940,7 @@ dict -`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.successors(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -950,7 +950,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.swap_nodes(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.swap_nodes(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Swap connected nodes e.g. due to commutation. @@ -969,7 +969,7 @@ Swap connected nodes e.g. due to commutation. -`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -991,7 +991,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.topological_op_nodes(key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -1015,7 +1015,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.two_qubit_ops()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -1025,7 +1025,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") +`DAGCircuit.width()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.md index d7086bcf84d..16ade773b3d 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGCircuitError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/exceptions.py "view source code") +`DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.md index cbcc306c01b..7f9796902a4 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdepnode.py "view source code") +`DAGDepNode.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -36,7 +36,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdepnode.py "view source code") +`static DAGDepNode.semantic_eq(node1, node2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.md index 383c0f92627..c952b801648 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_clbits(clbits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -58,7 +58,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_creg(creg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -68,7 +68,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_op_node(operation, qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -84,7 +84,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qreg(qreg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -94,7 +94,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.add_qubits(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -104,7 +104,7 @@ Add individual qubit wires. -`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -114,7 +114,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.depth()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -124,7 +124,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -146,7 +146,7 @@ List -`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.direct_successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -168,7 +168,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.draw(scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -196,7 +196,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_all_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -214,7 +214,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_edges(src_id, dest_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -237,7 +237,7 @@ List -`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_in_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -259,7 +259,7 @@ List -`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_node(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -279,7 +279,7 @@ node -`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -295,7 +295,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.get_out_edges(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -317,7 +317,7 @@ List -`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.predecessors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -339,7 +339,7 @@ List -`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Replace a block of nodes with a single node. @@ -364,7 +364,7 @@ It is important that such consolidation preserves commutativity assumptions pres -`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -374,7 +374,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.successors(node_id)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -396,7 +396,7 @@ List -`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.to_retworkx()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -406,7 +406,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") +`DAGDependency.topological_nodes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.md index 4161ffdf0e0..0deb6731482 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") +`DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.md index 1f2d2981e95..7ab25b657de 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") +`DAGNode(nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.md index 507d8c418ef..8e2b055675f 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.md index c522b01eb52..df6116d57cf 100644 --- a/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.43/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") +`DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.md index d13cae6d8aa..2b911e9ed6f 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -139,7 +139,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -199,7 +199,7 @@ a copy of the current instruction, with the name updated if it was provided -`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -245,7 +245,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.qasm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -347,7 +347,7 @@ np.ndarray -`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -357,7 +357,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") +`HamiltonianGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.43/qiskit.extensions.Initialize.md index bf63c25705d..d3cf1b0aedc 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize(params, num_qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -59,7 +59,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.broadcast_arguments(qargs, cargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -118,7 +118,7 @@ a copy of the current instruction, with the name updated if it was provided -`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`Initialize.gates_to_uncompute()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.md index 9d301a996cf..aa8baaa4688 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -173,7 +173,7 @@ a copy of the current instruction, with the name updated if it was provided -`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -325,7 +325,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/squ.py "view source code") +`SingleQubitUnitary.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.md index b8e23e22033..19a41046c61 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -48,7 +48,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.assemble()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -81,7 +81,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.c_if(classical, val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -117,7 +117,7 @@ a copy of the current instruction, with the name updated if it was provided -`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") +`Snapshot.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.md index 608d4efd5c7..7bd2552b922 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.md index 06bd2311d68..9d50c8c19c8 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.md index 7db0e0db922..b785fc6e341 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.md index 4bbf2971372..1846aff65d3 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.md index 22fb338d728..2b72ff5ce60 100644 --- a/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.43/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -154,7 +154,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -164,7 +164,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -215,7 +215,7 @@ a copy of the current instruction, with the name updated if it was provided -`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -365,7 +365,7 @@ np.ndarray -`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -375,7 +375,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") +`UnitaryGate.validate_parameter(parameter)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.md index 06e57c6bb3a..8737ee1d735 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Bases: `StarAlgebraMixin`, `TensorMixin`, `ABC` @@ -30,7 +30,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -92,7 +92,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.bind_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -106,7 +106,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -136,7 +136,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -150,7 +150,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -172,7 +172,7 @@ bool -`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -196,7 +196,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -212,7 +212,7 @@ bool -`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.neg()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -252,7 +252,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -278,7 +278,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -296,7 +296,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -310,7 +310,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -336,7 +336,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -358,7 +358,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -372,7 +372,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -390,7 +390,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`abstract OperatorBase.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -404,7 +404,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") +`OperatorBase.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.md index 5eba0d65e75..3f9e018d78b 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.OpflowError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.opflow.OpflowError -`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/exceptions.py "view source code") +`OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/exceptions.py "view source code") Deprecated: For Opflow specific errors. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.43/qiskit.opflow.anti_commutator.md index 5a69ee0ff2f..34796cdf724 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.anti_commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.opflow.anti_commutator -`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/utils.py "view source code") +`anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/utils.py "view source code") Deprecated: Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.commutator.md b/docs/api/qiskit/0.43/qiskit.opflow.commutator.md index 3df2c4656b3..08a92a903a6 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.opflow.commutator -`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/utils.py "view source code") +`commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/utils.py "view source code") Deprecated: Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.md index 9f646257cd4..d37aeadb3f7 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -34,7 +34,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/abelian_grouper.py "view source code") +`AbelianGrouper.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -56,7 +56,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/abelian_grouper.py "view source code") +`classmethod AbelianGrouper.group_subops(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.md index 1df30adcf60..04dfd4a8789 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -42,7 +42,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.clear_cache()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -52,7 +52,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -79,7 +79,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.md index 717596d4f0d..f44f13e17d4 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/converter_base.py "view source code") +`ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/converter_base.py "view source code") Bases: `ABC` @@ -28,7 +28,7 @@ Deprecated: Converters take an Operator and return a new Operator, generally iso -`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/converter_base.py "view source code") +`abstract ConverterBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.md index ddb8d247f4f..69d29809b8c 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -34,7 +34,7 @@ Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitSt -`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`DictToCircuitSum.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.md index 3eb684face5..1600b02b4a7 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -45,7 +45,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -68,7 +68,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -90,7 +90,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_cob_circuit(origin)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -124,7 +124,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -146,7 +146,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_diagonalizing_clifford(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -170,7 +170,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.get_tpb_pauli(list_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -192,7 +192,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -215,7 +215,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -238,7 +238,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -261,7 +261,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.md index 574010f8206..7dfed6a27b3 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -34,7 +34,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`TwoQubitReduction.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.43/qiskit.opflow.double_commutator.md index 85302c19d31..e8e4993f451 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.double_commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.opflow.double_commutator -`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/utils.py "view source code") +`double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/utils.py "view source code") Deprecated: Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.md index 53c36ddfbe0..b5692471b4c 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_base.py "view source code") +`EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `ABC` @@ -28,7 +28,7 @@ Deprecated: A base for Evolution converters. Evolutions are converters which tra -`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_base.py "view source code") +`abstract EvolutionBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.md index 0dda751ae7f..c0e38806a61 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Deprecated: A factory class for convenient automatic selection of an Evolution a -`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`static EvolutionFactory.build(operator=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.md index e56f4ff0ae1..062a59776bb 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`EvolvedOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -33,7 +33,7 @@ Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) b -`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -95,7 +95,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -125,7 +125,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -147,7 +147,7 @@ bool -`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -171,7 +171,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -185,7 +185,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -211,7 +211,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -229,7 +229,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -247,7 +247,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -273,7 +273,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_instruction(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -287,7 +287,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -305,7 +305,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") +`EvolvedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.md index 299c107d00e..840a26b1d27 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -28,7 +28,7 @@ Deprecated: Performs Evolution by classical matrix exponentiation, constructing -`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`MatrixEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.md index ae65899a39f..674429c03a7 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -40,7 +40,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -62,7 +62,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -76,7 +76,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.md index 01cc0ebb504..b80793d3f55 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -32,7 +32,7 @@ Deprecated: The QDrift Trotterization method, which selects each each term in th -`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`QDrift.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.md index 0a7b096a905..2107cbc7c2f 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -35,7 +35,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`Suzuki.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.md index dbe0289768f..60b2ff846a9 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.md index 370ef29b899..6fc12fa583d 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -28,7 +28,7 @@ Deprecated: A base for Trotterization methods, algorithms for approximating expo -`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`abstract TrotterizationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.md index c76e0a0d062..8b6405ae39b 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Deprecated: A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`static TrotterizationFactory.build(mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.md index f26734d84ac..df92268f7ab 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -28,7 +28,7 @@ Deprecated: An Expectation converter for using Aer’s operator snapshot to take -`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -50,7 +50,7 @@ list | float -`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`AerPauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.md index 60eb959f7ad..58f7fab5db5 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -51,7 +51,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -79,7 +79,7 @@ list | float -`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`CVaRExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.md index cf95c69aaa1..c371f0f8b04 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_base.py "view source code") +`ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Deprecated: A base for Expectation value converters. Expectations are converters -`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -50,7 +50,7 @@ list | complex | [*ndarray*](https://numpy.org/doc/stable/reference/generated/nu -`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_base.py "view source code") +`abstract ExpectationBase.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.md index e512e2be803..e50acfa49da 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_factory.py "view source code") +`ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Deprecated: factory class for convenient automatic selection of an Expectation b -`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_factory.py "view source code") +`static ExpectationFactory.build(operator, backend=None, include_custom=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.md index 31f9853a0f6..399510e1ede 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -28,7 +28,7 @@ Deprecated: An Expectation converter which converts Operator measurements to be -`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -50,7 +50,7 @@ list | float -`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`MatrixExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.md index 337938c9e77..83c5e9f708d 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -32,7 +32,7 @@ Deprecated: An Expectation converter for Pauli-basis observables by changing Pau -`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.compute_variance(exp_op)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -54,7 +54,7 @@ list | float | [*ndarray*](https://numpy.org/doc/stable/reference/generated/nump -`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`PauliExpectation.convert(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.md index 3b5501aa82d..a463be1a738 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -34,7 +34,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`abstract CircuitGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.md index 0514efacb19..00e26baf260 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -34,7 +34,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`abstract CircuitQFI.convert(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.md index f2acbd24288..aa5330b4ebe 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -34,7 +34,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") +`abstract DerivativeBase.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -59,7 +59,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -85,7 +85,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") +`static DerivativeBase.parameter_expression_grad(param_expr, param)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.md index 3ebfdc40816..e1721d42e5a 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -28,7 +28,7 @@ Deprecated: Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -54,7 +54,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient.py "view source code") +`Gradient.get_gradient(operator, params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.md index 49cffdba9f5..01e520d9574 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient_base.py "view source code") +`GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.md index 41c79b67f44..0540af01b1a 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -28,7 +28,7 @@ Deprecated: Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -49,7 +49,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian.py "view source code") +`Hessian.get_hessian(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.md index bbdf2424fac..ca2f6a90749 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian_base.py "view source code") +`HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.md index 9b1f62d1bcd..d6f7cffdef9 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -45,7 +45,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/natural_gradient.py "view source code") +`NaturalGradient.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -72,7 +72,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/natural_gradient.py "view source code") +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.md index fd20e2ecf9a..ca134931278 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/qfi.py "view source code") +`QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -35,7 +35,7 @@ $$ -`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/qfi.py "view source code") +`QFI.convert(operator, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.md index 4fa35401d74..c409ffc8c94 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/qfi_base.py "view source code") +`QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.md index 40f42f997d9..a4303c268c9 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -34,7 +34,7 @@ Deprecated: A class for lazily representing compositions of Operators. Often Ope -`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -82,7 +82,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -112,7 +112,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.non_distributive_reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -130,7 +130,7 @@ The reduced Operator. -`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -148,7 +148,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. @@ -170,7 +170,7 @@ The circuit representation of the composed operator. -`ComposedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") +`ComposedOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/composed_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.md index 83f1ca893f6..1873731b344 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -43,7 +43,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -83,7 +83,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -105,7 +105,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -135,7 +135,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`static ListOp.default_combo_fn(x)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -149,7 +149,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -171,7 +171,7 @@ bool -`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -201,7 +201,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -215,7 +215,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -229,7 +229,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -251,7 +251,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -277,7 +277,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -291,7 +291,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -309,7 +309,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -327,7 +327,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -353,7 +353,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -375,7 +375,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -407,7 +407,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -421,7 +421,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -435,7 +435,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -453,7 +453,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") +`ListOp.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.md index 4e5b011fbfc..970607cd5a9 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -34,7 +34,7 @@ Deprecated: A class for lazily representing sums of Operators. Often Operators c -`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -60,7 +60,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.collapse_summands()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -80,7 +80,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -116,7 +116,7 @@ True -`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -136,7 +136,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -159,7 +159,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -173,7 +173,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") +`SummedOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.md index a818fec0b4b..a6398f34703 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -34,7 +34,7 @@ Deprecated: A class for lazily representing tensor products of Operators. Often -`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -64,7 +64,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -82,7 +82,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -108,7 +108,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. @@ -130,7 +130,7 @@ The circuit representation of the tensored operator. -`TensoredOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") +`TensoredOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/list_ops/tensored_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.md index 60865a0cbc7..92573f691c3 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`CircuitOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -38,7 +38,7 @@ Deprecated: Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -78,7 +78,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -100,7 +100,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -130,7 +130,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ bool -`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -176,7 +176,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -198,7 +198,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -216,7 +216,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -234,7 +234,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -260,7 +260,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -274,7 +274,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -288,7 +288,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -302,7 +302,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`CircuitOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.md index b723c5fda3b..9eab7206d3a 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`MatrixOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -38,7 +38,7 @@ Deprecated: Class for Operators represented by matrices, backed by Terra’s `Op -`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -78,7 +78,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -108,7 +108,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -130,7 +130,7 @@ bool -`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -154,7 +154,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -168,7 +168,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.permute(permutation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -194,7 +194,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -212,7 +212,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -238,7 +238,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -252,7 +252,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -270,7 +270,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`MatrixOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.md index 4f414b42531..3ff47f6d3c4 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`PauliOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -37,7 +37,7 @@ Deprecated: Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -59,7 +59,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -77,7 +77,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -107,7 +107,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -129,7 +129,7 @@ bool -`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -167,7 +167,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -193,7 +193,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -211,7 +211,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -251,7 +251,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -265,7 +265,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -283,7 +283,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -297,7 +297,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`PauliOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.md index 7397764af6b..710cdc42dbe 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`PauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -38,7 +38,7 @@ Deprecated: Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -78,7 +78,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -108,7 +108,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -130,7 +130,7 @@ bool -`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -154,7 +154,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -168,7 +168,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -192,7 +192,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_hermitian()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -204,7 +204,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.is_zero()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -218,7 +218,7 @@ bool -`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -242,7 +242,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -264,7 +264,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -290,7 +290,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -308,7 +308,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.reduce(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -331,7 +331,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -357,7 +357,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -371,7 +371,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -389,7 +389,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -403,7 +403,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`PauliSumOp.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.md index 0d6f9d18c49..e96a67274dd 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -39,7 +39,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -61,7 +61,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -79,7 +79,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -101,7 +101,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -131,7 +131,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ bool -`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -177,7 +177,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.exp_i()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -191,7 +191,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.log_i(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -227,7 +227,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -253,7 +253,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -271,7 +271,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -289,7 +289,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -315,7 +315,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -351,7 +351,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -365,7 +365,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -379,7 +379,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -397,7 +397,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -411,7 +411,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`PrimitiveOp.to_pauli_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 87186c79f52..8df4850d5c3 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`TaperedPauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -38,7 +38,7 @@ Deprecated: Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`TaperedPauliSumOp.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.md index 0eb226c3144..396cb609ea5 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -40,7 +40,7 @@ Deprecated: Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.consistent_tapering(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -66,7 +66,7 @@ The tapered operator -`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.convert_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -92,7 +92,7 @@ This method operates the first part of the tapering. It converts the operator by -`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :returns: copy @@ -106,7 +106,7 @@ Get a copy of self. :returns: copy -`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`classmethod Z2Symmetries.find_Z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -124,7 +124,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :returns: Empty or not @@ -138,7 +138,7 @@ bool -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -168,7 +168,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`Z2Symmetries.taper_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.opflow.primitive_ops.Z2Symmetries#convert_clifford "qiskit.opflow.primitive_ops.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.md index 0c63d8eff86..d4982f96ec1 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`CVaRMeasurement(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -44,7 +44,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -66,7 +66,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -84,7 +84,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.compute_cvar(energies, probabilities)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -115,7 +115,7 @@ complex -`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.eval_variance(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -165,7 +165,7 @@ complex -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -193,7 +193,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -215,7 +215,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -235,7 +235,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -261,7 +261,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -271,7 +271,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -281,7 +281,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -291,7 +291,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -301,7 +301,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`CVaRMeasurement.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.md index 90c64b65635..653b7dc660c 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`CircuitStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -39,7 +39,7 @@ Deprecated: A class for state functions and measurements which are defined by th -`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -61,7 +61,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -79,7 +79,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -101,7 +101,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -129,7 +129,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_dict(density_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -175,7 +175,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`static CircuitStateFn.from_vector(statevector)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -197,7 +197,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -219,7 +219,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -237,7 +237,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -269,7 +269,7 @@ dict -`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -295,7 +295,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit(meas=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -309,7 +309,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -323,7 +323,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -337,7 +337,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -347,7 +347,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`CircuitStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.md index 912bfbb2662..8a61903b1e2 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`DictStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -39,7 +39,7 @@ Deprecated: A class for state functions and measurements which are defined by a -`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -61,7 +61,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -79,7 +79,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -103,7 +103,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -125,7 +125,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -143,7 +143,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -167,7 +167,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -193,7 +193,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -207,7 +207,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -233,7 +233,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -251,7 +251,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -273,7 +273,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`DictStateFn.to_spmatrix_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.md index 40dd1e8bb5f..c97b9e4d6ef 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`OperatorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -34,7 +34,7 @@ Deprecated: A class for state functions and measurements which are defined by a -`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -56,7 +56,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -74,7 +74,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -98,7 +98,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -120,7 +120,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -138,7 +138,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -158,7 +158,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -184,7 +184,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -194,7 +194,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -208,7 +208,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -236,7 +236,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`OperatorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.md index b1e6a97f819..772ab362f96 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`SparseVectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -41,7 +41,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -81,7 +81,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -103,7 +103,7 @@ bool -`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -127,7 +127,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -145,7 +145,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -169,7 +169,7 @@ dict -`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -183,7 +183,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -201,7 +201,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -219,7 +219,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -241,7 +241,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`SparseVectorStateFn.to_spmatrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.md index e650d3f8401..d236b56a155 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -44,7 +44,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -66,7 +66,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -84,7 +84,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.assign_parameters(param_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -106,7 +106,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.compose(other, permutation=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -134,7 +134,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.equals(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -156,7 +156,7 @@ bool -`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -180,7 +180,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.mul(scalar)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -202,7 +202,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -224,7 +224,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.power(exponent)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -246,7 +246,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.reduce()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -282,7 +282,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -306,7 +306,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -332,7 +332,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.tensorpower(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -354,7 +354,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -368,7 +368,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -394,7 +394,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -412,7 +412,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -434,7 +434,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") +`StateFn.traverse(convert_fn, coeff=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.md index 80efb930da6..d9891e10cf0 100644 --- a/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.43/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`VectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -34,7 +34,7 @@ Deprecated: A class for state functions and measurements which are defined in ve -`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.add(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -56,7 +56,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -74,7 +74,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.eval(front=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -98,7 +98,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.permute(permutation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -120,7 +120,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.primitive_strings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -138,7 +138,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -162,7 +162,7 @@ dict -`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -188,7 +188,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_circuit_op()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -202,7 +202,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_density_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -228,7 +228,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_dict_fn()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -246,7 +246,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -264,7 +264,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`VectorStateFn.to_matrix_op(massive=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.md index e368f060bbe..9f5fc693b9e 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] @@ -98,7 +98,7 @@ Set options values for the estimator. -`BackendEstimator.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_estimator.py "view source code") +`BackendEstimator.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_estimator.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.md index 42970b64244..f98d31478fe 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] @@ -81,7 +81,7 @@ Set options values for the estimator. -`BackendSampler.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_sampler.py "view source code") +`BackendSampler.set_transpile_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/backend_sampler.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.md index 7f24ab688a3..f5a35de6c15 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`BaseEstimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_estimator.py "view source code") Bases: `BasePrimitive`, `Generic`\[`T`] @@ -32,7 +32,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_estimator.py "view source code") +`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_estimator.py "view source code") Run the job of the estimation of expectation value(s). diff --git a/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.md index 037dbd902d3..ed73c8726eb 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`BaseSampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_sampler.py "view source code") Bases: `BasePrimitive`, `Generic`\[`T`] @@ -30,7 +30,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`BaseSampler.run(circuits, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_sampler.py "view source code") +`BaseSampler.run(circuits, parameter_values=None, **run_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/base_sampler.py "view source code") Run the job of the sampling of bitstrings. diff --git a/docs/api/qiskit/0.43/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.43/qiskit.primitives.Estimator.md index 0a6dbd2e8c9..d5721d9724c 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/estimator.py "view source code") +`Estimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.md index 03175e079c0..0b739b233e5 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/estimator_result.py "view source code") +`EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/estimator_result.py "view source code") Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/0.43/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.43/qiskit.primitives.Sampler.md index f87d880944a..046bf39498f 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/sampler.py "view source code") +`Sampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.md index d1958995a43..e96f5ee2812 100644 --- a/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.43/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/sampler_result.py "view source code") +`SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/primitives/base/sampler_result.py "view source code") Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/0.43/qiskit.providers.Backend.md b/docs/api/qiskit/0.43/qiskit.providers.Backend.md index 2ed4825a09f..44727087203 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.43/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.md index 4f8f3e440a3..7e86c7deefd 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendPropertyError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") +`BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.43/qiskit.providers.BackendV1.md index 2f086183dfb..a7567e81d17 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `ABC` @@ -62,7 +62,7 @@ default values set -`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1.configuration()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -80,7 +80,7 @@ the configuration for the backend. -`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1.name()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the backend name. @@ -98,7 +98,7 @@ str -`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -116,7 +116,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1.provider()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -134,7 +134,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`abstract BackendV1.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Run on the backend. @@ -159,7 +159,7 @@ The job object for the run -`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -179,7 +179,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.43/qiskit.providers.BackendV2.md index 40f4b7175ac..e4c43f5efe1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `ABC` @@ -47,7 +47,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -71,7 +71,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -101,7 +101,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -125,7 +125,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -149,7 +149,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -177,7 +177,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`abstract BackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Run on the backend. @@ -202,7 +202,7 @@ The job object for the run -`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`BackendV2.set_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.md index 50ba09e08ed..447baef5622 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.43/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -46,7 +46,7 @@ Initialize a BackendV2 converter instance based on a BackendV1 instance. -`BackendV2Converter.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Return the acquisition channel for the given qubit. @@ -70,7 +70,7 @@ The Qubit measurement acquisition line. -`BackendV2Converter.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Return the secondary drive channel for the given qubit @@ -100,7 +100,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2Converter.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Return the drive channel for the given qubit. @@ -124,7 +124,7 @@ The Qubit drive channel -`BackendV2Converter.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Return the measure stimulus channel for the given qubit. @@ -176,7 +176,7 @@ qubit\_properties -`BackendV2Converter.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`BackendV2Converter.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.Job.md b/docs/api/qiskit/0.43/qiskit.providers.Job.md index 6809dd8727a..ecb65572265 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.43/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobError.md b/docs/api/qiskit/0.43/qiskit.providers.JobError.md index c411332a939..826e5aabe06 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.43/qiskit.providers.JobError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.JobError -`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") +`JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.43/qiskit.providers.JobStatus.md index 20e6526af19..80eb7bf8e3f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.43/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/jobstatus.py "view source code") +`JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/jobstatus.py "view source code") Bases: `Enum` diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.md index bd07bdc68b2..624ac8a851e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.43/qiskit.providers.JobTimeoutError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") +`JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.43/qiskit.providers.JobV1.md b/docs/api/qiskit/0.43/qiskit.providers.JobV1.md index 35add7a8075..97cb6c61c1b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.43/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `ABC` @@ -34,7 +34,7 @@ Initializes the asynchronous job. -`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -48,7 +48,7 @@ Return the backend where this job was executed. -`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.cancel()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -58,7 +58,7 @@ Attempt to cancel the job. -`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.cancelled()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -72,7 +72,7 @@ bool -`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.done()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -86,7 +86,7 @@ bool -`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.in_final_state()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -100,7 +100,7 @@ bool -`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.job_id()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -114,7 +114,7 @@ str -`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`abstract JobV1.result()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return the results of the job. @@ -124,7 +124,7 @@ Return the results of the job. -`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.running()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -138,7 +138,7 @@ bool -`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`abstract JobV1.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -148,7 +148,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`abstract JobV1.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -158,7 +158,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.43/qiskit.providers.Options.md b/docs/api/qiskit/0.43/qiskit.providers.Options.md index 80b5b5ff2ec..a28b72d8a37 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.43/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/options.py "view source code") +`Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/options.py "view source code") Bases: `Mapping` @@ -88,7 +88,7 @@ ValueError: ... -`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/options.py "view source code") +`Options.set_validator(field, validator_value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -117,7 +117,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/options.py "view source code") +`Options.update_options(**fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.43/qiskit.providers.Provider.md b/docs/api/qiskit/0.43/qiskit.providers.Provider.md index b4b296687f8..8c130c07eb8 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.43/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") +`Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.md index 350e5e4be6d..19c6d0c45ee 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.43/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") +`ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `ABC` @@ -24,7 +24,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") +`abstract ProviderV1.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -49,7 +49,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") +`ProviderV1.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.md index 24be6e41217..32787e6a9e9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.43/qiskit.providers.QiskitBackendNotFoundError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") +`QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.md index 5d46537785a..b686146f842 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.43/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") +`QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.md index 2290f2c9fad..eeaf9774d42 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/exceptions.py "view source code") +`BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.md index 2f1f9ed4dc0..b9d729797ab 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -108,7 +108,7 @@ str -`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.result(timeout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -140,7 +140,7 @@ bool -`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.status()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -158,7 +158,7 @@ The current JobStatus -`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") +`BasicAerJob.submit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.md index 17e936e24eb..63699483ed2 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.backends(name=None, filters=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -49,7 +49,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`BasicAerProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.md index 7ad29cefa3e..98422338702 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -130,7 +130,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -173,7 +173,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`QasmSimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 6c2de89eda2..985a350dc47 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.md index d096e273159..47488a59cc0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.43/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -130,7 +130,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run(qobj, **backend_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -180,7 +180,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`UnitarySimulatorPy.run_experiment(experiment)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.43/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.43/qiskit.providers.convert_to_target.md index e076230c0d5..b252534690a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.43/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") +`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 36278b5650e..12fddb625e3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `FakeBackend` @@ -60,7 +60,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -88,7 +88,7 @@ str -`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`ConfigurableFakeBackend.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.md index 691a1ffc381..ba517461e14 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `FakeBackend` @@ -44,7 +44,7 @@ the configuration for the backend. -`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -72,7 +72,7 @@ str -`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_1q.py "view source code") +`Fake1Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.md index 228d00940ba..c0b78784262 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.md index 66657cc512c..592e6bc9c3a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.md index 66fde80ca5c..a3c78f69701 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.md index 985d43a8df7..50009f972d3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.md index 49c4facd67a..9befd9e906f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.md index 9fd45725545..334da854b33 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.md index bf6ce75c856..a9484937363 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.md index 872ab1c9415..eb04a1a3587 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -169,7 +169,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackend5QV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.md index f304d49e430..51377304868 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -169,7 +169,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`FakeBackendV2.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.md index 67b7de5cfb6..88ddbf36374 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.md index c94213013e6..f3b9cf0204d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.md index ff2745e6b45..511176828d5 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 364b01ff3e3..1a67a4edfcd 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.md index 751df807087..86071b4a703 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.md index cc607bff407..ba8ce08ca21 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.md index e7f4b0e2e07..95c3cdfc56b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.md index 095a14982cd..3e95cbefbd9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.md index e4610bf356a..c14fbbc95af 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.md index 1852e22cfba..e0d12c9df3a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.md index 5468157f4d9..00d5f987920 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.md index f9008883cac..5c4e88f0ced 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.md index 261dfa584eb..cfa9684bb24 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.md index 0aa3b8dd045..6f6c7cb6f6a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.md index 718d98f1139..ae5a9a6444b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.md index 1c08106c641..1cab27e7403 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.md index af178cf12c4..957f4393710 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.md index af1dfc60012..4087abf2b55 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.md index 38702744737..7700ab116b6 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.md index 7016fffc692..46ca13be0a8 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.md index df74e6e6464..9d57aa72c1c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.md index fd0acaa4e7d..612effb8f0a 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.md index 7da6b126a1d..63302693e1f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.md index 84847de5359..4d2e51d4b79 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.md index c3e1187d5f1..f97c810d6cc 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.md index b4a02cbbd1f..69329c12fdc 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.md index a68ad2e940d..d3cf48fb901 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.md index 435f79b5939..32970a35721 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.md index 7dff94128da..5d34212b049 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.md index 28eec8af7f6..6363b69643d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.md index e7514a8a1b5..8d149ea362d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.md index 1bc1a749cf9..8c7f387b80c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.md index 9e8527551be..20c810d2751 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.md index c7797856ce7..2d3f5f97797 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.md index 60895f2d1c9..0524bb5c90e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.md index f0d692bc32e..fedbe4ed968 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.md index 54819302f23..5c40b1c8068 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.md index b6a7e1213bc..2ec6d63d249 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.md index c960e9e2a90..fbf40b446a9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.md index 61a5e6549b6..10a6ca86705 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `FakeBackend` @@ -66,7 +66,7 @@ str -`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.md index 227a7784ad6..2903c352bb9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.md index 6e302b8944f..f70026e89fc 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.md index 1beb5ccf052..c0c9b240bf7 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.md index fa1ccd5b7cc..45775abce6d 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index 0f7d24d7a27..074dca1270c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -141,7 +141,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.qubit_properties(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -169,7 +169,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`FakeMumbaiFractionalCX.run(run_input, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.md index 7cce7c1ea88..d64fddefafe 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.md index fa859dba579..64762539ee1 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.md index 3fa7a247923..7eced74dd49 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 126c7ce803b..f1002885392 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `FakeBackend` @@ -49,7 +49,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -77,7 +77,7 @@ str -`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`FakeOpenPulse2Q.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index 3327ad4cad4..ceb920fea26 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `FakeBackend` @@ -49,7 +49,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`FakeOpenPulse3Q.defaults()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.md index e5698a3ac74..8255a546a92 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.md index 446bc21fef4..351b2467d31 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.md index 701562b6735..887d3ca9037 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.md index cfb69b4890b..54078a8a104 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.md index 2563bbdac49..ee31128787c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.md index 2aecf6a17af..090ef9d0168 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.md index e31d67f6beb..059ffcb076c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `FakeBackend` @@ -70,7 +70,7 @@ str -`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 844b5a0f892..6302ffc327f 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.md index cf0ebb82661..eef05609566 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.md index 01a68265c60..191385a0fc2 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -26,7 +26,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -51,7 +51,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProvider.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index b6862e1256d..56a30c4d7f3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -26,7 +26,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.backends(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -51,7 +51,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.md index 6a95c56449c..ff71a56c1e0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `FakeBackend` @@ -67,7 +67,7 @@ str -`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`FakeQasmSimulator.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.md index f76ace2b325..c84a6af9280 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.md index 52c3d984172..9e32ebc7fa8 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.md index 2c5a8916fa6..b56513b2ea9 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.md index 3fdcacf0a8f..0ab81dad6c3 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.md index 8231b10ffb8..d562a5e4f84 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.md index e54a8ab67a1..e74ac6889cc 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.md index 6579a495737..62b07fb4734 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.md index 11b358264ac..39b4b5199fe 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.md index 7f27a1456f9..b72b6d92a97 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.md index d078cca1d5b..9eaa7cc6e02 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.md index 21a2e9638d7..f70437f49ff 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.md index 6aa0c8eda90..847f4be34a0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.md index 6f8f9b774c3..5e4291ca441 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.md index 7e69bb95572..1f1651af065 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.md index 789fda9d1a3..971a405ee56 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `FakeBackend` @@ -68,7 +68,7 @@ str -`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.md index 335720afc08..607cbcac679 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `FakeBackend` @@ -70,7 +70,7 @@ str -`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo.properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.md index 54ebe095e2c..dc7e3efdc2c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.md index 8b22f8247c8..856ac5735b2 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.md index 95a3738c224..67deac541b4 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.md index cf0a2da1633..3f7b875ae72 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.md index b0b1e4fd2fe..063de0fa5b4 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.md index df63e32cfcf..fb408761e43 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.md index 9542bc2fdf0..140147ca24b 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.md index abca13cd5bf..4f4245cce6e 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.md index eee911d4361..41a4ca777d4 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.md index d46e32e8ad0..bdd059bec05 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.43/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.md index 9ed30ebf81a..784c70f96a0 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.md index b8cfa30aaad..64c086b3746 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_gates()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -48,7 +48,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.faulty_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -58,7 +58,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.frequency(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -80,7 +80,7 @@ float -`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`classmethod BackendProperties.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -104,7 +104,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_error(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -127,7 +127,7 @@ float -`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_length(gate, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -150,7 +150,7 @@ float -`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.gate_property(gate, qubits=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -178,7 +178,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_gate_operational(gate, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -201,7 +201,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.is_qubit_operational(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -223,7 +223,7 @@ bool -`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.qubit_property(qubit, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -250,7 +250,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_error(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -272,7 +272,7 @@ float -`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.readout_length(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -294,7 +294,7 @@ float -`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t1(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -316,7 +316,7 @@ float -`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.t2(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -338,7 +338,7 @@ float -`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") +`BackendProperties.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.md index d501fc31228..9cfadff98ad 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendstatus.py "view source code") +`classmethod BackendStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -60,7 +60,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendstatus.py "view source code") +`BackendStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.Command.md b/docs/api/qiskit/0.43/qiskit.providers.models.Command.md index 5909bf2b5ed..262c5ffd99c 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") +`Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod Command.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -63,7 +63,7 @@ qiskit.providers.model.Command -`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") +`Command.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.md index e57fc198512..8a8eff04e81 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -54,7 +54,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod GateConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -76,7 +76,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`GateConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.md index 2015ea29551..bb2a1bc5313 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -54,7 +54,7 @@ str -`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/jobstatus.py "view source code") +`classmethod JobStatus.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -78,7 +78,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/jobstatus.py "view source code") +`JobStatus.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.md index 4f38a592b1a..ea784e5da45 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -68,7 +68,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.acquire(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -90,7 +90,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.control(qubits=None, channel=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -121,7 +121,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.describe(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -161,7 +161,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.drive(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -183,7 +183,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod PulseBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -205,7 +205,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_channel_qubits(channel)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -227,7 +227,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.get_qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -249,7 +249,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.measure(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -271,7 +271,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`PulseBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.md index d17b04c4558..38959ecd453 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Validate and reformat transport layer inputs to initialize. :param qubit\_freq\_ -`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") +`classmethod PulseDefaults.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -48,7 +48,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") +`PulseDefaults.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.md index 16e3eef6d79..61286fa1c58 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -162,7 +162,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod QasmBackendConfiguration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -184,7 +184,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`QasmBackendConfiguration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.md index 80f967a9cf6..3cfbf1032cf 100644 --- a/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.43/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`classmethod UchannelLO.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -69,7 +69,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") +`UchannelLO.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.md index e2870055831..3c7cf6db3cb 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.assert_has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -74,7 +74,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -101,7 +101,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.get_parameters(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -124,7 +124,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -147,7 +147,7 @@ bool -`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.has_custom_gate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -161,7 +161,7 @@ bool -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -186,7 +186,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubit_instructions(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -210,7 +210,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.qubits_with_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -236,7 +236,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") +`InstructionScheduleMap.remove(instruction, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.43/qiskit.pulse.Schedule.md index 9b0ac52160a..0267298ac39 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -75,7 +75,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.append(schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -100,7 +100,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -123,7 +123,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -141,7 +141,7 @@ int -`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_start_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -159,7 +159,7 @@ int -`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.ch_stop_time(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -225,7 +225,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -252,7 +252,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -277,7 +277,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -301,7 +301,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`classmethod Schedule.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -328,7 +328,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.insert(start_time, schedule, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -349,7 +349,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -363,7 +363,7 @@ bool -`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.replace(old, new, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -426,7 +426,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`Schedule.shift(time, name=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.md index 924513375bf..51d7dea5a45 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -168,7 +168,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.append(block, name=None, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -196,7 +196,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_parameters(value_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -223,7 +223,7 @@ Schedule with updated parameters. -`ScheduleBlock.assign_references(subroutine_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.assign_references(subroutine_dict, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Assign schedules to references. @@ -285,7 +285,7 @@ Schedule block with assigned subroutine. -`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.ch_duration(*channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -351,7 +351,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -386,7 +386,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -419,7 +419,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.get_parameters(parameter_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -461,7 +461,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`classmethod ScheduleBlock.initialize_from(other_program, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -488,7 +488,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -502,7 +502,7 @@ bool -`ScheduleBlock.is_referenced()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_referenced()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return True iff the current schedule block contains reference to subroutine. @@ -516,7 +516,7 @@ bool -`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.is_schedulable()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -530,7 +530,7 @@ bool -`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.replace(old, new, inplace=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -554,7 +554,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.scoped_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.scoped_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Return unassigned parameters with scoped names. @@ -572,7 +572,7 @@ Return unassigned parameters with scoped names. -`ScheduleBlock.search_parameters(parameter_regex)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") +`ScheduleBlock.search_parameters(parameter_regex)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/schedule.py "view source code") Search parameter with regular expression. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire.md index a529bd2ad23..c4ce9f195e7 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire_channel.md index 6ec8f52ae60..f40cf1c9cc3 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.acquire_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.acquire_channel -`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.active_backend.md index 6d35added76..f1c453b02e6 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.active_backend.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.active_backend -`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 4a2829b54bf..df99056050a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings -`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.active_transpiler_settings.md index 64d53992865..d4150adef51 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.active_transpiler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.active_transpiler_settings -`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_equispaced.md index e119337a1ab..fa0fa6324a9 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_equispaced.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_equispaced -`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_func.md index dc272d692c8..3044732e4a6 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_func.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_func -`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_left.md index a07c12206ed..7318db09a34 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_left.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_left -`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_right.md index f0c18601a84..b9290ddc281 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_right.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_right -`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_sequential.md index 1ae6621536e..c5060af52b6 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.align_sequential.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.align_sequential -`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.barrier.md index d291d1768eb..57606020823 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.barrier.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.build.md index f88e34141f5..26d48c59a63 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.build.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.call.md index 15da25492e1..6297a478038 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.call.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.circuit_scheduler_settings.md index b8ab32fe4b8..c59588f33ca 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.circuit_scheduler_settings -`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.control_channels.md index a6d9e4acb18..98cc116de65 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.control_channels.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.control_channels -`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.cx.md index 86578cf4042..3257ff97c63 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.cx.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.cx -`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.delay.md index 55bf5c665a2..4ef26cabe93 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.delay.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.delay -`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.delay_qubits.md index 2e5774700a4..5b8ae4c32ec 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.delay_qubits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.delay_qubits -`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.drive_channel.md index e4fbc405737..070e8149502 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.drive_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.drive_channel -`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.frequency_offset.md index b8e3fa28767..cd9551b6327 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.frequency_offset.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.frequency_offset -`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.measure.md index cdacf5fdff5..198e849c69c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.measure.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.measure -`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_all.md index 637fea73445..079596cad20 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_all.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.measure_all -`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_channel.md index a6f44fb4315..c10388339b3 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.measure_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.measure_channel -`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.num_qubits.md index ac250883d9d..d9df9427510 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.num_qubits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.num_qubits -`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.phase_offset.md index 8d8f14f5241..c8715c1eb1c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.phase_offset.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.phase_offset -`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.play.md index 1ef08d445ea..ea5a6ea655f 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.play.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.play -`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.qubit_channels.md index ab0a7546aa8..555f76a040e 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.qubit_channels.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.qubit_channels -`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.reference.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.reference.md index 4577a4ff744..a7a532b0d95 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.reference.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.reference.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.reference -`reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.samples_to_seconds.md index c91b18989a5..cacbbbba7d6 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.samples_to_seconds.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.samples_to_seconds -`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.seconds_to_samples.md index 51ab8a96420..d2ca6f6c339 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.seconds_to_samples.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.seconds_to_samples -`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.set_frequency.md index 8a1d3262a16..3a9f78c3b37 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.set_frequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.set_frequency -`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.set_phase.md index 6db16eb87c9..f59e3c8e7ae 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.set_phase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.set_phase -`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_frequency.md index b3823c87103..2532329213f 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_frequency.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.shift_frequency -`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_phase.md index 9551b18891a..24511625532 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.shift_phase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.shift_phase -`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.snapshot.md index a03ff1d948c..09fa574b3fc 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.snapshot.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.transpiler_settings.md index 513e4d16a1f..2796db97faf 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.transpiler_settings.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.transpiler_settings -`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.u1.md index 4d2ed5807e1..7a554477da1 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.u1.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.u1 -`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.u2.md index 0c7f9b3103d..2c4488f0b96 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.u2.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.u3.md index b1d837f56e5..efd9d359d6b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.u3.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.43/qiskit.pulse.builder.x.md index e2b40482195..4e0e68e42a8 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.builder.x.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.builder.x -`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") +`x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.md index 72ae8b32ffb..9dc93709807 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`AcquireChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.md index 8c1957a9c5c..b8551481838 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`ControlChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.md index d4a2e074d4b..ab4573f00fe 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`DriveChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.md index 5dcfee423fa..9485511f296 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`MeasureChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.md index dfd77c83356..2ddb2593d62 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`MemorySlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.md index c00889d290b..bdb292855b9 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`RegisterSlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.md index 69bca3bbace..91dab206afa 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") +`SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.md index a7343c0c7f0..434fa40ea99 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -180,7 +180,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/acquire.py "view source code") +`Acquire.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.md index 3a48ac95ba7..b34e42d7c3c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/call.py "view source code") +`Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/call.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -65,7 +65,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/call.py "view source code") +`Call.assigned_subroutine()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.md index d4c82160c83..b2916124619 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/delay.py "view source code") +`Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/delay.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.md index 3d3d4f49169..ba80f218f7c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/play.py "view source code") +`Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/play.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.md index 79f82063ebe..82e1f924c4b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/reference.py "view source code") +`Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/reference.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.md index 2e1ad5d4486..e38f6f0fb8d 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/directives.py "view source code") +`RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.md index 5726ae48fa5..8b733628df2 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/frequency.py "view source code") +`SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.md index f09fbea0e46..6c69ddeb448 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/phase.py "view source code") +`SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.md index 0d8d5c04e6a..86583524bda 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/frequency.py "view source code") +`ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.md index dffb05ad207..7707d799cdf 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/phase.py "view source code") +`ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.md index da2c858ae85..3d0bc2bdd19 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -170,7 +170,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/snapshot.py "view source code") +`Snapshot.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.md index 3124040c05c..0ae7668bdb0 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/directives.py "view source code") +`TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.md index 7326f975e48..ce3ab70a027 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`Constant(duration, amp, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Constant(duration, amp, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Cos_class.rst.md index 6a92f32d810..21b1a2e766f 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") A cosine pulse. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.md index 4612d566326..b6bf8d168db 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.md index 9cc172faa06..f331636c459 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquareDrag.md index 984edeeb5c2..2aafa23545f 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.md index 44b5c1576ae..b7b99b7b35a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.md index 5a0f3898214..0feb20f3885 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `Pulse` @@ -80,7 +80,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -94,7 +94,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") +`ParametricPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -108,7 +108,7 @@ bool -`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") +`abstract ParametricPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Sawtooth_class.rst.md index 82eca8ac82f..8aeb4fc7833 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") A sawtooth pulse. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Sin_class.rst.md index 0eb8e2858ab..006740f0f2d 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") A sinusoidal pulse. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.md index 99304211d34..372b8aec66b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `Pulse` @@ -163,7 +163,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.get_waveform()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -192,7 +192,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -206,7 +206,7 @@ bool -`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`SymbolicPulse.validate_parameters()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Triangle_class.rst.md index ae963a67984..508868801e0 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") +`Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/symbolic_pulses.py "view source code") A triangle pulse. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.md index 7a81c30650d..eda8aea807e 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/waveform.py "view source code") +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/waveform.py "view source code") Bases: `Pulse` @@ -73,7 +73,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/waveform.py "view source code") +`Waveform.is_parameterized()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.constant.md b/docs/api/qiskit/0.43/qiskit.pulse.library.constant.md index f738f6ca12c..4a71815962b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.constant.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.constant.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.constant -`constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.43/qiskit.pulse.library.cos.md index 1b6b1e7d152..555632f5028 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.cos.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.drag.md b/docs/api/qiskit/0.43/qiskit.pulse.library.drag.md index 5f6345f315d..a8e2e34d6db 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.drag.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.drag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.drag -`drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian.md b/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian.md index 60384e63148..c4164483c5d 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian -`gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_deriv.md index 7e806de157c..5ad8edfb692 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_deriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_deriv -`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_square.md index 4df1f547cf7..8491dc3f8bf 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.gaussian_square.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.43/qiskit.pulse.library.sawtooth.md index 974b9e2ebcc..d78829bb9ee 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.sawtooth.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.43/qiskit.pulse.library.sech.md index a72f2a83af0..53620558eae 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.sech.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.43/qiskit.pulse.library.sech_deriv.md index 74326b32178..467f83af724 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.sech_deriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.sech_deriv -`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.43/qiskit.pulse.library.sin.md index 30eace212f4..a0d87411dff 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.sin.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.square.md b/docs/api/qiskit/0.43/qiskit.pulse.library.square.md index 16b183eb54d..d8acaa2fa73 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.square.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.43/qiskit.pulse.library.triangle.md index be85314bd30..7a360be4a4c 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.triangle.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.43/qiskit.pulse.library.zero.md index 7666ecf30f3..9dba2f6c53e 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.library.zero.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.zero -`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") +`zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.md index f7f69071cab..69f2f599b4a 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -32,7 +32,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -56,7 +56,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignEquispaced.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.md index 1e04940d552..44318d93904 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -46,7 +46,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -70,7 +70,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignFunc.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.md index 9db369ab5b8..cd2ccb49a64 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -28,7 +28,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignLeft.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.md index 90b196db743..82abd33fac4 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -28,7 +28,7 @@ Create new right-justified context. -`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignRight.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.md index 458d5c147e2..4e2be780b38 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -28,7 +28,7 @@ Create new sequential context. -`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") +`AlignSequential.align(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.add_implicit_acquires.md index f82922dd418..59012147583 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.add_implicit_acquires.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.add_implicit_acquires -`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.align_measures.md index 15d1df96835..1adf4b08441 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.align_measures.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.align_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_dag.md index 47d08478261..9ea78d56d71 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_dag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.block_to_dag -`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/dag.py "view source code") +`block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_schedule.md index a06336179e8..e1ef52a8c0b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.block_to_schedule.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.block_to_schedule -`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.compress_pulses.md index c2eab84ecfd..60a7dced44b 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.compress_pulses.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.compress_pulses -`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.flatten.md index 63791976e6d..4b5248700b9 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.flatten.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.flatten -`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.inline_subroutines.md index ecf195de21b..8b24a3a0453 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.inline_subroutines.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.inline_subroutines -`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.pad.md index 621d1e26310..5fb3b53cf82 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.pad.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_directives.md index 76a51f902b3..62e4b22bd7e 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_directives.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.remove_directives -`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_trivial_barriers.md index 681fc0925e8..709d55cb3cc 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.remove_trivial_barriers -`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") +`remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.43/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.43/qiskit.pulse.transforms.target_qobj_transform.md index 2260ff11482..8dd7c7e04ff 100644 --- a/docs/api/qiskit/0.43/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.43/qiskit.pulse.transforms.target_qobj_transform.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.transforms.target_qobj_transform -`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/base_transforms.py "view source code") +`target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.43/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.43/qiskit.qasm.Qasm.md index 4b712cd1e09..37a0f9e3787 100644 --- a/docs/api/qiskit/0.43/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.43/qiskit.qasm.Qasm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qasm.Qasm -`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") +`Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") +`Qasm.generate_tokens()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -36,7 +36,7 @@ Returns a generator of the tokens. -`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") +`Qasm.parse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -46,7 +46,7 @@ Parse the data. -`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") +`Qasm.return_filename()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.43/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.43/qiskit.qasm.QasmError.md index bfd0c3886d3..407d31de28e 100644 --- a/docs/api/qiskit/0.43/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.43/qiskit.qasm.QasmError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qasm.QasmError -`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/exceptions.py "view source code") +`QasmError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.md index d5f4135773b..363f2ae26c6 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod GateCalibration.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -55,7 +55,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`GateCalibration.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.md index 1118ecd1a3b..c6ba474d0d4 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseLibraryItem.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -53,7 +53,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseLibraryItem.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.md index 78e12ccba24..69cd882242c 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -57,7 +57,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.md index 823130575cc..146b8784753 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` @@ -41,7 +41,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -63,7 +63,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.md index 0fcc162557f..3a96cd0eaf9 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -56,7 +56,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.md index 68c1692fa6b..ccac99387a4 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.md index cd40414c40a..bad1e56fc98 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod PulseQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -68,7 +68,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`PulseQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.md index 709bfa5ab42..cee79e3ee9f 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmExperimentCalibrations.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -52,7 +52,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmExperimentCalibrations.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.md index 10a7b9893b2..49e1dc4d2c6 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobj.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -57,7 +57,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobj.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.md index 8f4fc53d37c..55fedcc50a3 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `SimpleNamespace` @@ -43,7 +43,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -65,7 +65,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.md index 35162675b35..8302dc3320c 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperiment.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -56,7 +56,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperiment.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.md index 3221b5d9116..31fca24bf4b 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `QobjDictField` @@ -31,7 +31,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjExperimentConfig.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -53,7 +53,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjExperimentConfig.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.md index 3caac1341c5..299249120ad 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -41,7 +41,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`classmethod QasmQobjInstruction.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -63,7 +63,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") +`QasmQobjInstruction.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.43/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.43/qiskit.qobj.Qobj.md index ddc6f26ba4e..41e9db13e76 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/__init__.py "view source code") +`Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/__init__.py "view source code") Bases: [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.md index ddda215f53c..868d80698e7 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/common.py "view source code") +`QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/common.py "view source code") Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.md index 002b0b82a55..1de5210add4 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/common.py "view source code") +`QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/common.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.md index be9af7c4d87..38812c29a65 100644 --- a/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.43/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`classmethod QobjMeasurementOption.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -53,7 +53,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") +`QobjMeasurementOption.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.43/qiskit.qpy.dump.md b/docs/api/qiskit/0.43/qiskit.qpy.dump.md index 4e3dab380d0..30ecfa39908 100644 --- a/docs/api/qiskit/0.43/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.43/qiskit.qpy.dump.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qpy/interface.py "view source code") +`dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.43/qiskit.qpy.load.md b/docs/api/qiskit/0.43/qiskit.qpy.load.md index 8a7a774d371..3c8dc92aff2 100644 --- a/docs/api/qiskit/0.43/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.43/qiskit.qpy.load.md @@ -12,7 +12,7 @@ python_api_name: qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qpy/interface.py "view source code") +`load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.md index e38ba5311e1..6338e8bafc9 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `BaseOperator`, `AdjointMixin` @@ -81,7 +81,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -91,7 +91,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -125,7 +125,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -172,7 +172,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -270,7 +270,7 @@ BaseOperator -`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -298,7 +298,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -321,7 +321,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -331,7 +331,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -341,7 +341,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -351,7 +351,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`CNOTDihedral.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.md index 9dcc97d586a..6faf62c053b 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `QuantumChannel` @@ -54,7 +54,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -102,7 +102,7 @@ The composed Chi. -`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -153,7 +153,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -295,7 +295,7 @@ BaseOperator -`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -357,7 +357,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") +`Chi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.md index 6ee38887527..7d5bf0a440c 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `QuantumChannel` @@ -76,7 +76,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -110,7 +110,7 @@ The composed Choi. -`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -161,7 +161,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -303,7 +303,7 @@ BaseOperator -`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -365,7 +365,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") +`Choi.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.md index bf33e5d702b..956aae60776 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -77,7 +77,7 @@ Initialize an operator object. -`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -121,7 +121,7 @@ The composed Clifford. -`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -131,7 +131,7 @@ Return the conjugate of the Clifford. -`Clifford.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Make a deep copy of current operator. @@ -168,7 +168,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -192,7 +192,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_circuit(circuit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -218,7 +218,7 @@ the Clifford object for the instruction. -`classmethod Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_dict(obj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -228,7 +228,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`static Clifford.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -280,7 +280,7 @@ The labels correspond to the single-qubit Cliffords are -`classmethod Clifford.from_matrix(matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_matrix(matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Create a Clifford from a unitary matrix. @@ -308,7 +308,7 @@ the Clifford object for the unitary matrix. -`classmethod Clifford.from_operator(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`classmethod Clifford.from_operator(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Create a Clifford from a operator. @@ -346,7 +346,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.is_unitary()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -420,7 +420,7 @@ BaseOperator -`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -448,7 +448,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_circuit()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -473,7 +473,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -483,7 +483,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -493,7 +493,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_labels(array=False, mode='B')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_labels(array=False, mode='B')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert a Clifford to a list Pauli (de)stabilizer string labels. @@ -533,7 +533,7 @@ list or array -`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -543,7 +543,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -553,7 +553,7 @@ Convert to an Operator object. -`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`Clifford.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.md index bdda023de75..1ca3b989881 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `QuantumState`, `TolerancesMixin` @@ -42,7 +42,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -72,7 +72,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -109,7 +109,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -136,7 +136,7 @@ QuantumState -`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -162,7 +162,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -185,7 +185,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -213,7 +213,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`static DensityMatrix.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -243,7 +243,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`classmethod DensityMatrix.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -278,7 +278,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -314,7 +314,7 @@ tuple -`DensityMatrix.partial_transpose(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.partial_transpose(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return partially transposed density matrix. @@ -336,7 +336,7 @@ The partially transposed density matrix. -`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -438,7 +438,7 @@ dict -`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -448,7 +448,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -474,7 +474,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -562,7 +562,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -588,7 +588,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -668,7 +668,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -678,7 +678,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.to_statevector(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -707,7 +707,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") +`DensityMatrix.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.md index 322e7a58913..c01f8df55e7 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `QuantumChannel` @@ -58,7 +58,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -106,7 +106,7 @@ The composed Kraus. -`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -157,7 +157,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -201,7 +201,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -299,7 +299,7 @@ BaseOperator -`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -361,7 +361,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`Kraus.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.md index 3a98a6f6c97..8a6fa214e29 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -54,7 +54,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -76,7 +76,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.angles_and_phase(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. @@ -98,7 +98,7 @@ tuple -`OneQubitEulerDecomposer.build_circuit(gates, global_phase)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`OneQubitEulerDecomposer.build_circuit(gates, global_phase)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the circuit or dag object from a list of gates. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.md index 116e0ef5a8f..def801a7757 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Bases: `LinearOp` @@ -62,7 +62,7 @@ Return the adjoint of the Operator. -`Operator.apply_permutation(perm, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.apply_permutation(perm, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Modifies operator’s data by composing it with a permutation. @@ -89,7 +89,7 @@ The modified operator. -`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -123,7 +123,7 @@ The composed Operator. -`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -170,7 +170,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -194,7 +194,7 @@ bool -`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -218,7 +218,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -247,7 +247,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`classmethod Operator.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -287,7 +287,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -307,7 +307,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -361,7 +361,7 @@ BaseOperator -`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -381,7 +381,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -409,7 +409,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -419,7 +419,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to NumPy matrix. @@ -429,7 +429,7 @@ Convert operator to NumPy matrix. -`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -439,7 +439,7 @@ Convert operator to matrix operator class -`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") +`Operator.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.md index fe74ce6b675..12d8f603f0f 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `QuantumChannel` @@ -62,7 +62,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -76,7 +76,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -110,7 +110,7 @@ The composed PTM. -`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -161,7 +161,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -303,7 +303,7 @@ BaseOperator -`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -365,7 +365,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`PTM.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.md index aeba2b9e63b..62b498c66e7 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `BasePauli` @@ -118,7 +118,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -128,7 +128,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -151,7 +151,7 @@ bool -`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -174,7 +174,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -209,7 +209,7 @@ The composed Pauli. -`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -229,7 +229,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.delete(qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -255,7 +255,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -279,7 +279,7 @@ The operator self \* other. -`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -301,7 +301,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Performs either Heisenberg (default) or Schrödinger picture evolution of the Pauli by a Clifford and returns the evolved Pauli. @@ -336,7 +336,7 @@ the Pauli $C^\dagger.P.C$ (Heisenberg picture) or the Pauli $C.P.C^\dagger$ (Sch -`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -370,7 +370,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.insert(qubits, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -397,7 +397,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -471,7 +471,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`classmethod Pauli.set_truncation(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -489,7 +489,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -517,7 +517,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_instruction()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -527,7 +527,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_label()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -549,7 +549,7 @@ str -`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -571,7 +571,7 @@ array -`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`Pauli.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.md index 1bb9253cb04..09afa6ed332 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `BasePauli`, `LinearMixin`, `GroupMixin` @@ -112,7 +112,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -122,7 +122,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return `True` if other Pauli that anticommutes with other. @@ -145,7 +145,7 @@ bool -`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -169,7 +169,7 @@ array -`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.argsort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -194,7 +194,7 @@ array -`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -217,7 +217,7 @@ bool -`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute `other`. @@ -241,7 +241,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.compose(other, qargs=None, front=False, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -270,7 +270,7 @@ the list of composed Paulis. -`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -290,7 +290,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -319,7 +319,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.dot(other, qargs=None, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -347,7 +347,7 @@ the list of composed Paulis. -`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -371,7 +371,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.evolve(other, qargs=None, frame='h')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Performs either Heisenberg (default) or Schrödinger picture evolution of the Pauli by a Clifford and returns the evolved Pauli. @@ -405,7 +405,7 @@ the Pauli $C^\dagger.P.C$ (Heisenberg picture) or the Pauli $C.P.C^\dagger$ (Sch -`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -431,7 +431,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`classmethod PauliList.from_symplectic(z, x, phase=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -455,7 +455,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -488,7 +488,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.group_qubit_wise_commuting()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -516,7 +516,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Paulis into the table. @@ -546,7 +546,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.inverse()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -556,7 +556,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -576,7 +576,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -664,7 +664,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.sort(weight=False, phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -729,7 +729,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -755,7 +755,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -786,7 +786,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -818,7 +818,7 @@ list -`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -828,7 +828,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`PauliList.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.md index b01cd75a3f9..431449d2061 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `BaseOperator`, `AdjointMixin` @@ -105,7 +105,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.anticommutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -129,7 +129,7 @@ array -`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -153,7 +153,7 @@ array -`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes(pauli)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -181,7 +181,7 @@ array -`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.commutes_with_all(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -205,7 +205,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.compose(other, qargs=None, front=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -249,7 +249,7 @@ the compose outer product table. -`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -269,7 +269,7 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -341,7 +341,7 @@ the dot outer product table. -`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -383,7 +383,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`classmethod PauliTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -420,7 +420,7 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. @@ -450,7 +450,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -470,7 +470,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -558,7 +558,7 @@ BaseOperator -`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -628,7 +628,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -670,7 +670,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -701,7 +701,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -733,7 +733,7 @@ list -`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -743,7 +743,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`PauliTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.md index a43de3466fe..8410f40860b 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_axis_rotation(angle, axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -51,7 +51,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`classmethod Quaternion.from_euler(angles, order='yzy')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -74,7 +74,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.norm()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -84,7 +84,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.normalize(inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -106,7 +106,7 @@ Normalized quaternion. -`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -124,7 +124,7 @@ ndarray -`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`Quaternion.to_zyz()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.md index 4335152b3fd..4139e4e6c1f 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `LinearOp` @@ -47,7 +47,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -81,7 +81,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -128,7 +128,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -162,7 +162,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -182,7 +182,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.power(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -232,7 +232,7 @@ BaseOperator -`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -260,7 +260,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -270,7 +270,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -280,7 +280,7 @@ Convert to an Operator object. -`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") +`ScalarOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.md index c6b1216f437..98e14147164 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `LinearOp` @@ -76,7 +76,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -86,7 +86,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return indices for sorting the rows of the table. @@ -158,7 +158,7 @@ array -`SparsePauliOp.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.assign_parameters(parameters, inplace=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bind the free `Parameter`s in the coefficients to provided values. @@ -181,7 +181,7 @@ A copy of the operator with bound parameters, if `inplace` is `False`, otherwise -`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.chop(tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -207,7 +207,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -241,7 +241,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -288,7 +288,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.equiv(other, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -311,7 +311,7 @@ bool -`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -335,7 +335,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_list(obj, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -375,7 +375,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -405,7 +405,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -454,7 +454,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.group_commuting(qubit_wise=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -501,7 +501,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.is_unitary(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -524,7 +524,7 @@ bool -`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -544,7 +544,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -632,7 +632,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.simplify(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -655,7 +655,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sort the rows of the table. @@ -730,7 +730,7 @@ a sorted copy of the original table. -`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`static SparsePauliOp.sum(ops)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -760,7 +760,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -788,7 +788,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_list(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -812,7 +812,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_matrix(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -834,7 +834,7 @@ array -`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -844,7 +844,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`SparsePauliOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.md index 5b3f7c9975a..4940546dc45 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `QuantumState` @@ -61,7 +61,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -91,7 +91,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.equiv(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if the two generating sets generate the same stabilizer group. @@ -113,7 +113,7 @@ bool -`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -141,7 +141,7 @@ the output stabilizer state. -`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -167,7 +167,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -194,7 +194,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -204,7 +204,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.measure(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -230,7 +230,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -255,7 +255,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.probabilities_dict(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -282,7 +282,7 @@ dict -`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -304,7 +304,7 @@ double -`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -359,7 +359,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.sample_memory(shots, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -398,7 +398,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -424,7 +424,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -434,7 +434,7 @@ Convert state to matrix operator class -`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`StabilizerState.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.md index fefbfbf2069..86aca0d3557 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `AdjointMixin` @@ -140,7 +140,7 @@ array -`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.argsort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -218,7 +218,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -283,7 +283,7 @@ Not implemented. -`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -293,7 +293,7 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.delete(ind, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. @@ -322,7 +322,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.dot(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -374,7 +374,7 @@ the dot outer product table. -`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -416,7 +416,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`classmethod StabilizerTable.from_labels(labels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -465,7 +465,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.insert(ind, value, qubit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. @@ -495,7 +495,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.label_iter()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -515,7 +515,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.matrix_iter(sparse=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -603,7 +603,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.sort(weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -678,7 +678,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -720,7 +720,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_labels(array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -755,7 +755,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.to_matrix(sparse=False, array=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -801,7 +801,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`StabilizerTable.unique(return_index=False, return_counts=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.md index e145e733bc6..acd34945b77 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Bases: `QuantumState`, `TolerancesMixin` @@ -42,7 +42,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -72,7 +72,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.draw(output=None, **drawer_args)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -126,7 +126,7 @@ sv.draw(output='hinton') -`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.equiv(other, rtol=None, atol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -154,7 +154,7 @@ bool -`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.evolve(other, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -181,7 +181,7 @@ the output quantum state. -`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -207,7 +207,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.expectation_value(oper, qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -230,7 +230,7 @@ complex -`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_instruction(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -258,7 +258,7 @@ The final statevector. -`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`static Statevector.from_int(i, dims)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -288,7 +288,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`classmethod Statevector.from_label(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -323,7 +323,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.inner(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -349,7 +349,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.is_valid(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -385,7 +385,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.probabilities(qargs=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -487,7 +487,7 @@ dict -`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.purity()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -497,7 +497,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reset(qargs=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -523,7 +523,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.reverse_qargs()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -611,7 +611,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -637,7 +637,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_dict(decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -710,7 +710,7 @@ print(psi.to_dict()) -`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.to_operator()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -724,7 +724,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") +`Statevector.trace()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.md index 0e5ac03bfb7..0cfcf57a868 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `QuantumChannel` @@ -74,7 +74,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -108,7 +108,7 @@ The composed Stinespring. -`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -159,7 +159,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -203,7 +203,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.is_cptp(atol=None, rtol=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -301,7 +301,7 @@ BaseOperator -`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -363,7 +363,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`Stinespring.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.md index 5d6b140276d..3206958744e 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `QuantumChannel` @@ -54,7 +54,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.adjoint()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.compose(other, qargs=None, front=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -102,7 +102,7 @@ The composed SuperOp. -`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.conjugate()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -153,7 +153,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.expand(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -295,7 +295,7 @@ BaseOperator -`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.tensor(other)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -357,7 +357,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") +`SuperOp.transpose()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 72b9ab0763e..6e12c5b527c 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`static TwoQubitBasisDecomposer.decomp0(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -41,7 +41,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp1(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -57,7 +57,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -75,7 +75,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -85,7 +85,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -95,7 +95,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`TwoQubitBasisDecomposer.traces(target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.md index db91bc6b6bc..af191dab16a 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -35,7 +35,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`XXDecomposer.num_basis_gates(unitary)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.md index 432853677b8..0fa27d05404 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Bases: `object` @@ -64,7 +64,7 @@ float -`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`Z2Symmetries.convert_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -86,7 +86,7 @@ This method operates the first part of the tapering. It converts the operator by -`classmethod Z2Symmetries.find_z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`classmethod Z2Symmetries.find_z2_symmetries(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Finds Z2 Pauli-type symmetries of a [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). @@ -104,7 +104,7 @@ A `Z2Symmetries` instance. -`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`Z2Symmetries.is_empty()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Check the z2\_symmetries is empty or not. @@ -122,7 +122,7 @@ bool -`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`Z2Symmetries.taper(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. Returns operator if the symmetry object is empty. @@ -148,7 +148,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`Z2Symmetries.taper_clifford(operator)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Operate the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.quantum_info.Z2Symmetries#convert_clifford "qiskit.quantum_info.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.anti_commutator.md b/docs/api/qiskit/0.43/qiskit.quantum_info.anti_commutator.md index abcbe8cd721..c8d090de2ad 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.anti_commutator.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.anti_commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.anti_commutator -`anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`anti_commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") Compute anti-commutator of a and b. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.43/qiskit.quantum_info.average_gate_fidelity.md index 54de01cbece..6c51d1bcf7e 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.average_gate_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.average_gate_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.commutator.md b/docs/api/qiskit/0.43/qiskit.quantum_info.commutator.md index 965a1771ced..59970579cc8 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.commutator.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.commutator -`commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/utils/commutator.py "view source code") Compute commutator of a and b. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.43/qiskit.quantum_info.concurrence.md index 72bb7a092fc..f455716baad 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.concurrence.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.concurrence -`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") +`concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.43/qiskit.quantum_info.decompose_clifford.md index 51f2d20a16d..91bb78002e1 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.decompose_clifford.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.decompose_clifford -`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.43/qiskit.quantum_info.diamond_norm.md index ee1434f4f1b..3bb9fbd4ea6 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.diamond_norm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.diamond_norm -`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") +`diamond_norm(choi, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.double_commutator.md b/docs/api/qiskit/0.43/qiskit.quantum_info.double_commutator.md index f2117cdca5e..1177bc19915 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.double_commutator.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.double_commutator.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.double_commutator -`double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`double_commutator(a, b, c, *, commutator=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") Compute symmetric double commutator of a, b and c. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.43/qiskit.quantum_info.entanglement_of_formation.md index 40278762aa6..ee9a6f120f3 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.entanglement_of_formation.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.entanglement_of_formation -`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") +`entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.43/qiskit.quantum_info.entropy.md index 520f4f71e0d..63746d6786f 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.entropy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.entropy -`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") +`entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.43/qiskit.quantum_info.gate_error.md index 733d8531e0d..230d4025bee 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.gate_error.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.gate_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") +`gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_distance.md index cc215555016..a1dab807143 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_distance.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.hellinger_distance -`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_fidelity.md index 7ee46d65ea7..2d6abd60f4e 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.hellinger_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.hellinger_fidelity -`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/distance.py "view source code") +`hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.43/qiskit.quantum_info.mutual_information.md index d48dd789124..b1316ebe1ca 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.mutual_information.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.mutual_information -`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") +`mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.43/qiskit.quantum_info.partial_trace.md index 845fb14cff6..ba6005ec39c 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.partial_trace.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.partial_trace -`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/utils.py "view source code") +`partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.43/qiskit.quantum_info.pauli_basis.md index d4ce918ce4c..8515b2c1252 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`pauli_basis(num_qubits, weight=False, pauli_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.43/qiskit.quantum_info.process_fidelity.md index 197d799136f..b992f5c8114 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.process_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.process_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.43/qiskit.quantum_info.purity.md index f16c1ea03f8..acf64100cc8 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.purity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.purity -`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") +`purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_clifford.md index 1f3388a1a2d..65467829748 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_clifford.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_clifford -`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_cnotdihedral.md index 537e4d60985..357101ca4a3 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_cnotdihedral.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_density_matrix.md index a59609479b3..5bb067018f0 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_density_matrix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_density_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/random.py "view source code") +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_hermitian.md index 7f5ccc9f926..93876082dec 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_hermitian.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_hermitian -`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/random.py "view source code") +`random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli.md index 13da86326ce..c9291965b1f 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_list.md index 2951aa6e55d..da059715028 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_list.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_pauli_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_table.md index f58d10c3cd9..ce0af4404be 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_pauli_table.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_pauli_table -`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_quantum_channel.md index ff778869323..afd69a0b7d1 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_quantum_channel.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_quantum_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/random.py "view source code") +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_stabilizer_table.md index a21cdd5dcef..ce6f14dc41b 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_stabilizer_table.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_stabilizer_table -`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_statevector.md index 417459f350d..215bcddb0d8 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_statevector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_statevector -`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/random.py "view source code") +`random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.43/qiskit.quantum_info.random_unitary.md index e92dce7d43a..b67b98e7a0a 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.random_unitary.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.random_unitary -`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/random.py "view source code") +`random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.43/qiskit.quantum_info.shannon_entropy.md index a0fac2478a1..2211eb5a709 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.shannon_entropy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.shannon_entropy -`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/utils.py "view source code") +`shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.43/qiskit.quantum_info.state_fidelity.md index c1917217544..646bc474077 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.state_fidelity.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.state_fidelity -`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") +`state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.md index 787e0fb5bfc..7740c4fd29f 100644 --- a/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.43/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -50,7 +50,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.md index 33cef564130..31b78da3fef 100644 --- a/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.43/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -37,7 +37,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -61,7 +61,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -93,7 +93,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -117,7 +117,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -144,7 +144,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.43/qiskit.result.Counts.md b/docs/api/qiskit/0.43/qiskit.result.Counts.md index 8061f9cc323..fd169f59a17 100644 --- a/docs/api/qiskit/0.43/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.43/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") Bases: `dict` @@ -84,7 +84,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") +`Counts.hex_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -108,7 +108,7 @@ dict -`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") +`Counts.int_outcomes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -146,7 +146,7 @@ dict -`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") +`Counts.most_frequent()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") Return the most frequent count @@ -202,7 +202,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") +`Counts.shots()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.md index 444a32071d3..4c4718939ff 100644 --- a/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.43/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -38,7 +38,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.assignment_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -62,7 +62,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -94,7 +94,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.mitigation_matrix(qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -118,7 +118,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -149,7 +149,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.md index 1df7ddc3a8a..b9ee1bcba07 100644 --- a/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.43/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -103,7 +103,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/probability.py "view source code") +`ProbDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.md index fafca395a76..5f1d3111f1e 100644 --- a/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.43/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -45,7 +45,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.binary_probabilities(num_bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -105,7 +105,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.hex_probabilities()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -141,7 +141,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") +`QuasiDistribution.nearest_probability_distribution(return_distance=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.43/qiskit.result.Result.md b/docs/api/qiskit/0.43/qiskit.result.Result.md index d8f8acf5b5f..bd342d48f56 100644 --- a/docs/api/qiskit/0.43/qiskit.result.Result.md +++ b/docs/api/qiskit/0.43/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Bases: `object` @@ -84,7 +84,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result.data(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -120,7 +120,7 @@ dict -`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`classmethod Result.from_dict(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -142,7 +142,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result.get_counts(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -168,7 +168,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result.get_memory(experiment=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -202,7 +202,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result.get_statevector(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -229,7 +229,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result.get_unitary(experiment=None, decimals=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -258,7 +258,7 @@ list\[list\[complex]] -`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") +`Result.to_dict()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.43/qiskit.result.ResultError.md b/docs/api/qiskit/0.43/qiskit.result.ResultError.md index cd819fe7f34..33717044e27 100644 --- a/docs/api/qiskit/0.43/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.43/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/exceptions.py "view source code") +`ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.43/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.43/qiskit.result.marginal_counts.md index 1476b2f70f9..d253dade0e8 100644 --- a/docs/api/qiskit/0.43/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.43/qiskit.result.marginal_counts.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.marginal_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/utils.py "view source code") +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.43/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.43/qiskit.result.marginal_distribution.md index 5b88a5304eb..6cfcfb912b3 100644 --- a/docs/api/qiskit/0.43/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.43/qiskit.result.marginal_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.marginal_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/utils.py "view source code") +`marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.43/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.43/qiskit.result.marginal_memory.md index 6a5cbcf95dd..0ee3ffc3625 100644 --- a/docs/api/qiskit/0.43/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.43/qiskit.result.marginal_memory.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.marginal_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/utils.py "view source code") +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.43/qiskit.result.sampled_expectation_value.md b/docs/api/qiskit/0.43/qiskit.result.sampled_expectation_value.md index 6f386e93352..0c53c64e8ea 100644 --- a/docs/api/qiskit/0.43/qiskit.result.sampled_expectation_value.md +++ b/docs/api/qiskit/0.43/qiskit.result.sampled_expectation_value.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.sampled_expectation_value -`sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/sampled_expval.py "view source code") +`sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.md index a9b6882e83d..963a89f4b06 100644 --- a/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.43/qiskit.scheduler.ScheduleConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.scheduler.ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/scheduler/config.py "view source code") +`ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.md index b8a49c0e8a4..24610226f38 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`abstract EvolutionSynthesis.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.md index 94fd81da4b3..d2abbc618e7 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -47,7 +47,7 @@ $$ -`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`LieTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.md index 1f63b679413..e3539410807 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -26,7 +26,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`MatrixExponential.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.md index a4946d14835..57e9c1e99cf 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/product_formula.py "view source code") +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.md index 5dbe687de54..db651095923 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/qdrift.py "view source code") +`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -35,7 +35,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/qdrift.py "view source code") +`QDrift.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/qdrift.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.md index ff2a9bb70ba..917d5cb3662 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: `object` @@ -30,7 +30,7 @@ This class is called recursively by the transpiler pass, which is why it is sepa -`SolovayKitaevDecomposition.find_basic_approximation(sequence)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.find_basic_approximation(sequence)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Finds gate in `self._basic_approximations` that best represents `sequence`. @@ -52,7 +52,7 @@ Gate in basic approximations that is closest to `sequence`. -`SolovayKitaevDecomposition.load_basic_approximations(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.load_basic_approximations(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Load basic approximations. @@ -78,7 +78,7 @@ list\[GateSequence] -`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Run the algorithm. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.md index 48ba35a0bb9..e4dd8017e55 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -54,7 +54,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`SuzukiTrotter.synthesize(evolution)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.generate_basic_approximations.md b/docs/api/qiskit/0.43/qiskit.synthesis.generate_basic_approximations.md index ba7ed5fc417..94e43396d2a 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.generate_basic_approximations.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.generate_basic_approximations.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.generate_basic_approximations -`generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_ag.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_ag.md index a96ecfa130e..bb69b859467 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_ag.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_ag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_clifford_ag -`synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_bm.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_bm.md index ac29d522e1f..c0501fa9202 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_bm.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_bm.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_clifford_bm -`synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_depth_lnn.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_depth_lnn.md index a2745385a33..9b1ca04516e 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_depth_lnn.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_depth_lnn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_clifford_depth_lnn -`synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`synth_clifford_depth_lnn(cliff)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers for linear-nearest neighbour connectivity. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_full.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_full.md index 6f446420d6f..ebf31581f04 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_full.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_full.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_clifford_full -`synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_greedy.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_greedy.md index 4dad218a4b9..771c91f878d 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_greedy.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_greedy.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_clifford_greedy -`synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_layers.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_layers.md index 18cdb91deb4..9ef1362d794 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_layers.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_clifford_layers.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_clifford_layers -`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_count_full_pmh.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_count_full_pmh.md index 6980175c726..b69ddd60e95 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_count_full_pmh.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_count_full_pmh.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_cnot_count_full_pmh -`synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/linear/cnot_synth.py "view source code") +`synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/linear/cnot_synth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_depth_line_kms.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_depth_line_kms.md index f1a258b0c40..87891cbd41d 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_depth_line_kms.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnot_depth_line_kms.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_cnot_depth_line_kms -`synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_full.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_full.md index f25b3f27d44..0942b9a216b 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_full.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_full.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_full -`synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_general.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_general.md index cbc26f04138..3650c40b1df 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_general.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_general.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_general -`synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_two_qubits.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_two_qubits.md index cee707f869a..4174dc6c724 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_two_qubits.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cnotdihedral_two_qubits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_cnotdihedral_two_qubits -`synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cz_depth_line_mr.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cz_depth_line_mr.md index fc9a94eef83..8d8dbb5208b 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_cz_depth_line_mr.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_cz_depth_line_mr.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_cz_depth_line_mr -`synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`synth_cz_depth_line_mr(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_acg.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_acg.md index 78cffd14013..49e61ae9e64 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_acg.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_acg.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_permutation_acg -`synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_basic.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_basic.md index 2295dc0042b..0deff5968fc 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_basic.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_basic.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_permutation_basic -`synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/permutation/permutation_full.py "view source code") +`synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_depth_lnn_kms.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_depth_lnn_kms.md index 28b33b44ff8..4f133049b07 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_depth_lnn_kms.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_permutation_depth_lnn_kms.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_permutation_depth_lnn_kms -`synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_depth_lnn.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_depth_lnn.md index 440c1911ef5..80acc47e822 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_depth_lnn.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_depth_lnn.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_stabilizer_depth_lnn -`synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`synth_stabilizer_depth_lnn(stab)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth 2\*n+2 and two distinct CX layers, using CX and phase gates (S, Sdg or Z). diff --git a/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_layers.md b/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_layers.md index 0372902afd6..dc9578762be 100644 --- a/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_layers.md +++ b/docs/api/qiskit/0.43/qiskit.synthesis.synth_stabilizer_layers.md @@ -12,7 +12,7 @@ python_api_name: qiskit.synthesis.synth_stabilizer_layers -`synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of a stabilizer state into layers. diff --git a/docs/api/qiskit/0.43/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.43/qiskit.tools.backend_monitor.md index d1597700266..82b6758f708 100644 --- a/docs/api/qiskit/0.43/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.43/qiskit.tools.backend_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.backend_monitor -`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/monitor/overview.py "view source code") +`backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.43/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.43/qiskit.tools.backend_overview.md index 6193ece0056..8e28cb66173 100644 --- a/docs/api/qiskit/0.43/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.43/qiskit.tools.backend_overview.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.backend_overview -`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/monitor/overview.py "view source code") +`backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.md b/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.md index 6e0255bf243..ef67872dfbd 100644 --- a/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.md +++ b/docs/api/qiskit/0.43/qiskit.tools.events.TextProgressBar.md @@ -10,7 +10,7 @@ python_api_name: qiskit.tools.events.TextProgressBar -`TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/events/progressbar.py "view source code") Bases: `BaseProgressBar` @@ -76,7 +76,7 @@ Run when progress bar has completed. -`TextProgressBar.start(iterations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.start(iterations)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/events/progressbar.py "view source code") Start the progress bar. @@ -150,7 +150,7 @@ Unsubscribe a pair event-callback, so the callback will not be called anymore wh -`TextProgressBar.update(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/events/progressbar.py "view source code") +`TextProgressBar.update(n)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/events/progressbar.py "view source code") Update status of progress bar. diff --git a/docs/api/qiskit/0.43/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.43/qiskit.tools.job_monitor.md index 7d91f78bbc5..167011f20ae 100644 --- a/docs/api/qiskit/0.43/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.43/qiskit.tools.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.job_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/monitor/job_monitor.py "view source code") +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.43/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.43/qiskit.tools.parallel_map.md index 002df2a79b1..f265cbee351 100644 --- a/docs/api/qiskit/0.43/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.43/qiskit.tools.parallel_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.tools.parallel_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/parallel.py "view source code") +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.md index 20155335eb4..2bbf427be64 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/basepasses.py "view source code") +`AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.md index 224249fd7a5..c0bba157fc6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.md index 788e737bdc5..ae7a9bfc691 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_edge(src, dst)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -45,7 +45,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.add_physical_qubit(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -61,7 +61,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.compute_distance_matrix()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -73,7 +73,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.connected_components()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.connected_components()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Separate a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") into subgraph [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") for each connected component. @@ -133,7 +133,7 @@ list -`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.distance(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -160,7 +160,7 @@ int -`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.draw()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -180,7 +180,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -194,7 +194,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -208,7 +208,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -235,7 +235,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -262,7 +262,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -286,7 +286,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -300,7 +300,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -314,7 +314,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.get_edges()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -332,7 +332,7 @@ Tuple(int,int) -`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.is_connected()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -344,7 +344,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.largest_connected_component()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -354,7 +354,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.make_symmetric()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -364,7 +364,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.neighbors(physical_qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -376,7 +376,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.reduce(mapping)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -402,7 +402,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -429,7 +429,7 @@ List -`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.size()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -439,7 +439,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") +`CouplingMap.subgraph(nodelist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.md index e84f181234a..4b74edf142d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.md index 1b4c8cec372..be317ec6707 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/fencedobjs.py "view source code") +`FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.md index 517b8e3e904..b2f2e4de0a8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/fencedobjs.py "view source code") +`FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.md index c9d13b17da3..1ed025dbfa9 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.add_flow_controller(name, controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -41,7 +41,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.controller_factory(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -69,7 +69,7 @@ A FlowController instance. -`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`FlowController.dump_passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -87,7 +87,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") +`classmethod FlowController.remove_flow_controller(name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.md index ef670d0afbc..ddb4f8baba2 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") +`classmethod InstructionDurations.from_backend(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -52,7 +52,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -87,7 +87,7 @@ float|int -`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.units_used()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -105,7 +105,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") +`InstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.md index 041fc542035..4520ea13664 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.43/qiskit.transpiler.Layout.md index a89bd8a9056..7484313e6d6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.add(virtual_bit, physical_bit=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit. @@ -41,7 +41,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.add_register(reg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -55,7 +55,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.combine_into_edge_map(another_layout)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -92,7 +92,7 @@ dict -`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.copy()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -102,7 +102,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.from_dict(input_dict)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -140,7 +140,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`static Layout.from_intlist(int_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -167,7 +167,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`static Layout.from_qubit_list(qubit_list, *qregs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -194,7 +194,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`static Layout.generate_trivial_layout(*regs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -216,7 +216,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.get_physical_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -226,7 +226,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.get_registers()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -236,7 +236,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.get_virtual_bits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -246,7 +246,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`static Layout.order_based_on_type(value1, value2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -256,7 +256,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.reorder_bits(bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -280,7 +280,7 @@ List -`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`Layout.swap(left, right)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.md index d0af751c8f5..366913326b8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -85,7 +85,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -103,7 +103,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -121,7 +121,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. @@ -196,7 +196,7 @@ The transformed circuit(s). -`PassManager.to_flow_controller()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`PassManager.to_flow_controller()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Linearize this manager into a single [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController"), so that it can be nested inside another [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.md index e59bf7fb720..e7697507e88 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager_config.py "view source code") +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -47,7 +47,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager_config.py "view source code") +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.md index 288417fc54d..505e0968ac0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/propertyset.py "view source code") +`PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.md index 036b46a23e6..452d99790f9 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -53,7 +53,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -77,7 +77,7 @@ Append a Pass Set to the schedule of passes. -`StagedPassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.draw(filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Draw the staged pass manager. @@ -87,7 +87,7 @@ Draw the staged pass manager. -`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.passes()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -105,7 +105,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.remove(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -123,7 +123,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -148,7 +148,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") +`StagedPassManager.run(circuits, output_name=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.Target.md b/docs/api/qiskit/0.43/qiskit.transpiler.Target.md index 7681c9bc67e..14f43aa12f3 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Bases: `Mapping` @@ -101,7 +101,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.add_instruction(instruction, properties=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -144,7 +144,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None, filter_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.build_coupling_map(two_q_gate=None, filter_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -176,7 +176,7 @@ for this target. If there are no connectivity constraints in the target this wil -`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.durations()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -196,7 +196,7 @@ target -`classmethod Target.from_configuration(basis_gates, num_qubits=None, coupling_map=None, inst_map=None, backend_properties=None, instruction_durations=None, dt=None, timing_constraints=None, custom_name_mapping=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`classmethod Target.from_configuration(basis_gates, num_qubits=None, coupling_map=None, inst_map=None, backend_properties=None, instruction_durations=None, dt=None, timing_constraints=None, custom_name_mapping=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Create a target object from the individual global configuration @@ -244,7 +244,7 @@ the target built from the input configuration -`Target.get_calibration(operation_name, qargs, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.get_calibration(operation_name, qargs, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get calibrated pulse schedule for the instruction. @@ -271,7 +271,7 @@ Calibrated pulse schedule of corresponding instruction. -`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.get_non_global_operation_names(strict_direction=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -295,7 +295,7 @@ List\[str] -`Target.has_calibration(operation_name, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.has_calibration(operation_name, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) defines a calibration. @@ -318,7 +318,7 @@ bool -`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.instruction_properties(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -360,7 +360,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.instruction_schedule_map()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -378,7 +378,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -421,7 +421,7 @@ bool -`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.items() → a set-like object providing a view on D's items` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") @@ -429,7 +429,7 @@ bool -`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.keys() → a set-like object providing a view on D's keys` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") @@ -437,7 +437,7 @@ bool -`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.operation_from_name(instruction)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -459,7 +459,7 @@ The Instruction instance corresponding to the name. This also can also be the cl -`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.operation_names_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -485,7 +485,7 @@ set -`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.operations_for_qargs(qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -511,7 +511,7 @@ list -`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.qargs_for_operation_name(operation)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -533,7 +533,7 @@ set -`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.timing_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -551,7 +551,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -587,7 +587,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.update_instruction_properties(instruction, qargs, properties)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -607,7 +607,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") +`Target.values() → an object providing a view on D's values` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.md index 8e9dc00daeb..5efa622a362 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/basepasses.py "view source code") +`TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.md index 6b71035ecad..19bc131cd0c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") +`TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/layout.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.md index 0a7ebf39cbb..50b618a4b62 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerAccessError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/exceptions.py "view source code") +`TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.md index 79b32b32948..68584e5420e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.TranspilerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.TranspilerError -`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/exceptions.py "view source code") +`TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.md index 553716ee19c..6f1006a4778 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `BaseSchedulerTransform` @@ -40,7 +40,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`ALAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 1da2ed0785f..9f61912c225 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `BaseScheduler` @@ -43,7 +43,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.md index 70684fd1432..c388d845beb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`ASAPSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index f5323f8582c..f5d5d255bb7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `BaseScheduler` @@ -43,7 +43,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.md index 462c95de689..c29b7dc95d0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -82,7 +82,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`AlignMeasures.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.md index c267a63a3ae..49115977221 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`ApplyLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.md index b23e17d7734..2ee80e90812 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -91,7 +91,7 @@ Return the name of the pass. -`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`BIPMapping.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 694273be1ac..c143589c219 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`BarrierBeforeFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.md index 93dab23ec1c..4542d440dfa 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`BasicSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.md index 87918fcc479..82a9eda04ff 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -81,7 +81,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`BasisTranslator.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.md index 10625dec3f0..456e13f0371 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`CSPLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.md index 6f9940a5a4b..c3f7b1beaea 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`CXCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.md index 9ba6641d2fd..5b34b4ec5fa 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.md index d0400c9cf99..52e6b4fafbb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.md index acb9f6a1f2a..b12dc1c918e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`CheckGateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.md index 59c2a98fc7f..f5c1e041980 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_map.py "view source code") +`CheckMap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.md index 514f1fa4919..b5936414d7d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`Collect1qRuns.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.md index e64513ed2d8..a458eb72c39 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`Collect2qBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.md index 539c3f8b3cd..24f1245cee3 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.md index d07f4c33472..6a28ee2dc1b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.md index 2511e99c53e..ebeda9feffc 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.find_set(index)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -54,7 +54,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -70,7 +70,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`CollectMultiQBlocks.union_set(set1, set2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.md index 55222d4baaf..3c282d7de00 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`CommutationAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.md index b3bdbd45920..ea7e635b4b0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`CommutativeCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.md index e4724aef1bb..b291f302f55 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutativeInverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`CommutativeInverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Run the CommutativeInverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.md index 923294499bb..b263a38fe41 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -96,7 +96,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -124,7 +124,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.md index 27d5f1929ef..acbae4540bc 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`ConsolidateBlocks.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.md index 252918bc3f0..0f45b492641 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -71,7 +71,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`ConstrainedReschedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.md index bebe35459d8..ec97e465451 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`ContainsInstruction.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 50c84f33085..a0b0556bd7e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`ConvertConditionsToIfOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`ConvertConditionsToIfOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.md index f3bca804e1f..52f6b393478 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`CountOps.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.md index 914fa3d9227..8e6be4f8263 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`CountOpsLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index a1d639df876..00c67198fc1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -54,7 +54,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -64,7 +64,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.basic_bounds()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -74,7 +74,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -84,7 +84,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -94,7 +94,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.coherence_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -104,7 +104,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -114,7 +114,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.create_z3_vars()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -124,7 +124,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.cx_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -134,7 +134,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -144,7 +144,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -154,7 +154,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -164,7 +164,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.extract_solution()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -174,7 +174,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.fidelity_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -184,7 +184,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -194,7 +194,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -204,7 +204,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.gate_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -214,7 +214,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.generate_barriers(layers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -224,7 +224,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -244,7 +244,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.objective_function()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -254,7 +254,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.parse_backend_properties()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -264,7 +264,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.powerset(iterable)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -274,7 +274,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.r2f(val)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -284,7 +284,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.reset()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -294,7 +294,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -304,7 +304,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.scheduling_constraints()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -314,7 +314,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -324,7 +324,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`CrosstalkAdaptiveSchedule.solve_optimization()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.md index d63cf52a5aa..0119fa64071 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`DAGFixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.md index 4f9022c28cd..e64b3be3810 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`DAGLongestPath.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.md index 9c09ddc1ca4..0d133a71626 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/decompose.py "view source code") +`Decompose.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.md index 8d8d295fbd5..abe8f62faf6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`DenseLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.md index 583481e32af..c501f4d9352 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/depth.py "view source code") +`Depth.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.md index e4044b87fa8..4ba0436c491 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -103,7 +103,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`DynamicalDecoupling.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index c879fe4f9d4..2b758fb69cc 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`EchoRZXWeylDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.md index a57fc571401..c745b43cbf7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`EnlargeWithAncilla.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.md index 7ec17f28b25..af73b72d714 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`FixedPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.md index 318d6075000..be0e88bf1a3 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`FullAncillaAllocation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -76,7 +76,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.md index e77ac0814c7..eaa4e304026 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`GateDirection.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.md index 241ec39a1a2..560401a3b0b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`GatesInBasis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.md index 1f2a4502bbf..0713582c5c0 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`HighLevelSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`HighLevelSynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run the HighLevelSynthesis pass on dag. :param dag: input dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.md index b895ded1451..f7150b2a835 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`HoareOptimizer.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.md index 37a882db11d..b07e1881bf8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`InstructionDurationCheck.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.md index 6f55fe4a97a..6ffff07e3c2 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`InverseCancellation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.md index cf2eea6c358..47f55b9f629 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`Layout2qDistance.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index e067662ca7a..795c256077e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 3e355dcb28a..9b78f16387d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`LinearFunctionsToPermutations.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :param dag: input dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.md index 00920d0476a..2de2bd6803a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`LookaheadSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 2e0bf283caa..40d330f7a2c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -71,7 +71,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`MergeAdjacentBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.md index a5550c9314e..0546cc2d22b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`MinimumPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -54,7 +54,7 @@ Return the name of the pass. -`MinimumPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`MinimumPoint.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Run the MinimumPoint pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index f2ef90f842b..ef07e184cd5 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -84,7 +84,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`NoiseAdaptiveLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.md index 1182bcde91c..ff27cdd573a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`NumTensorFactors.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.md index d389693fd48..150ecad0000 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -58,7 +58,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`Optimize1qGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -84,7 +84,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 5ee446d8d11..6926c142e1e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`Optimize1qGatesDecomposition.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 268ad5e8b82..31250a8a1c6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`Optimize1qGatesSimpleCommutation.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.md index 92cbbe3b0d8..ea2184af185 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`OptimizeCliffords.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`OptimizeCliffords.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Run the OptimizeCliffords pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.md index d924a8f6fb0..f7a24731216 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`PadDelay(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 3d0284fb7d6..8ea788bcbb5 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.md index 40f501ee630..259d8794954 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `CalibrationBuilder` @@ -43,7 +43,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -102,7 +102,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`PulseGates.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 732ba9cace0..c3b0eeb89a2 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `CalibrationBuilder` @@ -41,7 +41,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -80,7 +80,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") A builder macro to play stretched pulse. @@ -130,7 +130,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilder.supported(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index f8ad1885537..6aebff00b2a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") @@ -43,7 +43,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.md index 042e6931cdc..7b7396fb21f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -53,7 +53,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`RemoveBarriers.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 3ed09b0e50c..897f808f5c1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`RemoveDiagonalGatesBeforeMeasure.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 906a5959e3e..ef3ca0c48b6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`RemoveFinalMeasurements.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.md index f7164e630c1..7d5573cf5eb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`RemoveResetInZeroState.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index ed19c31110f..64eb1fda417 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`ResetAfterMeasureSimplification.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`ResetAfterMeasureSimplification.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Run the pass on a dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.md index 3ade94d2cd7..3fa7d196b45 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`SabreLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.md index 5e9f570a862..80cc9329e21 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -94,7 +94,7 @@ Return the name of the pass. -`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`SabreSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.md index fc548bcbacf..b0e471a8d12 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`SetIOLatency.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.md index ba7b906a349..5f8a9e88b6c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`SetLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.md index 1afb5b65a91..0bf17acd49c 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/size.py "view source code") +`Size.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.md index a46820b0b3d..7dd3bd4b0d6 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -123,7 +123,7 @@ Return the name of the pass. -`SolovayKitaev.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaev.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run the `SolovayKitaev` pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index 846df22cf41..6ceb8b70b78 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -46,7 +46,7 @@ The number of times the decomposition is recursively improved. If None, defaults -`SolovayKitaevSynthesis.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`SolovayKitaevSynthesis.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.md index b52475df4ec..bca5ac49d48 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`StochasticSwap.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.md index 7eebaeb1c6e..2523f17d313 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`TemplateOptimization.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.md index 1bf937d8eaa..594ae1c7443 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -49,7 +49,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`TimeUnitConversion.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.md index b6e18d9fd77..b9bc25f9ec3 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -91,7 +91,7 @@ Return the name of the pass. -`TranslateParameterizedGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`TranslateParameterizedGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Run the transpiler pass. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.md index b7eaff9e6b9..a3370bed820 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -50,7 +50,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`TrivialLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.md index e4335512b79..8a1bd7c64d9 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -52,7 +52,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`UnitarySynthesis.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on `dag`. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.md index e1a804fa7f5..01e8fd660cb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`Unroll3qOrMore.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.md index c6eaf534a79..123b6359c5f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`UnrollCustomDefinitions.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.md index 7d1b35a98ec..b3c572b2fe4 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`UnrollForLoops(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`UnrollForLoops.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`UnrollForLoops.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Run the UnrollForLoops pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.md index cf3ecb91611..12a14519d66 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroller.py "view source code") +`Unroller.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.md index 4cd072e1eb2..bf2f48b2021 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -70,7 +70,7 @@ Return the name of the pass. -`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`VF2Layout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.md index aa69986cb41..8db851ac180 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -72,7 +72,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`VF2PostLayout.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.md index ee374022543..1ded2c617ff 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -49,7 +49,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`ValidatePulseGates.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.md index af433383a13..2abac1e27b1 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/width.py "view source code") +`Width.run(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 93dd5de1ca2..68663451a1f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `ABC` @@ -26,7 +26,7 @@ This abstract class defines the interface for high-level synthesis plugins. -`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given Operation. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index 72fd1c7688b..0bea7d1001a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Class tracking the installed high-level-synthesis plugins. -`HighLevelSynthesisPluginManager.method(op_name, method_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method(op_name, method_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns the plugin for `op_name` and `method_name`. @@ -34,7 +34,7 @@ Returns the plugin for `op_name` and `method_name`. -`HighLevelSynthesisPluginManager.method_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`HighLevelSynthesisPluginManager.method_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns plugin methods for op\_name. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 9961cf381b2..e1aa800a5dc 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `ABC` @@ -26,7 +26,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`abstract UnitarySynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 1e04250d9fa..e8b10fdc6dd 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 1c3a402edd4..93bfb72642a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md index e2594edf21c..ebb21f99994 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_control_f -`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md index f61f0701cfa..2b4eeb93fe4 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_embed_pas -`generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md index 260cc43d413..68c95f80606 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_error_on_ -`generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md index 94d09df657a..31854f0738d 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_pre_op_pa -`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md index fc330947207..ebebcd676f4 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_routing_p -`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md index 21d1cd0f4f3..fa55d5529aa 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_schedulin -`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md index 01d0bbd9d66..06adfa848e8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_translati -`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md index f89e60c9c4a..ef1b3d360b2 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q -`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index a4637f22a3c..a3e0845cbcb 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_mana -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index d7bb9c71ceb..11481578ae7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager -`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index b6ae0a998ad..b5b66f542c7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager -`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index 716dba896cd..fd69bd848bf 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager -`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 0401bebb007..d4066ef8796 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager -`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 9549807321a..c023e25cb9f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `ABC` @@ -26,7 +26,7 @@ A `PassManagerStagePlugin` object can be added to an external package and integr -`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index f3d066a584c..b87865b3ee7 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Manager class for preset pass manager stage plugins. -`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a stage diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md index de5f0b0dfb4..edb7b8d3e66 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins -`list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins.md b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins.md index 5cc102b4e8e..d642f4ac30e 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_ -`passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`passmanager_stage_plugins(stage)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.md index 5a83cf5fbd0..80977460547 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 3e91e9acc51..8b150125375 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -54,7 +54,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`AQCSynthesisPlugin.run(unitary, **options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index cdfa30d7f2e..6dea10eeb9f 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `ABC` @@ -29,7 +29,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximateCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 6980d79f54c..06ee1c4f312 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `ABC` @@ -24,7 +24,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -46,7 +46,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`abstract ApproximatingObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 8a0252d06fc..89a808d0eb8 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -35,7 +35,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`CNOTUnitCircuit.build(thetas)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index eb59d46c3f1..af04eac044a 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `ABC` diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 04b1547f913..33c3fd99a76 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -29,7 +29,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -51,7 +51,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`DefaultCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index 673b0d38c80..c0b6838629b 100644 --- a/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.43/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -29,7 +29,7 @@ Implementation of objective function and gradient calculator, which is similar t -`FastCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.gradient(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the gradient of objective function. See description of the base class method. @@ -43,7 +43,7 @@ Computes the gradient of objective function. See description of the base class m -`FastCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`FastCNOTUnitObjective.objective(param_values)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. diff --git a/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.md index 58fb2511d68..9436922fd56 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.43/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -60,7 +60,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.assemble(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -74,7 +74,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.cals_matrix(qubit_index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -96,7 +96,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.execute(circuits, had_transpiled=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -129,7 +129,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -151,7 +151,7 @@ bool -`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.reset_execution_results()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -161,7 +161,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.set_config(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -171,7 +171,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") +`QuantumInstance.transpile(circuits, pass_manager=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.43/qiskit.utils.add_deprecation_to_docstring.md b/docs/api/qiskit/0.43/qiskit.utils.add_deprecation_to_docstring.md index 102a097e2fe..485becc3239 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.add_deprecation_to_docstring.md +++ b/docs/api/qiskit/0.43/qiskit.utils.add_deprecation_to_docstring.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.add_deprecation_to_docstring -`add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") +`add_deprecation_to_docstring(func, msg, *, since, pending)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") Dynamically insert the deprecation message into `func`’s docstring. diff --git a/docs/api/qiskit/0.43/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.43/qiskit.utils.apply_prefix.md index 55827f7894e..38a564cea79 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.43/qiskit.utils.apply_prefix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.apply_prefix -`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/units.py "view source code") +`apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.43/qiskit.utils.deprecate_arg.md b/docs/api/qiskit/0.43/qiskit.utils.deprecate_arg.md index 8afd1623dfd..cda4f725044 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.deprecate_arg.md +++ b/docs/api/qiskit/0.43/qiskit.utils.deprecate_arg.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.deprecate_arg -`deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit-terra', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") +`deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit-terra', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") Decorator to indicate an argument has been deprecated in some way. diff --git a/docs/api/qiskit/0.43/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.43/qiskit.utils.deprecate_arguments.md index a1e29ba5afc..9e855c7cfa8 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.43/qiskit.utils.deprecate_arguments.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.deprecate_arguments -`deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") +`deprecate_arguments(kwarg_map, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_arg. diff --git a/docs/api/qiskit/0.43/qiskit.utils.deprecate_func.md b/docs/api/qiskit/0.43/qiskit.utils.deprecate_func.md index 42c19caf717..28e3a16d2c2 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.deprecate_func.md +++ b/docs/api/qiskit/0.43/qiskit.utils.deprecate_func.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.deprecate_func -`deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit-terra', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") +`deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit-terra', removal_timeline='no earlier than 3 months after the release date', is_property=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") Decorator to indicate a function has been deprecated. diff --git a/docs/api/qiskit/0.43/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.43/qiskit.utils.deprecate_function.md index 272b798eb91..dabeed2b588 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.43/qiskit.utils.deprecate_function.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.deprecate_function -`deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") +`deprecate_function(msg, stacklevel=2, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_func. diff --git a/docs/api/qiskit/0.43/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.43/qiskit.utils.detach_prefix.md index 8cb4b170c1c..200112fe14e 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.43/qiskit.utils.detach_prefix.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.detach_prefix -`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/units.py "view source code") +`detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.43/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.43/qiskit.utils.get_entangler_map.md index be79de880c0..f48b1c8658d 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.43/qiskit.utils.get_entangler_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.get_entangler_map -`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/entangler_map.py "view source code") +`get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.43/qiskit.utils.has_aer.md b/docs/api/qiskit/0.43/qiskit.utils.has_aer.md index 3d037d85d7e..d6e87af948f 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.43/qiskit.utils.has_aer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.has_aer -`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/backend_utils.py "view source code") +`has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/backend_utils.py "view source code") Check if Aer is installed. diff --git a/docs/api/qiskit/0.43/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.43/qiskit.utils.has_ibmq.md index 7540c008026..41ef2e79ae7 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.43/qiskit.utils.has_ibmq.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.has_ibmq -`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/backend_utils.py "view source code") +`has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed. diff --git a/docs/api/qiskit/0.43/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.43/qiskit.utils.is_main_process.md index 51579e14fb9..a468c2e5003 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.43/qiskit.utils.is_main_process.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.is_main_process -`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/multiprocessing.py "view source code") +`is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.43/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.43/qiskit.utils.local_hardware_info.md index d34f55732ee..6b32cfa65ea 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.43/qiskit.utils.local_hardware_info.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.local_hardware_info -`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/multiprocessing.py "view source code") +`local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.md index e5f5e5c53d7..e6a3a26172f 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.43/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -58,7 +58,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.readout_fidelity(label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -84,7 +84,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`CompleteMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.md index 51cabbeedc7..72cbe405a63 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.43/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -60,7 +60,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. @@ -91,7 +91,7 @@ The on-diagonal elements of the calibration matrices are the probabilities of me -`TensoredMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") +`TensoredMeasFitter.subset_fitter(qubit_sublist)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.43/qiskit.utils.name_args.md b/docs/api/qiskit/0.43/qiskit.utils.name_args.md index 5bf3856f7e3..18496e2a354 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.43/qiskit.utils.name_args.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.name_args -`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/name_unnamed_args.py "view source code") +`name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.43/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.43/qiskit.utils.summarize_circuits.md index f2f07718c35..6ce7b6d89e9 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.43/qiskit.utils.summarize_circuits.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.summarize_circuits -`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/circuit_utils.py "view source code") +`summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.43/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.43/qiskit.utils.validate_entangler_map.md index aeb42eb4c20..e33444ac415 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.43/qiskit.utils.validate_entangler_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.validate_entangler_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/entangler_map.py "view source code") +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.43/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.43/qiskit.utils.wrap_method.md index 1013f2ed77e..61a2784a750 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.43/qiskit.utils.wrap_method.md @@ -12,7 +12,7 @@ python_api_name: qiskit.utils.wrap_method -`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/classtools.py "view source code") +`wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.md index c6146508f7b..811952a610f 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.VisualizationError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.VisualizationError -`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/exceptions.py "view source code") +`VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.43/qiskit.visualization.array_to_latex.md index 12d76b6e11d..2fdcb280b77 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/array.py "view source code") +`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.43/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.43/qiskit.visualization.circuit_drawer.md index 39813d08e2d..f8c2368d4ba 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.43/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.43/qiskit.visualization.dag_drawer.md index dd28f5129ce..b450e6560ec 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/dag_visualization.py "view source code") +`dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.43/qiskit.visualization.pass_manager_drawer.md index 238633a1281..1384b628a24 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pass_manager_visualization.py "view source code") +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_multivector.md index c8db5cf396b..b417f7da474 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_vector.md index beccaedbc9c..4a4745224f6 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_circuit_layout.md index 1026cf0c411..fa47b309f43 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_coupling_map.md index 21a0d26e668..4fa849c2194 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_distribution.md index 97c440f2de5..39eb17d1cd8 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/counts_visualization.py "view source code") +`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_error_map.md index 09a1bc2e838..8a1e6ae135c 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_gate_map.md index 5f9ec1bca34..2375b1e0b08 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_histogram.md index a74072763e9..04fbf634151 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/counts_visualization.py "view source code") +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_city.md index 01295664d6e..83f6fbf8ba7 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_hinton.md index ad18a8d8a7d..d69edffd623 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_paulivec.md index b4c65e98408..94a68f30bf1 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_qsphere.md index 8a47851a7f1..20e06e12721 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.md index 5c7cacd7512..13e4d9bae90 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.md index 5d95915739e..6c269889ac4 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.md index c300a7dbb35..7e55f691a20 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.md index 119b790e503..3f5bf6a56c6 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/circuit/qcstyle.py "view source code") +`DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.43/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.43/qiskit.visualization.visualize_transition.md index 4d41bc40792..e1e137d30e5 100644 --- a/docs/api/qiskit/0.43/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.43/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/transition_visualization.py "view source code") +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.43/synthesis_aqc.md b/docs/api/qiskit/0.43/synthesis_aqc.md index 9f5353d2c79..679156f91b1 100644 --- a/docs/api/qiskit/0.43/synthesis_aqc.md +++ b/docs/api/qiskit/0.43/synthesis_aqc.md @@ -130,7 +130,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.43/utils.md b/docs/api/qiskit/0.43/utils.md index 52b3344cff9..1a5e3bbeb38 100644 --- a/docs/api/qiskit/0.43/utils.md +++ b/docs/api/qiskit/0.43/utils.md @@ -118,7 +118,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/lazy_tester.py "view source code") +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -239,7 +239,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/lazy_tester.py "view source code") +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -253,7 +253,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/lazy_tester.py "view source code") +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. From 29adab74c2617c94d564e2a254862294e42d39ee Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 17:59:10 +0100 Subject: [PATCH 24/41] Regenerate qiskit 0.44.0 --- docs/api/qiskit/0.44/algorithms.md | 6 +- docs/api/qiskit/0.44/assembler.md | 6 +- docs/api/qiskit/0.44/circuit.md | 4 +- docs/api/qiskit/0.44/circuit_classical.md | 66 ++++---- docs/api/qiskit/0.44/circuit_library.md | 142 ++++++++--------- docs/api/qiskit/0.44/compiler.md | 8 +- docs/api/qiskit/0.44/converters.md | 18 +-- docs/api/qiskit/0.44/dagcircuit.md | 4 +- docs/api/qiskit/0.44/exceptions.md | 8 +- docs/api/qiskit/0.44/execute.md | 2 +- docs/api/qiskit/0.44/extensions.md | 2 +- docs/api/qiskit/0.44/opflow.md | 8 +- docs/api/qiskit/0.44/providers.md | 10 +- docs/api/qiskit/0.44/pulse.md | 144 +++++++++--------- docs/api/qiskit/0.44/qasm.md | 8 +- docs/api/qiskit/0.44/qasm2.md | 12 +- docs/api/qiskit/0.44/qasm3.md | 16 +- .../0.44/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.44/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- .../qiskit.algorithms.EvolutionProblem.md | 2 +- .../0.44/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.44/qiskit.algorithms.Grover.md | 2 +- .../0.44/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- .../qiskit.algorithms.ImaginaryEvolver.md | 2 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../api/qiskit/0.44/qiskit.algorithms.PVQD.md | 2 +- .../0.44/qiskit.algorithms.PVQDResult.md | 2 +- .../0.44/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.44/qiskit.algorithms.QAOA.md | 2 +- .../0.44/qiskit.algorithms.RealEvolver.md | 2 +- .../0.44/qiskit.algorithms.RealTimeEvolver.md | 2 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 2 +- .../qiskit.algorithms.SciPyRealEvolver.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 2 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.44/qiskit.algorithms.TrotterQRTE.md | 2 +- docs/api/qiskit/0.44/qiskit.algorithms.VQD.md | 2 +- .../0.44/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.44/qiskit.algorithms.VQE.md | 2 +- .../qiskit/0.44/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.44/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 2 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 2 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 2 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.BaseQGT.md | 2 +- ...lgorithms.gradients.BaseSamplerGradient.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.44/qiskit.algorithms.gradients.QFI.md | 2 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 2 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 2 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 2 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 2 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 2 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 2 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.44/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.44/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.44/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.44/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.44/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.44/qiskit.algorithms.optimizers.GSLS.md | 2 +- ...t.algorithms.optimizers.GradientDescent.md | 2 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.44/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.44/qiskit.algorithms.optimizers.SPSA.md | 2 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 2 +- ...lgorithms.optimizers.SteppableOptimizer.md | 2 +- .../0.44/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.44/qiskit.algorithms.optimizers.UMDA.md | 2 +- ...optimizers.optimizer_utils.LearningRate.md | 2 +- ...thms.state_fidelities.BaseStateFidelity.md | 2 +- ...ithms.state_fidelities.ComputeUncompute.md | 2 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 2 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 2 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 2 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 2 +- .../qiskit/0.44/qiskit.assembler.RunConfig.md | 2 +- .../0.44/qiskit.circuit.AncillaQubit.md | 2 +- .../0.44/qiskit.circuit.AncillaRegister.md | 2 +- docs/api/qiskit/0.44/qiskit.circuit.Bit.md | 2 +- .../qiskit/0.44/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.44/qiskit.circuit.CircuitInstruction.md | 2 +- .../0.44/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.44/qiskit.circuit.Clbit.md | 2 +- .../0.44/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.44/qiskit.circuit.ControlFlowOp.md | 2 +- .../0.44/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.44/qiskit.circuit.Delay.md | 2 +- .../0.44/qiskit.circuit.EquivalenceLibrary.md | 2 +- .../qiskit/0.44/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/0.44/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.44/qiskit.circuit.IfElseOp.md | 2 +- .../qiskit/0.44/qiskit.circuit.Instruction.md | 2 +- .../0.44/qiskit.circuit.InstructionSet.md | 2 +- .../qiskit/0.44/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.44/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.44/qiskit.circuit.ParameterVector.md | 2 +- .../0.44/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.44/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.44/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.44/qiskit.circuit.Register.md | 2 +- .../0.44/qiskit.circuit.SwitchCaseOp.md | 2 +- .../qiskit/0.44/qiskit.circuit.WhileLoopOp.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.AND.md | 2 +- .../0.44/qiskit.circuit.library.Barrier.md | 2 +- .../0.44/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.44/qiskit.circuit.library.C3XGate.md | 2 +- .../0.44/qiskit.circuit.library.C4XGate.md | 2 +- .../0.44/qiskit.circuit.library.CCXGate.md | 2 +- .../0.44/qiskit.circuit.library.CCZGate.md | 2 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.44/qiskit.circuit.library.CHGate.md | 2 +- .../0.44/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.44/qiskit.circuit.library.CRXGate.md | 2 +- .../0.44/qiskit.circuit.library.CRYGate.md | 2 +- .../0.44/qiskit.circuit.library.CRZGate.md | 2 +- .../0.44/qiskit.circuit.library.CSGate.md | 2 +- .../0.44/qiskit.circuit.library.CSXGate.md | 2 +- .../0.44/qiskit.circuit.library.CSdgGate.md | 2 +- .../0.44/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.44/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.44/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.44/qiskit.circuit.library.CUGate.md | 2 +- .../0.44/qiskit.circuit.library.CXGate.md | 2 +- .../0.44/qiskit.circuit.library.CYGate.md | 2 +- .../0.44/qiskit.circuit.library.CZGate.md | 2 +- .../0.44/qiskit.circuit.library.DCXGate.md | 2 +- .../0.44/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.44/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.GRZ.md | 2 +- .../qiskit.circuit.library.GlobalPhaseGate.md | 2 +- .../0.44/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.44/qiskit.circuit.library.HGate.md | 2 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.44/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- .../qiskit.circuit.library.LinearFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.44/qiskit.circuit.library.MCMT.md | 2 +- .../0.44/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.44/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.44/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.44/qiskit.circuit.library.MSGate.md | 2 +- .../0.44/qiskit.circuit.library.Measure.md | 2 +- .../0.44/qiskit.circuit.library.NLocal.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../0.44/qiskit.circuit.library.PauliGate.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.44/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.44/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.44/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.44/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.44/qiskit.circuit.library.RGate.md | 2 +- .../0.44/qiskit.circuit.library.RVGate.md | 2 +- .../0.44/qiskit.circuit.library.RXGate.md | 2 +- .../0.44/qiskit.circuit.library.RXXGate.md | 2 +- .../0.44/qiskit.circuit.library.RYGate.md | 2 +- .../0.44/qiskit.circuit.library.RYYGate.md | 2 +- .../0.44/qiskit.circuit.library.RZGate.md | 2 +- .../0.44/qiskit.circuit.library.RZXGate.md | 2 +- .../0.44/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.44/qiskit.circuit.library.Reset.md | 2 +- .../0.44/qiskit.circuit.library.SGate.md | 2 +- .../0.44/qiskit.circuit.library.SXGate.md | 2 +- .../0.44/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.44/qiskit.circuit.library.SdgGate.md | 2 +- ...qiskit.circuit.library.StatePreparation.md | 2 +- .../0.44/qiskit.circuit.library.SwapGate.md | 2 +- .../0.44/qiskit.circuit.library.TGate.md | 2 +- .../0.44/qiskit.circuit.library.TdgGate.md | 2 +- .../0.44/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.44/qiskit.circuit.library.U1Gate.md | 2 +- .../0.44/qiskit.circuit.library.U2Gate.md | 2 +- .../0.44/qiskit.circuit.library.U3Gate.md | 2 +- .../0.44/qiskit.circuit.library.UGate.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.44/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.44/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 2 +- .../qiskit.circuit.library.XXPlusYYGate.md | 2 +- .../0.44/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.44/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../0.44/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.44/qiskit.dagcircuit.BlockCollapser.md | 2 +- .../0.44/qiskit.dagcircuit.BlockCollector.md | 2 +- .../0.44/qiskit.dagcircuit.BlockSplitter.md | 2 +- .../0.44/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.44/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.44/qiskit.dagcircuit.DAGDependency.md | 2 +- .../0.44/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.44/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.44/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.44/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../0.44/qiskit.extensions.HamiltonianGate.md | 2 +- .../0.44/qiskit.extensions.Initialize.md | 2 +- .../qiskit.extensions.SingleQubitUnitary.md | 2 +- .../qiskit/0.44/qiskit.extensions.Snapshot.md | 2 +- .../0.44/qiskit.extensions.UCPauliRotGate.md | 2 +- .../qiskit/0.44/qiskit.extensions.UCRXGate.md | 2 +- .../qiskit/0.44/qiskit.extensions.UCRYGate.md | 2 +- .../qiskit/0.44/qiskit.extensions.UCRZGate.md | 2 +- .../0.44/qiskit.extensions.UnitaryGate.md | 2 +- .../qiskit/0.44/qiskit.opflow.OperatorBase.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.44/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.44/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.44/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.44/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.44/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.44/qiskit.opflow.gradients.QFI.md | 2 +- .../0.44/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.44/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.44/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.44/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.44/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.44/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- .../qiskit.primitives.BackendEstimator.md | 2 +- .../0.44/qiskit.primitives.BackendSampler.md | 2 +- .../0.44/qiskit.primitives.BaseEstimator.md | 2 +- .../0.44/qiskit.primitives.BaseSampler.md | 2 +- .../0.44/qiskit.primitives.Estimator.md | 2 +- .../0.44/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.44/qiskit.primitives.Sampler.md | 2 +- .../0.44/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.44/qiskit.providers.Backend.md | 2 +- .../qiskit/0.44/qiskit.providers.BackendV1.md | 2 +- .../qiskit/0.44/qiskit.providers.BackendV2.md | 2 +- .../qiskit.providers.BackendV2Converter.md | 2 +- docs/api/qiskit/0.44/qiskit.providers.Job.md | 2 +- .../qiskit/0.44/qiskit.providers.JobStatus.md | 2 +- .../api/qiskit/0.44/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.44/qiskit.providers.Options.md | 2 +- .../qiskit/0.44/qiskit.providers.Provider.md | 2 +- .../0.44/qiskit.providers.ProviderV1.md | 2 +- .../0.44/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 2 +- .../qiskit.providers.fake_provider.Fake1Q.md | 2 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 2 +- ...t.providers.fake_provider.FakeBackendV2.md | 2 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 2 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 2 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 2 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 2 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 2 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 2 +- ....fake_provider.FakeProviderForBackendV2.md | 2 +- ...oviders.fake_provider.FakeQasmSimulator.md | 2 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 2 +- ...iskit.providers.fake_provider.FakeTokyo.md | 2 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.44/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../0.44/qiskit.providers.models.JobStatus.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- docs/api/qiskit/0.44/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.44/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.44/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.44/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.44/qiskit.pulse.instructions.Call.md | 2 +- .../0.44/qiskit.pulse.instructions.Delay.md | 2 +- .../0.44/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- ...qiskit.pulse.library.Constant_class.rst.md | 2 +- .../qiskit.pulse.library.Cos_class.rst.md | 2 +- .../qiskit.pulse.library.Drag_class.rst.md | 2 +- .../qiskit.pulse.library.GaussianDeriv.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- ...qiskit.pulse.library.Gaussian_class.rst.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 2 +- ...qiskit.pulse.library.Sawtooth_class.rst.md | 2 +- ...kit.pulse.library.ScalableSymbolicPulse.md | 2 +- .../0.44/qiskit.pulse.library.SechDeriv.md | 2 +- .../0.44/qiskit.pulse.library.Sech_fun.rst.md | 2 +- .../qiskit.pulse.library.Sin_class.rst.md | 2 +- .../qiskit.pulse.library.Square_fun.rst.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 2 +- ...qiskit.pulse.library.Triangle_class.rst.md | 2 +- .../0.44/qiskit.pulse.library.Waveform.md | 2 +- ...skit.pulse.library.gaussian_square_echo.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 2 +- .../0.44/qiskit.pulse.transforms.AlignFunc.md | 2 +- .../0.44/qiskit.pulse.transforms.AlignLeft.md | 2 +- .../qiskit.pulse.transforms.AlignRight.md | 2 +- ...qiskit.pulse.transforms.AlignSequential.md | 2 +- .../0.44/qiskit.qobj.GateCalibration.md | 2 +- .../0.44/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.md | 2 +- .../0.44/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.44/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.44/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.44/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.44/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.44/qiskit.qobj.QasmQobjInstruction.md | 2 +- docs/api/qiskit/0.44/qiskit.qobj.Qobj.md | 2 +- .../0.44/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.44/qiskit.qobj.QobjHeader.md | 2 +- .../0.44/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.44/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.44/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.44/qiskit.quantum_info.Choi.md | 2 +- .../0.44/qiskit.quantum_info.Clifford.md | 2 +- .../0.44/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.44/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.44/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.44/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.44/qiskit.quantum_info.Pauli.md | 2 +- .../0.44/qiskit.quantum_info.PauliList.md | 2 +- .../0.44/qiskit.quantum_info.PauliTable.md | 2 +- .../0.44/qiskit.quantum_info.Quaternion.md | 2 +- .../0.44/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.44/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerState.md | 2 +- .../qiskit.quantum_info.StabilizerTable.md | 2 +- .../0.44/qiskit.quantum_info.Statevector.md | 2 +- .../0.44/qiskit.quantum_info.Stinespring.md | 2 +- .../0.44/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- .../0.44/qiskit.quantum_info.XXDecomposer.md | 2 +- .../0.44/qiskit.quantum_info.Z2Symmetries.md | 2 +- .../0.44/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 2 +- ...iskit.result.CorrelatedReadoutMitigator.md | 2 +- docs/api/qiskit/0.44/qiskit.result.Counts.md | 2 +- .../qiskit.result.LocalReadoutMitigator.md | 2 +- .../0.44/qiskit.result.ProbDistribution.md | 2 +- .../0.44/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/0.44/qiskit.result.Result.md | 2 +- .../qiskit/0.44/qiskit.result.ResultError.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 2 +- .../0.44/qiskit.synthesis.LieTrotter.md | 2 +- .../qiskit.synthesis.MatrixExponential.md | 2 +- .../0.44/qiskit.synthesis.ProductFormula.md | 2 +- .../qiskit/0.44/qiskit.synthesis.QDrift.md | 2 +- ...it.synthesis.SolovayKitaevDecomposition.md | 2 +- .../0.44/qiskit.synthesis.SuzukiTrotter.md | 2 +- .../0.44/qiskit.transpiler.AnalysisPass.md | 2 +- ...qiskit.transpiler.ConditionalController.md | 2 +- .../0.44/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.DoWhileController.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../0.44/qiskit.transpiler.FlowController.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.44/qiskit.transpiler.Layout.md | 2 +- .../0.44/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../0.44/qiskit.transpiler.PropertySet.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 2 +- .../qiskit/0.44/qiskit.transpiler.Target.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- .../0.44/qiskit.transpiler.TranspileLayout.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.AlignMeasures.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- .../qiskit.transpiler.passes.BIPMapping.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- .../qiskit.transpiler.passes.CXDirection.md | 2 +- ...skit.transpiler.passes.CheckCXDirection.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.44/qiskit.transpiler.passes.CheckMap.md | 2 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...r.passes.CommutativeInverseCancellation.md | 2 +- ...transpiler.passes.Commuting2qGateRouter.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- ...transpiler.passes.ConstrainedReschedule.md | 2 +- ...t.transpiler.passes.ContainsInstruction.md | 2 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 2 +- .../0.44/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.44/qiskit.transpiler.passes.Depth.md | 2 +- ...t.transpiler.passes.DynamicalDecoupling.md | 2 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- .../qiskit.transpiler.passes.GatesInBasis.md | 2 +- ...it.transpiler.passes.HighLevelSynthesis.md | 2 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 2 +- ...nspiler.passes.InstructionDurationCheck.md | 2 +- ...t.transpiler.passes.InverseCancellation.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- .../qiskit.transpiler.passes.MinimumPoint.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...passes.Optimize1qGatesSimpleCommutation.md | 2 +- ...kit.transpiler.passes.OptimizeCliffords.md | 2 +- .../0.44/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 2 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- ....passes.ResetAfterMeasureSimplification.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetIOLatency.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.44/qiskit.transpiler.passes.Size.md | 2 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 2 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- ...it.transpiler.passes.TimeUnitConversion.md | 2 +- ...iler.passes.TranslateParameterizedGates.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- ...qiskit.transpiler.passes.UnrollForLoops.md | 2 +- .../0.44/qiskit.transpiler.passes.Unroller.md | 2 +- .../qiskit.transpiler.passes.VF2Layout.md | 2 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 2 +- ...it.transpiler.passes.ValidatePulseGates.md | 2 +- .../0.44/qiskit.transpiler.passes.Width.md | 2 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 2 +- ....plugin.HighLevelSynthesisPluginManager.md | 2 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 2 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 2 +- ...rs.plugin.PassManagerStagePluginManager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 2 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 2 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 2 +- ...er.synthesis.aqc.ApproximatingObjective.md | 2 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 2 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 2 +- ...ler.synthesis.aqc.FastCNOTUnitObjective.md | 2 +- .../0.44/qiskit.utils.QuantumInstance.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 2 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.44/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.44/qpy.md | 6 +- docs/api/qiskit/0.44/quantum_info.md | 62 ++++---- docs/api/qiskit/0.44/result.md | 8 +- docs/api/qiskit/0.44/scheduler.md | 8 +- docs/api/qiskit/0.44/synthesis.md | 38 ++--- docs/api/qiskit/0.44/synthesis_aqc.md | 2 +- docs/api/qiskit/0.44/tools.md | 10 +- docs/api/qiskit/0.44/transpiler.md | 8 +- docs/api/qiskit/0.44/transpiler_plugins.md | 4 +- docs/api/qiskit/0.44/transpiler_preset.md | 26 ++-- docs/api/qiskit/0.44/utils.md | 38 ++--- docs/api/qiskit/0.44/visualization.md | 2 +- 761 files changed, 1070 insertions(+), 1070 deletions(-) diff --git a/docs/api/qiskit/0.44/algorithms.md b/docs/api/qiskit/0.44/algorithms.md index 3699076c3ff..4e4f8119710 100644 --- a/docs/api/qiskit/0.44/algorithms.md +++ b/docs/api/qiskit/0.44/algorithms.md @@ -197,7 +197,7 @@ Algorithms that compute the fidelity of pairs of quantum states. -`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/exceptions.py "view source code") +`qiskit.algorithms.AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. @@ -219,7 +219,7 @@ Utility functions used by algorithms. -`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/aux_ops_evaluator.py "view source code") Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. @@ -253,7 +253,7 @@ ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in P -`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/observables_evaluator.py "view source code") +`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.44/assembler.md b/docs/api/qiskit/0.44/assembler.md index 2c3802c6207..1dcf09cc24f 100644 --- a/docs/api/qiskit/0.44/assembler.md +++ b/docs/api/qiskit/0.44/assembler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.assembler -`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/assemble_circuits.py "view source code") +`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. @@ -69,7 +69,7 @@ qobj = assemble_circuits(circuits=[qc], -`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/assemble_schedules.py "view source code") +`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. @@ -135,7 +135,7 @@ pulseQobj = assemble_schedules(schedules=[schedule], -`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/disassemble.py "view source code") +`qiskit.assembler.disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.44/circuit.md b/docs/api/qiskit/0.44/circuit.md index a891b5af642..9e433ca70f4 100644 --- a/docs/api/qiskit/0.44/circuit.md +++ b/docs/api/qiskit/0.44/circuit.md @@ -288,7 +288,7 @@ with qc.switch(cr) as case: -`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/random/utils.py "view source code") +`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. @@ -333,7 +333,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c -`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/exceptions.py "view source code") +`qiskit.circuit.CircuitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/exceptions.py "view source code") Base class for errors raised while processing a circuit. diff --git a/docs/api/qiskit/0.44/circuit_classical.md b/docs/api/qiskit/0.44/circuit_classical.md index 08c6ac12430..e22bae03034 100644 --- a/docs/api/qiskit/0.44/circuit_classical.md +++ b/docs/api/qiskit/0.44/circuit_classical.md @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are -`qiskit.circuit.classical.expr.Expr`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") +`qiskit.circuit.classical.expr.Expr` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap -`final class qiskit.circuit.classical.expr.Var(var, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Var(var, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` -`final class qiskit.circuit.classical.expr.Value(value, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Value(value, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p -`final class qiskit.circuit.classical.expr.Unary(op, operand, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Unary(op, operand, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") A unary expression. @@ -118,7 +118,7 @@ Logical negation. `!operand`. -`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") A binary expression. @@ -235,7 +235,7 @@ Expressions in this system are defined to act only on certain sets of types. How -`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/expr.py "view source code") A cast from one type to another, implied by the use of an expression in a different context. @@ -251,7 +251,7 @@ The functions and methods described in this section are a more user-friendly way -`qiskit.circuit.classical.expr.lift(value, /, type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift(value, /, type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Lift the given Python `value` to a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value") or [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var"). @@ -291,7 +291,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo -`qiskit.circuit.classical.expr.cast(operand, type, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.cast(operand, type, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create an explicit cast from the given value to the given type. @@ -316,7 +316,7 @@ There are helper constructor functions for each of the unary operations. -`qiskit.circuit.classical.expr.bit_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -339,7 +339,7 @@ Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) -`qiskit.circuit.classical.expr.logic_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -364,7 +364,7 @@ Similarly, the binary operations and relations have helper functions defined. -`qiskit.circuit.classical.expr.bit_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -387,7 +387,7 @@ Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint -`qiskit.circuit.classical.expr.bit_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -410,7 +410,7 @@ Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint( -`qiskit.circuit.classical.expr.bit_xor(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_xor(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘exclusive or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -433,7 +433,7 @@ Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.logic_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -456,7 +456,7 @@ Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool -`qiskit.circuit.classical.expr.logic_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -479,7 +479,7 @@ Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool( -`qiskit.circuit.classical.expr.equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create an ‘equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -502,7 +502,7 @@ Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3 -`qiskit.circuit.classical.expr.not_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.not_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘not equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -525,7 +525,7 @@ Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Ui -`qiskit.circuit.classical.expr.less(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -548,7 +548,7 @@ Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3) -`qiskit.circuit.classical.expr.less_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -571,7 +571,7 @@ Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(Classi -`qiskit.circuit.classical.expr.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -594,7 +594,7 @@ Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.greater_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -619,7 +619,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition -`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/constructors.py "view source code") Lift a legacy two-tuple equality condition into a new-style [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"). @@ -648,7 +648,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/visitors.py "view source code") Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. @@ -720,7 +720,7 @@ For the convenience of simple visitors that only need to inspect the variables i -`qiskit.circuit.classical.expr.iter_vars(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.iter_vars(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/visitors.py "view source code") Get an iterator over the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") nodes referenced at any level in the given [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr"). @@ -750,7 +750,7 @@ Two expressions can be compared for direct structural equality by using the buil -`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/expr/visitors.py "view source code") Do these two expressions have exactly the same tree structure, up to some key function for the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") objects? @@ -809,7 +809,7 @@ All types inherit from an abstract base class: -`qiskit.circuit.classical.types.Type`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/types.py "view source code") +`qiskit.circuit.classical.types.Type` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/types.py "view source code") Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -821,13 +821,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q -`final class qiskit.circuit.classical.types.Bool`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Bool` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/types.py "view source code") The Boolean type. This has exactly two values: `True` and `False`. -`final class qiskit.circuit.classical.types.Uint(width)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Uint(width)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/types.py "view source code") An unsigned integer of fixed bit width. @@ -843,7 +843,7 @@ The low-level interface to querying the subtyping relationship is the [`order()` -`qiskit.circuit.classical.types.order(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.order(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") Get the ordering relationship between the two types as an enumeration value. @@ -872,7 +872,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. -`qiskit.circuit.classical.types.Ordering(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.Ordering(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -884,7 +884,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis -`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \le \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -915,7 +915,7 @@ False -`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \ge \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -946,7 +946,7 @@ False -`qiskit.circuit.classical.types.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classical/types/ordering.py "view source code") Get the greater of the two types, assuming that there is an ordering relation between them. Technically, this is a slightly restricted version of the concept of the ‘meet’ of the two types in that the return value must be one of the inputs. In practice in the type system there is no concept of a ‘sum’ type, so the ‘meet’ exists if and only if there is an ordering between the two types, and is equal to the greater of the two types. diff --git a/docs/api/qiskit/0.44/circuit_library.md b/docs/api/qiskit/0.44/circuit_library.md index c8f8fc61547..3d0e4f356e1 100644 --- a/docs/api/qiskit/0.44/circuit_library.md +++ b/docs/api/qiskit/0.44/circuit_library.md @@ -317,7 +317,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib -`qiskit.circuit.library.templates.nct.template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** @@ -331,7 +331,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** @@ -345,7 +345,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** @@ -359,7 +359,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** @@ -373,7 +373,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** @@ -387,7 +387,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** @@ -401,7 +401,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** @@ -415,7 +415,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** @@ -429,7 +429,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** @@ -443,7 +443,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** @@ -457,7 +457,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** @@ -471,7 +471,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** @@ -485,7 +485,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** @@ -499,7 +499,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** @@ -513,7 +513,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** @@ -527,7 +527,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** @@ -541,7 +541,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** @@ -555,7 +555,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** @@ -569,7 +569,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** @@ -583,7 +583,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** @@ -597,7 +597,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** @@ -611,7 +611,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** @@ -625,7 +625,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** @@ -639,7 +639,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** @@ -653,7 +653,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** @@ -667,7 +667,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** @@ -681,7 +681,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** @@ -695,7 +695,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** @@ -709,7 +709,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** @@ -723,7 +723,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** @@ -737,7 +737,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** @@ -751,7 +751,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** @@ -765,7 +765,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** @@ -779,7 +779,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** @@ -793,7 +793,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** @@ -807,7 +807,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** @@ -821,7 +821,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** @@ -835,7 +835,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** @@ -849,7 +849,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** @@ -863,7 +863,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** @@ -877,7 +877,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** @@ -891,7 +891,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** @@ -905,7 +905,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** @@ -919,7 +919,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** @@ -933,7 +933,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** @@ -947,7 +947,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** @@ -961,7 +961,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** @@ -979,7 +979,7 @@ Template circuits over Clifford gates. -`qiskit.circuit.library.clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`qiskit.circuit.library.clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** @@ -993,7 +993,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`qiskit.circuit.library.clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** @@ -1007,7 +1007,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`qiskit.circuit.library.clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** @@ -1021,7 +1021,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`qiskit.circuit.library.clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** @@ -1035,7 +1035,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`qiskit.circuit.library.clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** @@ -1049,7 +1049,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`qiskit.circuit.library.clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** @@ -1063,7 +1063,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`qiskit.circuit.library.clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** @@ -1077,7 +1077,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`qiskit.circuit.library.clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** @@ -1091,7 +1091,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`qiskit.circuit.library.clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** @@ -1105,7 +1105,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`qiskit.circuit.library.clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** @@ -1119,7 +1119,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`qiskit.circuit.library.clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** @@ -1133,7 +1133,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`qiskit.circuit.library.clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** @@ -1147,7 +1147,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`qiskit.circuit.library.clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** @@ -1161,7 +1161,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`qiskit.circuit.library.clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** @@ -1175,7 +1175,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`qiskit.circuit.library.clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** @@ -1189,7 +1189,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`qiskit.circuit.library.clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** @@ -1203,7 +1203,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`qiskit.circuit.library.clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** @@ -1217,7 +1217,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`qiskit.circuit.library.clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** @@ -1235,7 +1235,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui -`qiskit.circuit.library.rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`qiskit.circuit.library.rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. @@ -1243,7 +1243,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`qiskit.circuit.library.rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. @@ -1251,7 +1251,7 @@ Template for CX - RXGate - CX. -`qiskit.circuit.library.rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`qiskit.circuit.library.rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. @@ -1259,7 +1259,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`qiskit.circuit.library.rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. @@ -1267,7 +1267,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`qiskit.circuit.library.rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. @@ -1275,7 +1275,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`qiskit.circuit.library.rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.44/compiler.md b/docs/api/qiskit/0.44/compiler.md index 01d8f86b845..0c60832f5d5 100644 --- a/docs/api/qiskit/0.44/compiler.md +++ b/docs/api/qiskit/0.44/compiler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.compiler -`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/assembler.py "view source code") +`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. @@ -107,7 +107,7 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will -`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/scheduler.py "view source code") +`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`. @@ -136,7 +136,7 @@ A pulse `Schedule` that implements the input circuit -`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/transpiler.py "view source code") +`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. @@ -284,7 +284,7 @@ The transpiled circuit(s). -`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/sequencer.py "view source code") +`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.44/converters.md b/docs/api/qiskit/0.44/converters.md index c10af85d951..e20b55110c4 100644 --- a/docs/api/qiskit/0.44/converters.md +++ b/docs/api/qiskit/0.44/converters.md @@ -22,7 +22,7 @@ python_api_name: qiskit.converters -`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_dag.py "view source code") +`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_dag.py "view source code") Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -66,7 +66,7 @@ dag = circuit_to_dag(circ) -`qiskit.converters.dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dag_to_circuit.py "view source code") +`qiskit.converters.dag_to_circuit(dag, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. @@ -110,7 +110,7 @@ circuit.draw('mpl') -`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_instruction.py "view source code") +`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -155,7 +155,7 @@ circuit_to_instruction(circ) -`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_gate.py "view source code") +`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -184,7 +184,7 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g -`qiskit.converters.ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/ast_to_dag.py "view source code") +`qiskit.converters.ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. @@ -226,7 +226,7 @@ dag = ast_to_dag(ast) -`qiskit.converters.dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dagdependency_to_circuit.py "view source code") +`qiskit.converters.dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. @@ -246,7 +246,7 @@ the circuit representing the input dag dependency. -`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_dagdependency.py "view source code") +`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -267,7 +267,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dag_to_dagdependency.py "view source code") +`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. @@ -288,7 +288,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dagdependency_to_dag.py "view source code") +`qiskit.converters.dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.44/dagcircuit.md b/docs/api/qiskit/0.44/dagcircuit.md index f301b4e60b1..573698e65fa 100644 --- a/docs/api/qiskit/0.44/dagcircuit.md +++ b/docs/api/qiskit/0.44/dagcircuit.md @@ -36,7 +36,7 @@ python_api_name: qiskit.dagcircuit -`qiskit.dagcircuit.DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. @@ -46,7 +46,7 @@ Set the error message. -`qiskit.dagcircuit.DAGDependencyError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGDependencyError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGDependency object. diff --git a/docs/api/qiskit/0.44/exceptions.md b/docs/api/qiskit/0.44/exceptions.md index 588db159069..56e17f132ee 100644 --- a/docs/api/qiskit/0.44/exceptions.md +++ b/docs/api/qiskit/0.44/exceptions.md @@ -24,7 +24,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: -`qiskit.exceptions.QiskitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") Base class for errors raised by Qiskit. @@ -42,7 +42,7 @@ Qiskit has several optional features that depend on other packages that are not -`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") +`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") Raised when an optional library is missing. @@ -54,7 +54,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, -`qiskit.exceptions.QiskitUserConfigError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitUserConfigError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") Raised when an error is encountered reading a user config file. @@ -64,7 +64,7 @@ Set the error message. -`qiskit.exceptions.InvalidFileError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") +`qiskit.exceptions.InvalidFileError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/exceptions.py "view source code") Raised when the file provided is not valid for the specific task. diff --git a/docs/api/qiskit/0.44/execute.md b/docs/api/qiskit/0.44/execute.md index 89472ff320f..09c0e694b9a 100644 --- a/docs/api/qiskit/0.44/execute.md +++ b/docs/api/qiskit/0.44/execute.md @@ -22,7 +22,7 @@ python_api_name: qiskit.execute_function -`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/execute_function.py "view source code") +`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.44/extensions.md b/docs/api/qiskit/0.44/extensions.md index 1c66494399d..7ee5d71c949 100644 --- a/docs/api/qiskit/0.44/extensions.md +++ b/docs/api/qiskit/0.44/extensions.md @@ -55,7 +55,7 @@ The additional gates in this module will tend to raise a custom exception when t -`qiskit.extensions.ExtensionError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/exceptions.py "view source code") +`qiskit.extensions.ExtensionError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/exceptions.py "view source code") Base class for errors raised by extensions module. diff --git a/docs/api/qiskit/0.44/opflow.md b/docs/api/qiskit/0.44/opflow.md index dda9bc3ce1b..30b8f72277d 100644 --- a/docs/api/qiskit/0.44/opflow.md +++ b/docs/api/qiskit/0.44/opflow.md @@ -99,7 +99,7 @@ The Converter submodules include objects which manipulate Operators, usually rec -`qiskit.opflow.commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/utils.py "view source code") Deprecated: Compute commutator of op\_a and op\_b. @@ -128,7 +128,7 @@ the commutator -`qiskit.opflow.anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/utils.py "view source code") Deprecated: Compute anti-commutator of op\_a and op\_b. @@ -157,7 +157,7 @@ the anti-commutator -`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/utils.py "view source code") Deprecated: Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) @@ -200,7 +200,7 @@ the double commutator -`qiskit.opflow.OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/exceptions.py "view source code") +`qiskit.opflow.OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/exceptions.py "view source code") Deprecated: For Opflow specific errors. diff --git a/docs/api/qiskit/0.44/providers.md b/docs/api/qiskit/0.44/providers.md index 494033d200d..a58fdab9cef 100644 --- a/docs/api/qiskit/0.44/providers.md +++ b/docs/api/qiskit/0.44/providers.md @@ -79,7 +79,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p -`qiskit.providers.QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. @@ -89,7 +89,7 @@ Set the error message. -`qiskit.providers.BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. @@ -99,7 +99,7 @@ Set the error message. -`qiskit.providers.JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. @@ -109,7 +109,7 @@ Set the error message. -`qiskit.providers.JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. @@ -119,7 +119,7 @@ Set the error message. -`qiskit.providers.BackendConfigurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendConfigurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/exceptions.py "view source code") Base class for errors raised by the BackendConfiguration. diff --git a/docs/api/qiskit/0.44/pulse.md b/docs/api/qiskit/0.44/pulse.md index c638487daae..ba17d74993c 100644 --- a/docs/api/qiskit/0.44/pulse.md +++ b/docs/api/qiskit/0.44/pulse.md @@ -77,7 +77,7 @@ These are all instances of the same base class: -`qiskit.pulse.instructions.Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/instruction.py "view source code") +`qiskit.pulse.instructions.Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -123,7 +123,7 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -`qiskit.pulse.library.constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -151,7 +151,7 @@ $$ -`qiskit.pulse.library.zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -178,7 +178,7 @@ $$ -`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -210,7 +210,7 @@ with the convention $\text{sign}(0) = 1$. -`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -259,7 +259,7 @@ plt.show() -`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -308,7 +308,7 @@ plt.show() -`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -338,7 +338,7 @@ $$ -`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -368,7 +368,7 @@ $$ -`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -410,7 +410,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -442,7 +442,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -482,7 +482,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -513,7 +513,7 @@ i.e. the derivative of $\text{sech}$. -`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -557,7 +557,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -649,7 +649,7 @@ All channels are children of the same abstract base class: -`qiskit.pulse.channels.Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.Channel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -704,7 +704,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`qiskit.pulse.transforms.AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -720,7 +720,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -745,7 +745,7 @@ A `Schedule` with the additional acquisition instructions. -`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. @@ -814,7 +814,7 @@ The input list of schedules transformed to have their measurements aligned. -`qiskit.pulse.transforms.block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. @@ -843,7 +843,7 @@ Scheduled pulse program. -`qiskit.pulse.transforms.compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. @@ -863,7 +863,7 @@ Compressed schedules. -`qiskit.pulse.transforms.flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. @@ -887,7 +887,7 @@ Flatten pulse program. -`qiskit.pulse.transforms.inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. @@ -913,7 +913,7 @@ A schedule without subroutine. -`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. @@ -941,7 +941,7 @@ The padded schedule. -`qiskit.pulse.transforms.remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. @@ -961,7 +961,7 @@ A schedule without directives. -`qiskit.pulse.transforms.remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. @@ -987,7 +987,7 @@ The DAG transforms create DAG representation of input program. This can be used -`qiskit.pulse.transforms.block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/dag.py "view source code") +`qiskit.pulse.transforms.block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. @@ -1047,7 +1047,7 @@ A sequence of transformations to generate a target code. -`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/base_transforms.py "view source code") +`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. @@ -1260,7 +1260,7 @@ The above is just a small taste of what is possible with the builder. See the re -`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. @@ -1324,7 +1324,7 @@ DriveChannel(0) -`qiskit.pulse.builder.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. @@ -1352,7 +1352,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. @@ -1389,7 +1389,7 @@ List of control channels associated with the supplied ordered list of qubits. -`qiskit.pulse.builder.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. @@ -1417,7 +1417,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. @@ -1478,7 +1478,7 @@ drive_sched.draw() -`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1517,7 +1517,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. @@ -1586,7 +1586,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1802,7 +1802,7 @@ ScheduleBlock( -`qiskit.pulse.builder.delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. @@ -1827,7 +1827,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. @@ -1852,7 +1852,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. @@ -1879,7 +1879,7 @@ main_prog.assign_references(subroutine_dict={("x_gate", "q0"): subroutine}) -`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. @@ -1904,7 +1904,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. @@ -1931,7 +1931,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. @@ -1956,7 +1956,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. @@ -1983,7 +1983,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Simulator snapshot. @@ -2027,7 +2027,7 @@ pulse_prog.draw() -`qiskit.pulse.builder.align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. @@ -2075,7 +2075,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. @@ -2129,7 +2129,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. @@ -2166,7 +2166,7 @@ None -`qiskit.pulse.builder.align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. @@ -2203,7 +2203,7 @@ None -`qiskit.pulse.builder.align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. @@ -2240,7 +2240,7 @@ None -`qiskit.pulse.builder.circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. @@ -2271,7 +2271,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. @@ -2317,7 +2317,7 @@ None -`qiskit.pulse.builder.phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. @@ -2354,7 +2354,7 @@ None -`qiskit.pulse.builder.transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. @@ -2404,7 +2404,7 @@ MemorySlot(0) -`qiskit.pulse.builder.measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. @@ -2461,7 +2461,7 @@ The `register` the qubit measurement result will be stored in. -`qiskit.pulse.builder.measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. @@ -2496,7 +2496,7 @@ The `register`s the qubit measurement results will be stored in. -`qiskit.pulse.builder.delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -2546,7 +2546,7 @@ with pulse.build(backend) as u3_sched: -`qiskit.pulse.builder.cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. @@ -2570,7 +2570,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. @@ -2596,7 +2596,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. @@ -2622,7 +2622,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. @@ -2648,7 +2648,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. @@ -2701,7 +2701,7 @@ There are 1e-06 seconds in 4500 samples. -`qiskit.pulse.builder.active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. @@ -2723,7 +2723,7 @@ builder context. -`qiskit.pulse.builder.active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. @@ -2754,7 +2754,7 @@ with pulse.build(backend, -`qiskit.pulse.builder.active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. @@ -2786,7 +2786,7 @@ with pulse.build( -`qiskit.pulse.builder.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. @@ -2818,7 +2818,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. @@ -2854,7 +2854,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2874,7 +2874,7 @@ The time that elapses in `samples`. -`qiskit.pulse.builder.seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. @@ -2904,7 +2904,7 @@ The number of samples for the time to elapse -`qiskit.pulse.PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. @@ -2914,7 +2914,7 @@ Set the error message. -`qiskit.pulse.BackendNotSet(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.BackendNotSet(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") Raised if the builder context does not have a backend. @@ -2924,7 +2924,7 @@ Set the error message. -`qiskit.pulse.NoActiveBuilder(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.NoActiveBuilder(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") Raised if no builder context is active. @@ -2934,7 +2934,7 @@ Set the error message. -`qiskit.pulse.UnassignedDurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedDurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") Raised if instruction duration is unassigned. @@ -2944,7 +2944,7 @@ Set the error message. -`qiskit.pulse.UnassignedReferenceError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedReferenceError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/exceptions.py "view source code") Raised if subroutine is unassigned. diff --git a/docs/api/qiskit/0.44/qasm.md b/docs/api/qiskit/0.44/qasm.md index 1d39545efe5..886b6c64196 100644 --- a/docs/api/qiskit/0.44/qasm.md +++ b/docs/api/qiskit/0.44/qasm.md @@ -22,7 +22,7 @@ python_api_name: qiskit.qasm -`qiskit.qasm.Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/qasm.py "view source code") +`qiskit.qasm.Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. @@ -32,19 +32,19 @@ Create an OPENQASM circuit object. -`qiskit.qasm.OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. -`qiskit.qasm.QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). -`qiskit.qasm.QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.44/qasm2.md b/docs/api/qiskit/0.44/qasm2.md index b993ccef7e3..affaa890d0e 100644 --- a/docs/api/qiskit/0.44/qasm2.md +++ b/docs/api/qiskit/0.44/qasm2.md @@ -32,7 +32,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -57,7 +57,7 @@ A circuit object representing the same OpenQASM 2 program. -`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -87,7 +87,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/parse.py "view source code") +`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/parse.py "view source code") Information about a custom instruction that should be defined during the parse. @@ -125,7 +125,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep -`qiskit.qasm2.QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2Error(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/exceptions.py "view source code") A general error raised by the OpenQASM 2 interoperation layer. @@ -137,7 +137,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`qiskit.qasm2.QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to parse an OpenQASM 2 file. @@ -149,7 +149,7 @@ Similarly, a failure during the export of an OpenQASM 2 program will raise its o -`qiskit.qasm2.QASM2ExportError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ExportError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. diff --git a/docs/api/qiskit/0.44/qasm3.md b/docs/api/qiskit/0.44/qasm3.md index b8ba9cca77c..ff55c6e0b2c 100644 --- a/docs/api/qiskit/0.44/qasm3.md +++ b/docs/api/qiskit/0.44/qasm3.md @@ -28,7 +28,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`qiskit.qasm3.dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. @@ -42,7 +42,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`qiskit.qasm3.dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. @@ -63,7 +63,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/exporter.py "view source code") +`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -117,7 +117,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`qiskit.qasm3.QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -129,7 +129,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`qiskit.qasm3.ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/experimental.py "view source code") +`qiskit.qasm3.ExperimentalFeatures(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/experimental.py "view source code") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -190,7 +190,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`qiskit.qasm3.load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -214,7 +214,7 @@ a circuit representation of the OpenQASM 3 program. -`qiskit.qasm3.loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -240,7 +240,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`qiskit.qasm3.QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.md index 5dc1d786f7f..53ad8d2c91e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/algorithm_job.py "view source code") +`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/algorithm_job.py "view source code") Bases: `PrimitiveJob` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.md index 21b04275686..624d3c04100 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.md index 1070fd930d3..6ebcc47c22e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`qiskit.algorithms.AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`qiskit.algorithms.AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.md index 6ba55b43d8b..8e7104f5adc 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.md index 4c744fc461b..cf985537152 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`qiskit.algorithms.AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.md index 755b7bd93c4..ab7fd91f87d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`qiskit.algorithms.AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.md index f3c6e607818..0c391089aad 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`qiskit.algorithms.AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.md index 4b27c2fc0d5..295a62fa3fe 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`qiskit.algorithms.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.md index 242ed973c2e..056f1ab5c43 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`qiskit.algorithms.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.md index b44ec3e63af..aba8e39d670 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.md index 32a88ecad10..ec395da5a84 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.md index 653edd7f7d8..a4e51f4582c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.md index 14b4de34523..d254bb6baa2 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.md index d92430bf33c..088afadbf55 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`qiskit.algorithms.FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.44/qiskit.algorithms.Grover.md index 00ca6eedd76..f06f77b529e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.md index 7520d991292..18801134920 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`qiskit.algorithms.GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.md index d6f07c93b5a..512b0bdcdb3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 4672016aafb..c27a84db467 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.md index 6690466d667..d04902bd5de 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`qiskit.algorithms.ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`qiskit.algorithms.ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.md index 6923bf00a75..a3a59deca51 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`qiskit.algorithms.ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`qiskit.algorithms.ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.md index f30343dce7b..155203abc6c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index 65c27f87570..0404b3ecb4b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`qiskit.algorithms.IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.md index 375e55bd49b..7449bf62488 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 9981eee035b..65ece02f61e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 8fbcdcfaa8c..5656ab0e214 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.md index 25dca1a3e0b..f44f6dfbad8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`qiskit.algorithms.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.md index 26bfc8dd2df..e02271582d0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`qiskit.algorithms.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.md index 827729ed9d9..f516e934b8e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.md index 3bc59de1589..469e7dff5c2 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.md index bbf724aa260..aba0065556d 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.md index 16ae0d954db..0639dce18f7 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.md index c28cf88a730..c3a157b22e5 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.md index c3025632434..111cbea90a7 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `PhaseEstimatorResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.md index cf130ce2931..ae7963077ed 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`qiskit.algorithms.PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`qiskit.algorithms.PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.md index 6ac9a4c2fff..611ab2aa1ba 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.md index e6c39ecca78..c65764fecc0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`qiskit.algorithms.RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`qiskit.algorithms.RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.md index edc504d2c81..b3846907256 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`qiskit.algorithms.RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`qiskit.algorithms.RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.md index d45fcf8fce8..57b890a0213 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.md index 102ee359c64..f8d4f7738f6 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`qiskit.algorithms.SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`qiskit.algorithms.SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.md index a0c0109709a..36b819d6046 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.md index cfb3d2eb581..8a4e3db1e53 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.md index cbd58c1bc85..48cc2afaada 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.44/qiskit.algorithms.VQD.md index 5edfdb6f5a7..4877211a076 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.md index 477b8fe5d3b..895c8df3a98 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`qiskit.algorithms.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.44/qiskit.algorithms.VQE.md index 22ffe33253e..a0491a00f2f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.md index 4e7bdd76fa3..b158599d11c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.md index a764b1c1977..118ba9ae57c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.md index fca6ffd3452..f0dfde00b20 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`qiskit.algorithms.eigensolvers.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.md index 995211f8d4d..b6882da2183 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`qiskit.algorithms.eigensolvers.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index 74e8ad231c5..9cfad779e44 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index 4bd8d51d994..4e302f5260a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`qiskit.algorithms.eigensolvers.NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.md index 22fabe82d6d..c4f72c90fc7 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.md index cb0257451ad..ce9ab2bee2e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`qiskit.algorithms.eigensolvers.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 426d6afacdb..4bb5f31547e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.md index b963b45c1bb..2674e8031eb 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/base_qgt.py "view source code") +`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/base_qgt.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.md index 04e29dc1142..0af604821c6 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.md index 1a7c1b0f1a4..f20a551bde9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") +`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index d41767ddc27..2249836e4d2 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index b8af02544d5..5040cf2341c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index 30d6d7420e6..92fd9ab233f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.md index 5b7abebaa6f..90166bc7831 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") +`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.md index 7759d685912..5383d0a63bd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 2924b86f586..7d974362a3c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 40f0ab81899..cc92c3d346c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.md index eb71c01fab2..1efedacf663 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`qiskit.algorithms.gradients.QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/qfi.py "view source code") +`qiskit.algorithms.gradients.QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/qfi.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.md index aba154fad98..9bf00bef9e9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/qfi_result.py "view source code") +`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.md index c91b2e2d997..18d406d6d9c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/qgt_result.py "view source code") +`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/qgt_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index 0f5d712da43..155b38770dd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") +`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.md index b4f247d8b69..fb056375a85 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") +`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 10dd2dfac24..4e74c3486d6 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.md index c1152812fbe..2df0b6b51c8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.md index 0b336db4045..73917526c6a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") +`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 5fd96eb2ffa..838a4adea2b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index bc61ea08713..79ee20c18f3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index a7f1c67cac7..6b04b085b35 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index c6fa951ac86..c3270d6426e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 33f69587ae8..b03bebbdf96 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index ecc5d8c8207..85ed188e8e9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.md index 0abde3b588e..a789ea6a94e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index ed55cfc4d63..d21899d281f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 86da01794b9..63c5f4e5968 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index f7d49576309..7750dd07f2c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index 91929572454..64da25ec057 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.md index 6f3896f714d..41a0115055b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 4b2acd97f08..f0b48a3ced4 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`qiskit.algorithms.minimum_eigensolvers.VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.md index 25e59c6bd1c..b857832f06b 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.md index da92c8f04ba..07a2aad86fc 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/aqgd.py "view source code") +`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.md index 2d89ef02fe8..9fefb209f91 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.md index 4801fe28066..520acc02c0c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.md index 4a5d350029f..64592808f6e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/cg.py "view source code") +`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.md index f2bbac1bb83..07c4f4dc3fd 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/cobyla.py "view source code") +`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.md index 866ec18e259..d3b59d9f47a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`qiskit.algorithms.optimizers.CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`qiskit.algorithms.optimizers.CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.md index e6065ade5c7..4f767c2d02c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 5324f736512..7478e8df799 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.md index c796d206f80..9438453c002 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`qiskit.algorithms.optimizers.ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`qiskit.algorithms.optimizers.ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.md index 6efa5fe9b52..71edd1340a0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/gsls.py "view source code") +`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.md index 60e769a09be..d3b8bb498b9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.md index 52290b4dd20..1864acc381c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.md index dd737097c88..7dbfbb7f94f 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/imfil.py "view source code") +`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.md index f255fee1157..3a0099e0be8 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`qiskit.algorithms.optimizers.ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`qiskit.algorithms.optimizers.ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.md index be4840d8280..78d86619a72 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.md index 5fef0d62a29..861f4a09f92 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.md index 7d864484274..398a6ed1267 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.md index 6f40ad2db0e..b27fdbebc57 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nft.py "view source code") +`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.md index 8fa74f68731..6b62e562315 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`qiskit.algorithms.optimizers.Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.md index 851272e664e..af86eccb72c 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`qiskit.algorithms.optimizers.OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.md index 5deaf60c8ea..283d4d38ace 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index dc1bd242d16..c2fcbe4d5f3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.md index fd4e6b37ada..f477d7c9958 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/powell.py "view source code") +`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.md index 6ef39d6c0df..028c48a07e9 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.P_BFGS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.md index 056d3fda0ea..09322623fee 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.md index da19d3ed27f..5bcd36ef2d3 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/slsqp.py "view source code") +`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.md index 98662c87fbf..d55510cc626 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/snobfit.py "view source code") +`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.md index ebf3818ae50..3164d190b11 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/spsa.py "view source code") +`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.md index 837c3370b6c..dc531b9c564 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.md index 76644867700..4d328b3df67 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.md index 6e92d2f51aa..6f6f6f4ecef 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/tnc.py "view source code") +`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.md index ea3abd90956..1ef8850905a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.md index 330e800adf5..26a2e061a37 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/umda.py "view source code") +`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 40f9a8939f5..5b071217d80 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index 73636ab4410..8874252bbe5 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`qiskit.algorithms.state_fidelities.BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`qiskit.algorithms.state_fidelities.BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.md index f9a9f5c97f9..f9784156f05 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.md index 7b5f8e9c561..429dae1f945 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index 529b20ffc38..df6e8f633e0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index f8cf3f0f950..def5609fd6e 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `OdeSolver` diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index 78c53c59bae..9eb2ec3f95a 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index dcf32ab4e57..9540ba52003 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index b30c9e5f9d8..ecac0c15598 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index c0b084eb8e2..dcdaeea8b32 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 7cd23916a86..a27aa900de0 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.44/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.md index 0c37d7d6b52..2587d611f6b 100644 --- a/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.44/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/run_config.py "view source code") +`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/assembler/run_config.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.md index 4c10b79ae62..b2dbcc24de3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`qiskit.circuit.AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.md index b0837551d6c..306ddef4780 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Bit.md b/docs/api/qiskit/0.44/qiskit.circuit.Bit.md index 0c631c8339d..c4100b3cdaf 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`qiskit.circuit.Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/bit.py "view source code") +`qiskit.circuit.Bit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/bit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.md index cf1e77f865d..e2fea700d7d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/break_loop.py "view source code") +`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.md index 47be4220208..a83866d489d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumcircuitdata.py "view source code") +`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.md index bb9afe622a8..e74f5548095 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.44/qiskit.circuit.Clbit.md index 67727395c91..d499630d572 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`qiskit.circuit.Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.md index 664f51a5831..f3d79e25d04 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/continue_loop.py "view source code") +`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.md index a86edd7f82b..318249b2ec0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/control_flow.py "view source code") +`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.md index c506f497533..3c1cd55b349 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlledgate.py "view source code") +`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlledgate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Delay.md b/docs/api/qiskit/0.44/qiskit.circuit.Delay.md index 0ad83deb5f6..23b285ff1d3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`qiskit.circuit.Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/delay.py "view source code") +`qiskit.circuit.Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/delay.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.md index 306f9f61887..1915ed4e0ba 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`qiskit.circuit.EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/equivalence.py "view source code") +`qiskit.circuit.EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/equivalence.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.md index f71d7199555..894dc0a968d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/for_loop.py "view source code") +`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Gate.md b/docs/api/qiskit/0.44/qiskit.circuit.Gate.md index afcaabe5ece..dc9a236f43c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`qiskit.circuit.Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/gate.py "view source code") +`qiskit.circuit.Gate(name, num_qubits, params, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/gate.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.md index 248ddbd8f96..5f78a98f655 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/if_else.py "view source code") +`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.44/qiskit.circuit.Instruction.md index bb553f56fb8..a46612084fd 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/instruction.py "view source code") +`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/instruction.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.md index e272c2cab77..6ae17c97369 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`qiskit.circuit.InstructionSet(*, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/instructionset.py "view source code") +`qiskit.circuit.InstructionSet(*, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/instructionset.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Operation.md b/docs/api/qiskit/0.44/qiskit.circuit.Operation.md index d6bd0850f75..9274e92e3b1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`qiskit.circuit.Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/operation.py "view source code") +`qiskit.circuit.Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/operation.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.44/qiskit.circuit.Parameter.md index 4019ef1277e..a259cf9838c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`qiskit.circuit.Parameter(name, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/parameter.py "view source code") +`qiskit.circuit.Parameter(name, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/parameter.py "view source code") Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.md index 7f9f630e34b..9b997b8ecda 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`qiskit.circuit.ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/parameterexpression.py "view source code") +`qiskit.circuit.ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/parameterexpression.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.md index 31f77984d52..11e14381378 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`qiskit.circuit.ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/parametervector.py "view source code") +`qiskit.circuit.ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/parametervector.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.md index af957c2a4b3..fc404e8977b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumcircuit.py "view source code") +`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.md index 1641b183403..876564fb7c0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.44/qiskit.circuit.Qubit.md index 92d7da7da9c..1f01f1197e6 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`qiskit.circuit.Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.Register.md b/docs/api/qiskit/0.44/qiskit.circuit.Register.md index fa5c4395420..778e98260a4 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.Register.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`qiskit.circuit.Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/register.py "view source code") +`qiskit.circuit.Register(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/register.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.md index e7ba66292e3..c9f7a0542ff 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/switch_case.py "view source code") +`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/switch_case.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.md index d93debd5b5d..9f7ec73adad 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`qiskit.circuit.WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/while_loop.py "view source code") +`qiskit.circuit.WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.md index c20c3a8280f..33a7bf3f677 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.md index 1ce635f4424..f58c9e393c0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index e9965f23261..d681dd8419e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 5d3efb235c4..da07ebd41ab 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.44/qiskit.circuit.library.AND.md index 79c03d1ae37..9fd1d1042a2 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.md index 11b40125639..34700884faa 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`qiskit.circuit.library.Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/barrier.py "view source code") +`qiskit.circuit.library.Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/barrier.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.md index 0624c74a8bf..1d854d444ad 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`qiskit.circuit.library.C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3SXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.md index e3b584c8746..3ab74c18f85 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`qiskit.circuit.library.C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.md index ccc468a942a..2d5eac2d869 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`qiskit.circuit.library.C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C4XGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.md index 160deb66d3b..47c52a1d7d3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`qiskit.circuit.library.CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CCXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.md index 8514c5d9590..296122ceff1 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`qiskit.circuit.library.CCZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CCZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.md index 01ff4b28381..0a6ab882a96 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.md index ad9e1e6c6aa..7b9579ef254 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`qiskit.circuit.library.CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.CHGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.md index 1c08f135c71..cd5ef7f4c09 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.md index 0391a68afdf..c10f61a850e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.md index 021ffcbfbce..e67fee6f201 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.md index a61263fd3b5..47fcd6429f0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.md index 82e68852176..d47f6f06730 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`qiskit.circuit.library.CSGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.md index 8623e7f3be2..c53e5619f20 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`qiskit.circuit.library.CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.CSXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.md index 89cdff18c90..6cdcc2d8e22 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`qiskit.circuit.library.CSdgGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSdgGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.md index 3a3f661b632..391e2259080 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`qiskit.circuit.library.CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.CSwapGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.md index 665301c94b4..89d04ecf331 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.md index 8fcac5f2cf5..8d0e483f20b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.md index 3b7dfc1aba1..4f2b3399a49 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.md index 5d4ba8c976e..752ad607c44 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`qiskit.circuit.library.CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CXGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.md index 639080edafc..0ffd33c65c3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`qiskit.circuit.library.CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.CYGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.md index 098fb8b859b..1810dfbc6cb 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`qiskit.circuit.library.CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CZGate(label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.md index 2849536aa56..7a4c66a5cce 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`qiskit.circuit.library.DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`qiskit.circuit.library.DCXGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.md index 1040062aafa..0b1d900af64 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`qiskit.circuit.library.Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.md index 40599a5442a..f9e0912dbbe 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.md index c8abc61ef74..eab5dd303ac 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`qiskit.circuit.library.ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`qiskit.circuit.library.ECRGate` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.md index 47be73e0737..1622ceb43fe 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 0f0efbe4e58..13fb67cd9ff 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.md index 6afd37efbf2..ce558cd8966 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.md index 21ea938088a..84ec25f7382 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.md index 916b739a98b..dd89ca89036 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`qiskit.circuit.library.FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/fourier_checking.py "view source code") +`qiskit.circuit.library.FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.md index 30ddeb00180..67edd342fc3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.md index 7450a40e8e8..9ca5b359119 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`qiskit.circuit.library.GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GR.md index c2846e92c16..a3d8bf63610 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`qiskit.circuit.library.GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.md index 9abbbe7ad51..9e8c265ec51 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`qiskit.circuit.library.GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.md index 709299f2f52..a9cfa746604 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`qiskit.circuit.library.GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.md index 76400e5dc91..6a3dae37887 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`qiskit.circuit.library.GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.md index 7860844bc78..955944c5c3e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`qiskit.circuit.library.GlobalPhaseGate(phase, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`qiskit.circuit.library.GlobalPhaseGate(phase, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.md index 03f505dcbc3..2f80890f427 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`qiskit.circuit.library.GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/graph_state.py "view source code") +`qiskit.circuit.library.GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/graph_state.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.md index 0d61cd94080..7c86ea76938 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/grover_operator.py "view source code") +`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.md index a3cde148066..17826f920bf 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`qiskit.circuit.library.HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.HGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.md index 51d1ec7faed..ff185164152 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.md index 2eac58b22b7..457005a4d55 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/hidden_linear_function.py "view source code") +`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.md index 8fd08dd95c9..0960ccecd6a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`qiskit.circuit.library.IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/i.py "view source code") +`qiskit.circuit.library.IGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.md index f6f5b74a0d8..07fcde6cf2b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`qiskit.circuit.library.IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/iqp.py "view source code") +`qiskit.circuit.library.IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/iqp.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.md index 3a9989ad2f6..c5a5f2516fe 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`qiskit.circuit.library.InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`qiskit.circuit.library.InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.md index 06692b4352d..4ae8ecc1f4b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.md index a0f0515acec..1b16a40d0a4 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.md index e4dbf7b5788..eeef44021af 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`qiskit.circuit.library.LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`qiskit.circuit.library.LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.md index e42fd33f532..c54da802e2d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.md index 9fb947ce26f..8bd58c61d7b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.md index 99aa4a9fbaa..14adc97b608 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.md index e54b696da45..efc81540376 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.md index e7f8d634cab..0d607c5472b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.md index 9490c2c7bca..2309b8ba442 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.md index c5f20893ab3..9f7ebec16b7 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.md index 029ac091010..4065490c56c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.md index 9d51dae665a..ed82f9cc011 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.md index 3a15189ffd7..bb2b83ddf74 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`qiskit.circuit.library.Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/measure.py "view source code") +`qiskit.circuit.library.Measure` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/measure.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.md index 9c545b402fd..1011d3c9cc9 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/n_local.py "view source code") +`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.44/qiskit.circuit.library.OR.md index f86b9004bf3..41ba7a2bc74 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.md index 4f949c41774..90b669a7376 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/pauli_evolution.py "view source code") +`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.md index 21257b4b39c..fb331f7bdc2 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.md index 291215c5bd4..be073da4851 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`qiskit.circuit.library.PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`qiskit.circuit.library.PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.md index cc6a982a5c7..f61f77b7116 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.md index 1ba104f9d04..156d9af0925 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.md index 46264d9f426..ab12963dfc5 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`qiskit.circuit.library.PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.md index 8584d6d9312..fae651c080c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/phase_estimation.py "view source code") +`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.md index e207a214ba2..8df44403cdf 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`qiskit.circuit.library.PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.PhaseGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.md index c1675d04bb7..0985d897d2a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/phase_oracle.py "view source code") +`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.md index 8757953c83f..54530f1c219 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 8b028dfbe98..e3e11a57c46 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 30f698ace33..fcda24dc993 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.md index fcdf3a003be..98e32e86ef0 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.md index f3f9f885c70..2d7f63c6320 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.md index f1e02bd8a81..65a2b79d41b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/basis_change/qft.py "view source code") +`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.md index fe71f91a7b3..f9192b1ab59 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.md index 3f485512135..0c6eaf795fe 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/quantum_volume.py "view source code") +`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.md index 49f0e74ffdc..133f92b0618 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`qiskit.circuit.library.RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RC3XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.md index cc129832870..dd7f7109b33 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`qiskit.circuit.library.RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RCCXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.md index 7ebe4fb3778..1d28e10b932 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.md index 6ec61d5591a..7501b9a30f5 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`qiskit.circuit.library.RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/r.py "view source code") +`qiskit.circuit.library.RGate(theta, phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.md index bad9845ec57..a9cf4847180 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.md index 3b5e7f7c136..71bbaca6cc8 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`qiskit.circuit.library.RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.RXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.md index 1e563fc7e6b..5a1b58e61d2 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`qiskit.circuit.library.RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`qiskit.circuit.library.RXXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.md index c7cdba75e4a..6e6c0934a9f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`qiskit.circuit.library.RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.RYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.md index 4f0f56dcfaa..e3aa2ccd19c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`qiskit.circuit.library.RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`qiskit.circuit.library.RYYGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.md index 987d083bbd5..88ee751eadb 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`qiskit.circuit.library.RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.RZGate(phi, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.md index bf0ab5f7a74..945efd6a994 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`qiskit.circuit.library.RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`qiskit.circuit.library.RZXGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.md index 350d50f752a..e36ac7dcf27 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`qiskit.circuit.library.RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`qiskit.circuit.library.RZZGate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.md index 5f399b6f14b..1c98630ebca 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.md index d7ed9a6da86..4a274e8be17 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`qiskit.circuit.library.Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/reset.py "view source code") +`qiskit.circuit.library.Reset` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/reset.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.md index 632174acbbe..7da14c8323d 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`qiskit.circuit.library.SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.md index bac473ec9a6..eb18c8e7dd7 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`qiskit.circuit.library.SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.md index 0741cc8ec7d..b8119e91a3c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`qiskit.circuit.library.SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.md index 6010e8072f2..263ca6eeac8 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`qiskit.circuit.library.SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.md index 14e0877778f..be47d47faea 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.md index 3038c1fa540..ba5a25e04b3 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`qiskit.circuit.library.SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.SwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.md index be7049913a4..aa4f4b8c9a2 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`qiskit.circuit.library.TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.md index 9bcf72985c3..f17a39c5d71 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`qiskit.circuit.library.TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TdgGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.md index 622a772fc95..6b1fc007b3e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/two_local.py "view source code") +`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.md index b73687c80ce..a4290919565 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`qiskit.circuit.library.U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.U1Gate(theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.md index 81c2fad6af3..c310ab34fcb 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`qiskit.circuit.library.U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u2.py "view source code") +`qiskit.circuit.library.U2Gate(phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.md index 3a46626c8cb..f7a59fb3252 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.md index a8cd2a25266..2c27c6e653a 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`qiskit.circuit.library.UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.UGate(theta, phi, lam, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.md index aa522a9fdad..a85373fa62c 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.md index 8ffd619706d..08df0f96301 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.md index 3cc55043f42..cb5d3ed252b 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`qiskit.circuit.library.XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.XGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.md index cc7ff723001..79125b862b6 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.md index 41ff527cde4..d1498974f66 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.md index 99c2bfe15d4..7c3dd92e79f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.md index c13c4e87e1a..56f43fad8cc 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`qiskit.circuit.library.YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.YGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.md index ee1c437e6f5..f9da7e89647 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.md index a10764dd494..cf46db4cc4e 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`qiskit.circuit.library.ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.ZGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.md index 6569ad5918d..8b8dff3a48f 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.md index 16245d72035..65476a2ece4 100644 --- a/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.44/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`qiskit.circuit.library.iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`qiskit.circuit.library.iSwapGate(label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.md index c9556ab7857..0d2c49556ff 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollapser.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser -`qiskit.dagcircuit.BlockCollapser(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/collect_blocks.py "view source code") +`qiskit.dagcircuit.BlockCollapser(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.md index 93d4b639431..5cd7355a324 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockCollector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector -`qiskit.dagcircuit.BlockCollector(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/collect_blocks.py "view source code") +`qiskit.dagcircuit.BlockCollector(dag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.md index 02ea76d0e1c..b96da67e012 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.BlockSplitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.BlockSplitter -`qiskit.dagcircuit.BlockSplitter`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/collect_blocks.py "view source code") +`qiskit.dagcircuit.BlockSplitter` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.md index 63a08f32e57..12a30d1a264 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`qiskit.dagcircuit.DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagcircuit.py "view source code") +`qiskit.dagcircuit.DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.md index b80c014defb..8d2c3cbf6fe 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagdepnode.py "view source code") +`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.md index 460329b6c93..72b1334fae9 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`qiskit.dagcircuit.DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagdependency.py "view source code") +`qiskit.dagcircuit.DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagdependency.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.md index 77edda1728f..3d9e1200dc3 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`qiskit.dagcircuit.DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.md index eed5917a9e2..0bcf596e6e4 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`qiskit.dagcircuit.DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGNode(nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.md index 49f5938efbc..0c963d547ff 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.md index 7c1b0056b7d..d7d400f58ad 100644 --- a/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.44/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`qiskit.dagcircuit.DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.md index da11ebfcbf1..6b9c1272f21 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.HamiltonianGate -`qiskit.extensions.HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/hamiltonian_gate.py "view source code") +`qiskit.extensions.HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.44/qiskit.extensions.Initialize.md index 5ca7fbdc942..422151d3802 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Initialize -`qiskit.extensions.Initialize(params, num_qubits=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/initializer.py "view source code") +`qiskit.extensions.Initialize(params, num_qubits=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.md index 136c57df188..1b1af9080f4 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/squ.py "view source code") +`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.md index ceca3873a53..9393ec808fb 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/simulator/snapshot.py "view source code") +`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.md index c2edb3078d7..72905a2c629 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCPauliRotGate -`qiskit.extensions.UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") +`qiskit.extensions.UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.md index b0d21bc9304..996fdca6ae0 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRXGate -`qiskit.extensions.UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/ucrx.py "view source code") +`qiskit.extensions.UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.md index 33dc203c15d..a689cd251d8 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRYGate -`qiskit.extensions.UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/ucry.py "view source code") +`qiskit.extensions.UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.md index 21ea2609f87..cb8740056b4 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UCRZGate -`qiskit.extensions.UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/ucrz.py "view source code") +`qiskit.extensions.UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.md index b416a2bf1dc..7f0f8cbfff3 100644 --- a/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.44/qiskit.extensions.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.UnitaryGate -`qiskit.extensions.UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/unitary.py "view source code") +`qiskit.extensions.UnitaryGate(data, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/extensions/unitary.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.md index 6889569afa5..13dd6d4d10c 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`qiskit.opflow.OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/operator_base.py "view source code") +`qiskit.opflow.OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/operator_base.py "view source code") Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.md index 2dc25a10fb9..6b042656db1 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`qiskit.opflow.converters.AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/abelian_grouper.py "view source code") +`qiskit.opflow.converters.AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.md index 8426102eca6..d3cb2110684 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/circuit_sampler.py "view source code") +`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.md index b2aff0a54e7..a59ef8264cf 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`qiskit.opflow.converters.ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/converter_base.py "view source code") +`qiskit.opflow.converters.ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/converter_base.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.md index 988589008db..656429cea1c 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.md index 053c5cea64a..dbd3d332db1 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.md index 0347afe8fa4..a032b38b207 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`qiskit.opflow.converters.TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`qiskit.opflow.converters.TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.md index 2d05d0e5c79..a91e4cf91d9 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`qiskit.opflow.evolutions.EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/evolution_base.py "view source code") +`qiskit.opflow.evolutions.EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.md index a3fdfc2d907..0b4bede00d9 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`qiskit.opflow.evolutions.EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`qiskit.opflow.evolutions.EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.md index 683a10c1ea6..d14c4aae5ad 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/evolved_op.py "view source code") +`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.md index 84206fd886a..50318abd765 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`qiskit.opflow.evolutions.MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`qiskit.opflow.evolutions.MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 4b379bd9f8e..2bf4a41afc0 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.md index 80f29336dba..2192f2f8c2b 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`qiskit.opflow.evolutions.QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`qiskit.opflow.evolutions.QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.md index 503d5a216a8..a173b196ba0 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.md index 7dba8b07a79..d874075fc28 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`qiskit.opflow.evolutions.Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`qiskit.opflow.evolutions.Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.md index 48b3c5ed66e..44cd698edbb 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`qiskit.opflow.evolutions.TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`qiskit.opflow.evolutions.TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.md index cb9fe4b9a45..e1ad9d03452 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`qiskit.opflow.evolutions.TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`qiskit.opflow.evolutions.TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.md index 7cbafb4c020..2aeea6b4209 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`qiskit.opflow.expectations.AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`qiskit.opflow.expectations.AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.md index e5891263f80..2bbbe8ea7d9 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.md index 680ebda8be5..b72b1258369 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`qiskit.opflow.expectations.ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/expectation_base.py "view source code") +`qiskit.opflow.expectations.ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.md index 2968285290b..64e76c6e53a 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`qiskit.opflow.expectations.ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/expectation_factory.py "view source code") +`qiskit.opflow.expectations.ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.md index 3245ed7b457..91c4e8eb253 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`qiskit.opflow.expectations.MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`qiskit.opflow.expectations.MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.md index baec1950683..4a5b7fe8511 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.md index 9965a6610f4..93f47b9e186 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`qiskit.opflow.gradients.CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`qiskit.opflow.gradients.CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.md index 4ec7de15501..4a79de92c87 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`qiskit.opflow.gradients.CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`qiskit.opflow.gradients.CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.md index 96f003779d3..bd8c4ef8ec7 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`qiskit.opflow.gradients.DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/derivative_base.py "view source code") +`qiskit.opflow.gradients.DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.md index b6d43507cf8..dd890e0a0eb 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/gradient.py "view source code") +`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.md index 25c77a6bc5e..2bea7c56e5a 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/gradient_base.py "view source code") +`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.md index da63d33fe3e..7a6964ff676 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/hessian.py "view source code") +`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.md index 87a62fd3b90..67ed407c3e8 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/hessian_base.py "view source code") +`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.md index df6a169dba3..533b2df6692 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/natural_gradient.py "view source code") +`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.md index 91118d19896..cc101c8dff6 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/qfi.py "view source code") +`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.md index a5d635bb15b..d58629525cd 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/qfi_base.py "view source code") +`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.md index 4dee8ddcd5b..2e49c3be97f 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/composed_op.py "view source code") +`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.md index d31af8d7932..53ef0ebf916 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/list_op.py "view source code") +`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.md index 7b7c1eb0f7f..c17134590f0 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/summed_op.py "view source code") +`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.md index 47fcbf1a8db..48aff537bc1 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/tensored_op.py "view source code") +`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.md index b3d52c4ea1c..cfe552f45f8 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.md index d8df0039e60..a6d4925b589 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.md index 8d0e3824466..1d514f67a49 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.md index e60bdc0e024..f9404e53b78 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.md index 35b91ffd074..e93f50abae5 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index 98be2d358a7..6297d7a96b2 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.md index 6ded2ba15aa..13f81035d58 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.md index d3eac1689fc..ce07c347934 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.md index 5cecbd6f722..c7f8daddf16 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.md index 3e9f0279b99..fca80f451e2 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.md index 39331d6ead3..1489677ef67 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.md index 8377de9a2f6..67777939340 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.md index 8b3f67d0523..fb702a54b7b 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/state_fn.py "view source code") +`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.md index 37176530323..421d77f5df7 100644 --- a/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.44/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.md index 3899f7bb0be..041b07a96d8 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/backend_estimator.py "view source code") +`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/backend_estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.md index 60501919742..a3d3c62f4bc 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/backend_sampler.py "view source code") +`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/backend_sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.md index df15b4cf09a..01f14a3095b 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`qiskit.primitives.BaseEstimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/base_estimator.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.md index 63bc4e82007..060918a3878 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`qiskit.primitives.BaseSampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/base_sampler.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/0.44/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.44/qiskit.primitives.Estimator.md index 54884d248a8..cb6533041bd 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`qiskit.primitives.Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/estimator.py "view source code") +`qiskit.primitives.Estimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.md index 850d00ca821..feb9512ca88 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`qiskit.primitives.EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/estimator_result.py "view source code") +`qiskit.primitives.EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/estimator_result.py "view source code") Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/0.44/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.44/qiskit.primitives.Sampler.md index bf92a8e30ab..9fbea67f65f 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`qiskit.primitives.Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/sampler.py "view source code") +`qiskit.primitives.Sampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.md index f1438178ccb..2804e189045 100644 --- a/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.44/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`qiskit.primitives.SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/sampler_result.py "view source code") +`qiskit.primitives.SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/primitives/base/sampler_result.py "view source code") Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/0.44/qiskit.providers.Backend.md b/docs/api/qiskit/0.44/qiskit.providers.Backend.md index e50072b53a7..955a2b3ab99 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.44/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`qiskit.providers.Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") +`qiskit.providers.Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.44/qiskit.providers.BackendV1.md index 77c7d28e1a6..4d5d43ba5ca 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.44/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`qiskit.providers.BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.44/qiskit.providers.BackendV2.md index 843b1784f4e..13edefdc8ee 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.md index f974e09bfaa..b5ac9b5e34c 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.44/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend_compat.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.44/qiskit.providers.Job.md b/docs/api/qiskit/0.44/qiskit.providers.Job.md index 066894111fb..9d61fd9da3b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.44/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`qiskit.providers.Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/job.py "view source code") +`qiskit.providers.Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/job.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.44/qiskit.providers.JobStatus.md index 83cd9ecf560..9c4aa763cc6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.44/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`qiskit.providers.JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/jobstatus.py "view source code") +`qiskit.providers.JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/jobstatus.py "view source code") Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.JobV1.md b/docs/api/qiskit/0.44/qiskit.providers.JobV1.md index d4b1f22b9ec..b384fab412f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.44/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`qiskit.providers.JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/job.py "view source code") +`qiskit.providers.JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/job.py "view source code") Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.Options.md b/docs/api/qiskit/0.44/qiskit.providers.Options.md index 255db3fc151..9eba10e6c63 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.44/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`qiskit.providers.Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/options.py "view source code") +`qiskit.providers.Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/options.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.Provider.md b/docs/api/qiskit/0.44/qiskit.providers.Provider.md index efec9c2be08..b34bb1df540 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.44/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`qiskit.providers.Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/provider.py "view source code") +`qiskit.providers.Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/provider.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.md index 45dbda9d3b6..b8b75c4606f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.44/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`qiskit.providers.ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/provider.py "view source code") +`qiskit.providers.ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/provider.py "view source code") Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.md index a2e6822a126..4c6910cca98 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.44/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") +`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.md index 0e2a1b1ff80..4f0a8cfb1dc 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`qiskit.providers.basicaer.BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/exceptions.py "view source code") +`qiskit.providers.basicaer.BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.md index 4a043280e7a..1a1eebe7a2f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/basicaerjob.py "view source code") +`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.md index 5fcef9b0449..d8b10090170 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`qiskit.providers.basicaer.BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`qiskit.providers.basicaer.BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.md index c2fc533a755..2975d786ffe 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 2096248365c..5988a8fe4e5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.md index 7ff22667012..2af26b98169 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.44/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/0.44/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.44/qiskit.providers.convert_to_target.md index faff916011a..e3d621339ed 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.44/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index e0c1e7d30ea..7a755551e7b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.md index ef76c59019a..55bf20e8f2f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`qiskit.providers.fake_provider.Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_1q.py "view source code") +`qiskit.providers.fake_provider.Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.md index c779e98e52f..e9bb98f88b8 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`qiskit.providers.fake_provider.FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.md index c2cf9c503c8..7b02a376de9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`qiskit.providers.fake_provider.FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.md index 15046da2333..95c05f8b2d6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`qiskit.providers.fake_provider.FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.md index 71233304a66..bf3bdf79d3f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`qiskit.providers.fake_provider.FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.md index 58fff1ac9cc..e22a838a021 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`qiskit.providers.fake_provider.FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.md index 1e2bdd5eba6..5ae26590bbb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`qiskit.providers.fake_provider.FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.md index 83af4214a70..23c1fb381bb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`qiskit.providers.fake_provider.FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`qiskit.providers.fake_provider.FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.md index e013bce9a83..0919866c431 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.md index 424f278e933..8a705aa671e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`qiskit.providers.fake_provider.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.md index 5e332b3ec44..90869f36f35 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`qiskit.providers.fake_provider.FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.md index 770eecaef2b..40c48985f56 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`qiskit.providers.fake_provider.FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.md index 74ee44b35a4..fc9fdbfa3cb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`qiskit.providers.fake_provider.FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 03a4635fe3e..9943febeaac 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`qiskit.providers.fake_provider.FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.md index ecf81b2645e..d12afab19c3 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`qiskit.providers.fake_provider.FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.md index 7ce61efdb63..92ac0e15b03 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`qiskit.providers.fake_provider.FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.md index 9e296b0ab70..c8a7d0481f7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`qiskit.providers.fake_provider.FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.md index 5ffc27d7fcf..2de05a26ad1 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`qiskit.providers.fake_provider.FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.md index 9caf2c4a389..1e0334a110a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`qiskit.providers.fake_provider.FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.md index d64008296c4..94247565c09 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`qiskit.providers.fake_provider.FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.md index 840a89129ab..34522acdce8 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`qiskit.providers.fake_provider.FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.md index 04576ec1439..1770ecd7f27 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`qiskit.providers.fake_provider.FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.md index 84da2e0a764..97c9344af08 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`qiskit.providers.fake_provider.FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.md index 8390c87488b..e08866a9b06 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`qiskit.providers.fake_provider.FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.md index 5eaac210187..d9ceb7ea681 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`qiskit.providers.fake_provider.FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.md index aa2cddf8cb6..c8d2ae41377 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`qiskit.providers.fake_provider.FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.md index 711d5b2d856..981fa3fa7f5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`qiskit.providers.fake_provider.FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.md index 8220b0f248d..58af2deadd0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`qiskit.providers.fake_provider.FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.md index ba52b6c2408..fbefbdac1b7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`qiskit.providers.fake_provider.FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`qiskit.providers.fake_provider.FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.md index 6ca5b4b5d96..f3130d93cf5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`qiskit.providers.fake_provider.FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.md index 6d1dcb6ddfb..969c72ce162 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`qiskit.providers.fake_provider.FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.md index 0af75d14a3f..dc7383279b5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`qiskit.providers.fake_provider.FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.md index c7b742e2311..56bddc02bf5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`qiskit.providers.fake_provider.FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.md index b388d859177..02d6f10750e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`qiskit.providers.fake_provider.FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.md index 70244fa7388..1afdd736714 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`qiskit.providers.fake_provider.FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.md index 230a4e48134..608473f6411 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`qiskit.providers.fake_provider.FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.md index 5b0e4a253a1..9ef9e8a3527 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`qiskit.providers.fake_provider.FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.md index 0e7ef667ffc..c69954dea39 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`qiskit.providers.fake_provider.FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.md index 0953579272f..17fba0932ad 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`qiskit.providers.fake_provider.FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.md index 327f0944f83..ac9285483ec 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`qiskit.providers.fake_provider.FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.md index 551b964afa3..7b794cb15ae 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`qiskit.providers.fake_provider.FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.md index 9f8e252d564..0c336456881 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`qiskit.providers.fake_provider.FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.md index 4fdb8477196..4871a0a12a9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`qiskit.providers.fake_provider.FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.md index 489b2cf5c91..5981fc2393b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`qiskit.providers.fake_provider.FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.md index bc19cd2dd7b..2a3fa016337 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`qiskit.providers.fake_provider.FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.md index 6ddb2d4e556..77ad77a5ea2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`qiskit.providers.fake_provider.FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.md index d355cb30dff..bc3eec5ece5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`qiskit.providers.fake_provider.FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.md index cfb7f32f503..3ebe0a465c1 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`qiskit.providers.fake_provider.FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.md index fb331465e83..1332597e892 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`qiskit.providers.fake_provider.FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.md index 571cff0eef5..7086f47e27a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`qiskit.providers.fake_provider.FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.md index bcb877caee9..05726200db9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`qiskit.providers.fake_provider.FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.md index 5ae0567ebf2..b93d6937a37 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`qiskit.providers.fake_provider.FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.md index 3dd49a67625..a0ae2bbb064 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`qiskit.providers.fake_provider.FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.md index 93957326d5b..aba562bc385 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`qiskit.providers.fake_provider.FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index a1c65eb4170..1a3996106e1 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`qiskit.providers.fake_provider.FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.md index 49936081999..234de1f3de3 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`qiskit.providers.fake_provider.FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.md index 33ff390ac9c..b6cd103895b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`qiskit.providers.fake_provider.FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.md index d47024cadca..5c5bd168170 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`qiskit.providers.fake_provider.FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index ad877c9b520..0cb7b385e6a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`qiskit.providers.fake_provider.FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index 03d5e77773d..6d8beab9255 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`qiskit.providers.fake_provider.FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.md index 7546e3a6210..3fa12a12a66 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`qiskit.providers.fake_provider.FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`qiskit.providers.fake_provider.FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.md index 75226f54fe3..bf1234d1201 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`qiskit.providers.fake_provider.FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.md index d034cf04fa0..15c7c8001cb 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`qiskit.providers.fake_provider.FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.md index cd82c8412d8..ebd251a9a23 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`qiskit.providers.fake_provider.FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.md index 49e504bf64e..8c9fde6cd4e 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`qiskit.providers.fake_provider.FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.md index 127e2e9d974..f8aefcfcb5f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`qiskit.providers.fake_provider.FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`qiskit.providers.fake_provider.FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.md index 505ea99d361..5f29fbdeb94 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`qiskit.providers.fake_provider.FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 451df116a1e..9318a323326 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`qiskit.providers.fake_provider.FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.md index ce9a5e11674..458fef0fc4b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`qiskit.providers.fake_provider.FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`qiskit.providers.fake_provider.FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.md index 216fa96ff3b..44ab28af5e8 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`qiskit.providers.fake_provider.FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index 458d1c934ff..0e318dcad41 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`qiskit.providers.fake_provider.FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.md index 3b8b30ebe15..4d59660564c 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`qiskit.providers.fake_provider.FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`qiskit.providers.fake_provider.FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.md index 8922c265149..9804c621755 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`qiskit.providers.fake_provider.FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.md index b3cc6b0e1e1..b9e590a94de 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`qiskit.providers.fake_provider.FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.md index 94a392599e3..a512b14de62 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`qiskit.providers.fake_provider.FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.md index 3f8141a9b4f..b845ee4406d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`qiskit.providers.fake_provider.FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.md index 3d6f34390d6..033b11a72f0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`qiskit.providers.fake_provider.FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.md index d5cf3b0c793..4b638857d10 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`qiskit.providers.fake_provider.FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.md index 18c8605d5a7..44515a4af9d 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`qiskit.providers.fake_provider.FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`qiskit.providers.fake_provider.FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.md index 14537ed085b..7d9e43091be 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`qiskit.providers.fake_provider.FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.md index b6eb1d04fa3..5fdede4bd4c 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`qiskit.providers.fake_provider.FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.md index cf1678bb31f..2878c05de38 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`qiskit.providers.fake_provider.FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`qiskit.providers.fake_provider.FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.md index 585e49d6b98..74a21cc97e2 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`qiskit.providers.fake_provider.FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.md index 4c1fac3d3a8..e6901ee21e0 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`qiskit.providers.fake_provider.FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.md index 81af5e5fd9a..3d91174b335 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`qiskit.providers.fake_provider.FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.md index 9ea7b18f47d..2bdafd7bb77 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`qiskit.providers.fake_provider.FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.md index ef56df56f66..63d56376fa7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`qiskit.providers.fake_provider.FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`qiskit.providers.fake_provider.FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.md index 67bf05e6d19..08d2fe15144 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`qiskit.providers.fake_provider.FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`qiskit.providers.fake_provider.FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `FakeBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.md index d1fdc048237..db27d0e9dc6 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`qiskit.providers.fake_provider.FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.md index 607860b4095..9db86310839 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`qiskit.providers.fake_provider.FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.md index 40786d2f62e..77c5dd7c3d9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`qiskit.providers.fake_provider.FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.md index 5def58f4b7e..bbe4a302400 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`qiskit.providers.fake_provider.FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.md index 657b58516d6..8b157c28c8b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`qiskit.providers.fake_provider.FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.md index 3c76bd891d2..1956600acf4 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`qiskit.providers.fake_provider.FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.md index 3bb2513a678..46bbb1eee3b 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`qiskit.providers.fake_provider.FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `FakePulseBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.md index 5d419253422..934c379b5f8 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`qiskit.providers.fake_provider.FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.md index d40edf66efd..d581b53ee37 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`qiskit.providers.fake_provider.FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `FakeQasmBackend` diff --git a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.md index b6eb72d20e2..db0df9661a5 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.44/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`qiskit.providers.fake_provider.FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `FakeBackendV2` diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.md index 8f9ed8f48c7..543c2071d96 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.md index d266927f96d..a074621f3d7 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.md index 1f42e8c82bb..5809d27f536 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendstatus.py "view source code") +`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.Command.md b/docs/api/qiskit/0.44/qiskit.providers.models.Command.md index f92aaa2491f..c71077e652f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.md index 90939e28f25..559d0b9731f 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.md index 31c43fe8dc5..897ec9a2ed9 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/jobstatus.py "view source code") +`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/jobstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.md index fadf472e266..d475266b40a 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.md index 939d8a38f82..6af9fc3bfae 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.md index 1c62c75bc7b..551772912da 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.md index 65bfde3bf45..c65ba085202 100644 --- a/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.44/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`qiskit.providers.models.UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.md index 3d08911c11e..ad1053f0233 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`qiskit.pulse.InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instruction_schedule_map.py "view source code") +`qiskit.pulse.InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.44/qiskit.pulse.Schedule.md index 176d0475ee7..4a91d7bcedb 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.md index f848fa872e3..f5f62895b45 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.md index fbad9db1b8b..f4afb5553df 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.md index 5cf69bce74f..28ba6cca306 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`qiskit.pulse.channels.ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.ControlChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.md index e9f445e6438..06355d4ec6b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`qiskit.pulse.channels.DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.DriveChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.md index 416711f9349..84db2cb63b2 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.md index f7b48a4c2af..33928244fe7 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`qiskit.pulse.channels.MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MemorySlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.md index 62e50be3801..b54e52f35c9 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.md index 4ab3884f15a..36a3007492b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.md index 782d649affb..1455236aa50 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/acquire.py "view source code") +`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.md index 9a7475ecdf9..21fc095ed7f 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/call.py "view source code") +`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/call.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.md index b2b011668e2..b74609d21bc 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`qiskit.pulse.instructions.Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/delay.py "view source code") +`qiskit.pulse.instructions.Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/delay.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.md index b3de3cb4e5c..ecca598be9a 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`qiskit.pulse.instructions.Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/play.py "view source code") +`qiskit.pulse.instructions.Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/play.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.md index bd198515cb1..2d544bfd19f 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`qiskit.pulse.instructions.Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/reference.py "view source code") +`qiskit.pulse.instructions.Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/reference.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.md index fbbe0761315..4b63bd97f97 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.md index 936e8eae16b..3ba2d604fd6 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.md index 7a0a29112e1..03a06fc98ec 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.md index 3549ff387f7..a6a0dabad72 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.md index 90f53d14c9e..73036523953 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.md index 8dee4e1ce00..db384fc90a5 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/snapshot.py "view source code") +`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.md index 535a030cc41..9c6abe502a5 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.md index c938cb16a7e..b9ca95223ea 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Cos_class.rst.md index 634f994eaf4..5ce03531e45 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") A cosine pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.md index f7d58ac8e78..fdfa0a25c33 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianDeriv.md b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianDeriv.md index d0c45bd04a1..5030260711e 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianDeriv.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv -`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized Gaussian derivative pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.md index 213d93a23a1..b651c60e081 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquareDrag.md index 2ae89fd1419..0f872ce837d 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.md index 1221b5a87e9..6fa9b4f381e 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.md index 05b35227d2f..ca26253fce3 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/parametric_pulses.py "view source code") +`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Sawtooth_class.rst.md index 6d9f1fa1f64..3edd7f781db 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") A sawtooth pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.md b/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.md index 720555e32e8..0b9735c8e91 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.ScalableSymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ScalableSymbolicPulse -`qiskit.pulse.library.ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.SechDeriv.md b/docs/api/qiskit/0.44/qiskit.pulse.library.SechDeriv.md index 44812a1575e..57bc03524ee 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.SechDeriv.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.SechDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.SechDeriv -`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech derivative pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Sech_fun.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Sech_fun.rst.md index 9bad0b55314..6b2750ff23b 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Sech_fun.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Sech_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sech -`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Sin_class.rst.md index 859d2262c1f..2e17940fb67 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") A sinusoidal pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Square_fun.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Square_fun.rst.md index 120ecdc4ce1..57e6762c534 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Square_fun.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Square_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Square -`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") A square wave pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.md index 93514c12184..dd54d6541a6 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Triangle_class.rst.md index 9e714828bc4..955552ba749 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") A triangle wave pulse. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.md index 99dcc95c349..22a84f866ed 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/waveform.py "view source code") +`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/waveform.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.44/qiskit.pulse.library.gaussian_square_echo.md b/docs/api/qiskit/0.44/qiskit.pulse.library.gaussian_square_echo.md index 2ba90e3bb5f..65cb814a74c 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.library.gaussian_square_echo.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.library.gaussian_square_echo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo -`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/library/symbolic_pulses.py "view source code") An echoed Gaussian square pulse with an active tone overlaid on it. diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.md index 75653f66617..f4ef66b772a 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`qiskit.pulse.transforms.AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.md index f6157ce47a2..b81ef53fc01 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`qiskit.pulse.transforms.AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.md index 460cca0a861..03926fdd078 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`qiskit.pulse.transforms.AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.md index d43372df47a..5817d2a17da 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`qiskit.pulse.transforms.AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.md index 0f9b8c1b1ec..19628b3044f 100644 --- a/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.44/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`qiskit.pulse.transforms.AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.md index 7e971714a9f..78c3f27992b 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`qiskit.qobj.GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.md index 7a52a47b35b..4691b340011 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`qiskit.qobj.PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.md index a37425b7472..a0450d68960 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.md index a593d966de4..07b24fe9ea5 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.md index 79bb3934210..08f97e60f4f 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.md index f453433c1f5..7cdadeee778 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.md index cfb7bfd28d7..1d204c6e7a9 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.md index 5ad43a28276..5363d6bad1c 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`qiskit.qobj.QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.md index 3edda98778b..288eeb029e9 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.md index 0a0720f8985..ad43174204f 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.md index d97d6088128..998c6dd8aea 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.md index b7bbc627c25..f36e06ed795 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.md index 55bb8e58b25..05b5784fd0c 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.44/qiskit.qobj.Qobj.md index 0ad640432db..c890e759cf8 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.Qobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.Qobj -`qiskit.qobj.Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/__init__.py "view source code") +`qiskit.qobj.Qobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/__init__.py "view source code") Bases: [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.md index 59e6f4a0632..08a7fa5c3e0 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`qiskit.qobj.QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/common.py "view source code") Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.md index 10574a944b1..d5bf8a69137 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`qiskit.qobj.QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/common.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.md index 371316c1f74..f5b1671ff53 100644 --- a/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.44/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`qiskit.qobj.QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.md index 0991255cb38..9d71c5c333d 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.md index c08678bde6c..bece5c1d896 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/chi.py "view source code") +`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.md index 0653bceb773..8aa751de347 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/choi.py "view source code") +`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.md index faf490ba358..730e944acb6 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`qiskit.quantum_info.Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`qiskit.quantum_info.Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.md index 8fdb2eadc87..ae17c7fd589 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`qiskit.quantum_info.DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/densitymatrix.py "view source code") +`qiskit.quantum_info.DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.md index 57a17233b0e..cb8a8722516 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.md index 108674c30f5..16a96e91f94 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`qiskit.quantum_info.OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`qiskit.quantum_info.OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.md index 6543449816f..5857b64733f 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/operator.py "view source code") +`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/operator.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.md index 01f2394ddfb..ed49e13272c 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.md index dd7fecffe12..89cacd74228 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`qiskit.quantum_info.Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`qiskit.quantum_info.Pauli(data=None, x=None, *, z=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `BasePauli` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.md index 508ecc935cf..229a49a1470 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`qiskit.quantum_info.PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`qiskit.quantum_info.PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `BasePauli`, `LinearMixin`, `GroupMixin` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.md index 22c4ec22255..f19eaedc65a 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.PauliTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliTable -`qiskit.quantum_info.PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") +`qiskit.quantum_info.PauliTable(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.md index 84b8f573281..1b572c84c9b 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`qiskit.quantum_info.Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`qiskit.quantum_info.Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.md index 3ee2cdda7e1..ebf6deb9586 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/scalar_op.py "view source code") +`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.md index a61eff7bbb1..71c3d22a159 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.md index f86fa7c58a5..6fc568e3c23 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`qiskit.quantum_info.StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`qiskit.quantum_info.StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `QuantumState` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.md index 8be3006bbc7..f0c062bb5f4 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.StabilizerTable.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerTable -`qiskit.quantum_info.StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") +`qiskit.quantum_info.StabilizerTable(data, phase=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `AdjointMixin` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.md index 1f2e6790af6..2455bd7de9d 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`qiskit.quantum_info.Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/statevector.py "view source code") +`qiskit.quantum_info.Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/statevector.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.md index f23e83fb55c..f8a47a70b2e 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.md index d55a98d9f61..4850d0d400f 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/superop.py "view source code") +`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 9bc910ede75..32e43bdf34f 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`qiskit.quantum_info.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`qiskit.quantum_info.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.md index d6c4108fddb..cc5cb2a4232 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`qiskit.quantum_info.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`qiskit.quantum_info.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.md index 055bee2a51d..e5422c08767 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.44/qiskit.quantum_info.pauli_basis.md index 7d767f91072..e09734d1763 100644 --- a/docs/api/qiskit/0.44/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.44/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`qiskit.quantum_info.pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`qiskit.quantum_info.pauli_basis(num_qubits, weight=False, pauli_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.md index 427468c6d17..32a8d6dc3f8 100644 --- a/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.44/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`qiskit.result.BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`qiskit.result.BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.md index 76663ccc53d..6905c3f3600 100644 --- a/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.44/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/0.44/qiskit.result.Counts.md b/docs/api/qiskit/0.44/qiskit.result.Counts.md index ad04b42a247..d5e9b8173a0 100644 --- a/docs/api/qiskit/0.44/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.44/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/counts.py "view source code") +`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/counts.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.md index fb793cef6c5..57f2571a259 100644 --- a/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.44/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.md index 57a92a4f8ca..d952a210fd5 100644 --- a/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.44/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`qiskit.result.ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/distributions/probability.py "view source code") +`qiskit.result.ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/distributions/probability.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.md index dd83cd67715..90a2fb3a9f2 100644 --- a/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.44/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/distributions/quasi.py "view source code") +`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/distributions/quasi.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.result.Result.md b/docs/api/qiskit/0.44/qiskit.result.Result.md index 3fd7d2bce2f..b785e28f450 100644 --- a/docs/api/qiskit/0.44/qiskit.result.Result.md +++ b/docs/api/qiskit/0.44/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/result.py "view source code") +`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.result.ResultError.md b/docs/api/qiskit/0.44/qiskit.result.ResultError.md index 2e0424d544d..fc59abd96a4 100644 --- a/docs/api/qiskit/0.44/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.44/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`qiskit.result.ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/exceptions.py "view source code") +`qiskit.result.ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.md index a57d8640e65..955a8869194 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`qiskit.synthesis.EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`qiskit.synthesis.EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.md index b9819af1fa6..e4138b7ec48 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.md index f9a0143f421..0ed7ddeb6ce 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`qiskit.synthesis.MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`qiskit.synthesis.MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.md index 38481431ecd..b57d180d935 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/product_formula.py "view source code") +`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.md index 4b62cdcb782..35d3d2146fa 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/qdrift.py "view source code") +`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.md index 53372ee3d21..2241182ea7d 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.md index 41766192994..1e9ee3dac89 100644 --- a/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.44/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.md index 2abd69ae44f..b061a6addeb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`qiskit.transpiler.AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.md index 24fe3dc8694..a0ff082a4ad 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.ConditionalController -`qiskit.transpiler.ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py "view source code") +`qiskit.transpiler.ConditionalController(passes, options=None, condition=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.md index 1a5a31bea8c..5f4756d83c1 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/coupling.py "view source code") +`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/coupling.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.md index b641b1e4165..6440b3d8dee 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.DoWhileController -`qiskit.transpiler.DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py "view source code") +`qiskit.transpiler.DoWhileController(passes, options=None, do_while=None, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.md index 2d084649251..12ada597c64 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.md index cb3594fb39d..fa046a6dc2f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`qiskit.transpiler.FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.md index d4c413c5e0a..26631963fed 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FlowController -`qiskit.transpiler.FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py "view source code") +`qiskit.transpiler.FlowController(passes, options, **partial_controller)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.md index e849b5acf62..94cfb4cc95c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/instruction_durations.py "view source code") +`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/instruction_durations.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.md index 1ec92ee64a4..befbf6efaa9 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/target.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.44/qiskit.transpiler.Layout.md index 68812f087be..1db1252929f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`qiskit.transpiler.Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.md index 99baf1c9f1a..400b15fb64a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`qiskit.transpiler.PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.PassManager(passes=None, max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passmanager.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.md index ce4ebb74daa..44eaf3350c2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passmanager_config.py "view source code") +`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passmanager_config.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.md index 8c247ee16b1..8588a87a1d2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PropertySet -`qiskit.transpiler.PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/propertyset.py "view source code") +`qiskit.transpiler.PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/propertyset.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.md index 08400e9d056..88588834ad4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passmanager.py "view source code") Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.Target.md b/docs/api/qiskit/0.44/qiskit.transpiler.Target.md index e6cdc10fcdc..22abaa78516 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/target.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.md index a8b75704da4..c8f66f53248 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`qiskit.transpiler.TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.md index 52d4f0db4a6..e542e951d91 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.md index ce9793cde96..c38ada00d90 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 62bc682340e..efbac9f550b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.md index c2b5c8128d2..512bf4a0981 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 8ef31b190bf..7ef27c73215 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.md index a4fe1e670a1..8028c4dd825 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.md index 801b6cf26f5..604e065eae0 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.md index 6c231678c0f..b792f53cd6a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BIPMapping.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BIPMapping -`qiskit.transpiler.passes.BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") +`qiskit.transpiler.passes.BIPMapping(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index d4ba44c3c7f..3688c6d98ec 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.md index 07a6ce878a9..c65582e5c16 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.md index 41716fdc749..811a33c83fe 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.md index 366b77cc62b..f2ec04677cd 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.md index 722c565c927..55672a9cd67 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.md index 580ec1bb97a..b429e4ac322 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXDirection -`qiskit.transpiler.passes.CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/cx_direction.py "view source code") +`qiskit.transpiler.passes.CXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.md index f2b770133d5..b26912d16b3 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckCXDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckCXDirection -`qiskit.transpiler.passes.CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") +`qiskit.transpiler.passes.CheckCXDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.md index ed11ef69d07..8ce78c66776 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.md index 54c6da5be00..46ab9b8db44 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`qiskit.transpiler.passes.CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/check_map.py "view source code") +`qiskit.transpiler.passes.CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.md index a69d73210dd..a42a855e7c7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.md index b179bafeaa0..917e9fa0e5b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.md index 2428f201151..aa34b29df5a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.md index a98e1ddb7d4..45dd990c69e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.md index 6ff8e52a233..0c3a29fae96 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.md index 8263dc606ce..dfe33eca06d 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.md index 87214c7b645..7368a2a34fe 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 438718bfb2b..94aac8e3191 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.md index 77eda255e57..4614230d80c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.md index 72480b79216..dfafcedbcc6 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.md index 140189a8fad..47dd8191f1c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.md index 898c35d0e02..7e9337fd1a7 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 9246355c354..9cbe88378b8 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.md index de20145bfaf..53194551ef2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`qiskit.transpiler.passes.CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`qiskit.transpiler.passes.CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.md index aabb151f7bf..7f748d48990 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 862bc5a619f..3163c45c6a6 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.md index 1b2f45164c8..af1347937a2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.md index da605924b64..2ed3e80f186 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.md index 9a6b8813574..2dd2026bd90 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`qiskit.transpiler.passes.Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/decompose.py "view source code") +`qiskit.transpiler.passes.Decompose(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.md index f23ffaba3aa..e3e30704920 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.md index e29f9b8e744..b4fc9acef96 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`qiskit.transpiler.passes.Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/depth.py "view source code") +`qiskit.transpiler.passes.Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.md index 4d429894d44..7d2fa68697d 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 5a80e9e8520..0453df7ef24 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.md index ff7824e5bb1..4678e621d25 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.md index 4c319f4da26..d9b1c6dea95 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.md index 4fffb3f96ad..0ede5abc49f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.md index 1b2da2e9ba7..7671bfda009 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`qiskit.transpiler.passes.GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`qiskit.transpiler.passes.GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.md index f98ada6cb19..d35ff6d886a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.md index f7213083b12..c586a9e0864 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.md index 162272f4018..f40c4e5ea25 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.md index 1dc7a9ca3d9..bcee6a6a705 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.md index 2cb91047934..363be7dddd2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.md index 9d402c5a8e3..4f51f2c2e8e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index ab9d1da11d6..07d53374f4b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 02f692aaa69..01aeea1b57b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.md index 3a9bd2519e0..145d3325135 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.md index f27080a950c..cc942fc5266 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.md index fd644954a1e..ae9b248d028 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 12dd6eceb92..c9a147b69a6 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.md index 42ec5266683..2f797f449fd 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.md index e574d59e092..6c95cd12f44 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index d8436120fb1..d00bab71154 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 4a738e8b0e2..89d42510c11 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.md index f7083806380..c3622c73423 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.md index c7e8dd48872..b16c7f3168c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`qiskit.transpiler.passes.PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`qiskit.transpiler.passes.PadDelay(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 841a2d98537..1de7dc7feba 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.md index 148b6ac5a03..e21b33123c2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`qiskit.transpiler.passes.PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`qiskit.transpiler.passes.PulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.md index f3da1ea4333..e1adadfb617 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 639d6f77bd1..6e04047b17e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.md index 961e3f48738..24ea93185c3 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 944716635d2..fb520429f4a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 27b242c554e..ae7b73b9e88 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.md index 79c7d34b728..05b3ff38aca 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index c7611ee1c14..183622e6ba1 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.md index 8261cd9eace..96de518c802 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.md index 0825fcdf2f6..40020cefa19 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.md index 5f9c1d6fe3a..fa0766e0134 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.md index 256d8265d23..8d947ade2a4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`qiskit.transpiler.passes.SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`qiskit.transpiler.passes.SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.md index 51e5dcad086..a10a45c153c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`qiskit.transpiler.passes.Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/size.py "view source code") +`qiskit.transpiler.passes.Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.md index 8157638354e..b9ca1ca4c15 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index c04fc447f8f..0cd58fe4645 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`qiskit.transpiler.passes.SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.md index b7f7ffd25ee..a1d0b72b08b 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.md index ed54c45bdae..b6020992592 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.md index 483efd818b9..0136a689ec9 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.md index 45f249094ca..dc9c70c9e19 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.md index 595f24769ca..81b1f9208eb 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.md index ea45e98b615..e02df50f595 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.md index 149dfb0eafb..6e4bda6e16f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 9bc06f09535..aa9839e2f42 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.md index 5bec6d763cd..9b0d692042f 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.md index 633a34b5d98..f4f8d255ff4 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`qiskit.transpiler.passes.Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/unroller.py "view source code") +`qiskit.transpiler.passes.Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.md index b6922fc019c..82c1bf13227 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.md index 3616b97d85b..ce4e1f8a708 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.md index 2737082a860..05662958103 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.md index d3ae9fcb02f..c9e1ac4e538 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`qiskit.transpiler.passes.Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/width.py "view source code") +`qiskit.transpiler.passes.Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index efc76b1274a..c536b818d50 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index a17313b5a76..dee54263bb3 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 900694cf7f0..a6ecc7085a1 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 331857fa352..37be7dda44c 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 7c16bb35941..7493fd57fba 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 4d9f9254374..15f50c36e2e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index 98255805dea..f09f0185c49 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.md index c303d347a67..1ad13cfaa31 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`qiskit.transpiler.synthesis.aqc.AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`qiskit.transpiler.synthesis.aqc.AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index ac894a7120c..82021920c2a 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index 465bd528328..9b85451a798 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`qiskit.transpiler.synthesis.aqc.ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`qiskit.transpiler.synthesis.aqc.ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 7460ad6c075..73606301737 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`qiskit.transpiler.synthesis.aqc.ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`qiskit.transpiler.synthesis.aqc.ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index e96dfb87de5..632540438db 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 677f299bb25..5977a73312e 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`qiskit.transpiler.synthesis.aqc.CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index cd73b9d2622..49cc89b01d2 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index 77c358a6573..641ad823636 100644 --- a/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.44/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.md index adcb49fa62f..80d7a33203c 100644 --- a/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.44/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/quantum_instance.py "view source code") +`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/quantum_instance.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.md index 063a26aeedd..8a902086cac 100644 --- a/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.44/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/mitigation/fitters.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.md index 120ff4be9f7..fd760b122db 100644 --- a/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.44/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/mitigation/fitters.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.44/qiskit.visualization.array_to_latex.md index f3eac4b1c5f..1b433de3b51 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/array.py "view source code") +`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.44/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.44/qiskit.visualization.circuit_drawer.md index 5073bd9e873..094d9651ea7 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.44/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.44/qiskit.visualization.dag_drawer.md index 4a9ce034b6e..841116acc06 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/dag_visualization.py "view source code") +`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.44/qiskit.visualization.pass_manager_drawer.md index d76c7bfffcd..f0c6d3e26ea 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pass_manager_visualization.py "view source code") +`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_multivector.md index 1af7e736f2a..0c778c8fff0 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_vector.md index 5d29314c733..9da2ab5cdd0 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_circuit_layout.md index ef1b7e43ac2..b6f71924938 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_coupling_map.md index df51946e3bb..fca958fc194 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_distribution.md index 8097315a9f6..6d3657266a2 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_error_map.md index 6f64b2a7398..4990f2986f9 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`qiskit.visualization.plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_gate_map.md index c2f73849611..a291195d54c 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_histogram.md index f5373ed0986..4a971207613 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_city.md index a542438c678..acc894725c5 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_hinton.md index afb33bf56f9..2154c3d3f18 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_paulivec.md index 973b97798ce..7ee0743126d 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") Plot the Pauli-vector representation of a quantum state as bar graph. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_qsphere.md index 5dd618dbcd6..03efc4fac64 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.md index 49190cfefed..d492374ef30 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`qiskit.visualization.pulse.IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.md index 9e76cc7ca84..96a08c50cd4 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`qiskit.visualization.pulse.IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.md index d774cf4d9dc..f9ae2c1bea8 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`qiskit.visualization.pulse.IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.md index ff008feb8a8..e88dc45467e 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`qiskit.visualization.qcstyle.DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/circuit/qcstyle.py "view source code") +`qiskit.visualization.qcstyle.DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.44/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.44/qiskit.visualization.visualize_transition.md index 733329962c3..a27af6591c3 100644 --- a/docs/api/qiskit/0.44/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.44/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/transition_visualization.py "view source code") +`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.44/qpy.md b/docs/api/qiskit/0.44/qpy.md index a674a14d03b..45a7b8550ab 100644 --- a/docs/api/qiskit/0.44/qpy.md +++ b/docs/api/qiskit/0.44/qpy.md @@ -59,7 +59,7 @@ and then loading that file will return a list with all the circuits -`qiskit.qpy.load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qpy/interface.py "view source code") Load a QPY binary file @@ -106,7 +106,7 @@ The list of Qiskit programs contained in the QPY data. A list is always returned -`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file @@ -163,7 +163,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski -`qiskit.qpy.QpyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QpyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/qpy/exceptions.py "view source code") Errors raised by the qpy module. diff --git a/docs/api/qiskit/0.44/quantum_info.md b/docs/api/qiskit/0.44/quantum_info.md index cc0ed6d68dc..2d2199ba254 100644 --- a/docs/api/qiskit/0.44/quantum_info.md +++ b/docs/api/qiskit/0.44/quantum_info.md @@ -62,7 +62,7 @@ python_api_name: qiskit.quantum_info -`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. @@ -100,7 +100,7 @@ The average gate fidelity $F_{\text{ave}}$. -`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. @@ -145,7 +145,7 @@ The process fidelity $F_{\text{pro}}$. -`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. @@ -180,7 +180,7 @@ The average gate error $E$. -`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. @@ -220,7 +220,7 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar -`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. @@ -254,7 +254,7 @@ The state fidelity $F(\rho_1, \rho_2)$. -`qiskit.quantum_info.purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. @@ -285,7 +285,7 @@ the purity $Tr[\rho^2]$. -`qiskit.quantum_info.concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. @@ -327,7 +327,7 @@ The concurrence. -`qiskit.quantum_info.entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. @@ -358,7 +358,7 @@ The von-Neumann entropy S(rho). -`qiskit.quantum_info.entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. @@ -386,7 +386,7 @@ The entanglement of formation. -`qiskit.quantum_info.mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. @@ -422,7 +422,7 @@ The mutual information $I(\rho_{AB})$. -`qiskit.quantum_info.negativity(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.negativity(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/measures.py "view source code") Calculates the negativity. @@ -453,7 +453,7 @@ Negativity value of the quantum state -`qiskit.quantum_info.partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. @@ -480,7 +480,7 @@ The reduced density matrix. -`qiskit.quantum_info.schmidt_decomposition(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.schmidt_decomposition(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/utils.py "view source code") Return the Schmidt Decomposition of a pure quantum state. @@ -526,7 +526,7 @@ list of tuples `(s, u, v)`, where `s` (float) are the Schmidt coefficients $\lam -`qiskit.quantum_info.shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. @@ -555,7 +555,7 @@ The Shannon entropy H(pvec). -`qiskit.quantum_info.commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`qiskit.quantum_info.commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/utils/commutator.py "view source code") Compute commutator of a and b. @@ -580,7 +580,7 @@ The commutator -`qiskit.quantum_info.anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`qiskit.quantum_info.anti_commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") Compute anti-commutator of a and b. @@ -605,7 +605,7 @@ The anti-commutator -`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") Compute symmetric double commutator of a, b and c. @@ -652,7 +652,7 @@ Methods of Molecular Quantum Mechanics. 2nd Edition, Academic Press, 1992. ISBN -`qiskit.quantum_info.random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. @@ -675,7 +675,7 @@ the random statevector. -`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. @@ -702,7 +702,7 @@ the random density matrix. -`qiskit.quantum_info.random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. @@ -725,7 +725,7 @@ a unitary operator. -`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. @@ -749,7 +749,7 @@ a Hermitian operator. -`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. @@ -771,7 +771,7 @@ a random Pauli -`qiskit.quantum_info.random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. @@ -798,7 +798,7 @@ a random Clifford operator. -`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. @@ -827,7 +827,7 @@ a quantum channel operator. -`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. @@ -848,7 +848,7 @@ a random CNOTDihedral element. -`qiskit.quantum_info.random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. @@ -870,7 +870,7 @@ a random PauliTable. -`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. @@ -893,7 +893,7 @@ a random PauliList. -`qiskit.quantum_info.random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_stabilizer_table(num_qubits, size=1, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. @@ -921,7 +921,7 @@ a random StabilizerTable. -`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. @@ -946,7 +946,7 @@ Distance -`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. @@ -1019,7 +1019,7 @@ hellinger_fidelity(res1.get_counts(), res2.get_counts()) -`qiskit.quantum_info.decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`qiskit.quantum_info.decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.44/result.md b/docs/api/qiskit/0.44/result.md index 5841d72785e..d3ad10f88aa 100644 --- a/docs/api/qiskit/0.44/result.md +++ b/docs/api/qiskit/0.44/result.md @@ -28,7 +28,7 @@ python_api_name: qiskit.result -`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -58,7 +58,7 @@ the observed counts, marginalized to only account for frequency of observations -`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -87,7 +87,7 @@ A marginalized dictionary -`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/utils.py "view source code") Marginalize shot memory @@ -127,7 +127,7 @@ marginal\_memory -`qiskit.result.sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/sampled_expval.py "view source code") +`qiskit.result.sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.44/scheduler.md b/docs/api/qiskit/0.44/scheduler.md index 4706e8fe62c..5abd3d10bc8 100644 --- a/docs/api/qiskit/0.44/scheduler.md +++ b/docs/api/qiskit/0.44/scheduler.md @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. -`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/config.py "view source code") +`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. @@ -38,7 +38,7 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched -`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/schedule_circuit.py "view source code") +`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. @@ -73,7 +73,7 @@ Pulse scheduling methods. -`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -96,7 +96,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. diff --git a/docs/api/qiskit/0.44/synthesis.md b/docs/api/qiskit/0.44/synthesis.md index 68a6f6a78f6..da8d0e1e114 100644 --- a/docs/api/qiskit/0.44/synthesis.md +++ b/docs/api/qiskit/0.44/synthesis.md @@ -37,7 +37,7 @@ python_api_name: qiskit.synthesis -`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear/cnot_synth.py "view source code") +`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear/cnot_synth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. @@ -68,7 +68,7 @@ a CX-only circuit implementing the linear transformation. -`qiskit.synthesis.synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. @@ -100,7 +100,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cz_depth_line_mr(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. @@ -126,7 +126,7 @@ a circuit implementation of the CZ circuit of depth 2\*n+2 for LNN connectivity. -`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") Joint synthesis of a -CZ-CX- circuit for linear nearest neighbour (LNN) connectivity, with 2-qubit depth at most 5n, based on Maslov and Yang. This method computes the CZ circuit inside the CX circuit via phase gate insertions. @@ -154,7 +154,7 @@ a circuit implementation of a CX circuit following a CZ circuit, denoted as a -C -`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. @@ -176,7 +176,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. @@ -198,7 +198,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. @@ -224,7 +224,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`qiskit.synthesis.synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. @@ -253,7 +253,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`qiskit.synthesis.synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. @@ -277,7 +277,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`qiskit.synthesis.synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. @@ -305,7 +305,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`qiskit.synthesis.synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. @@ -335,7 +335,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov. @@ -382,7 +382,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_depth_lnn(cliff)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers for linear-nearest neighbour connectivity. @@ -412,7 +412,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. @@ -437,7 +437,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. @@ -465,7 +465,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. @@ -497,7 +497,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of a stabilizer state into layers. @@ -546,7 +546,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth 2\*n+2 and two distinct CX layers, using CX and phase gates (S, Sdg or Z). @@ -577,7 +577,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/0.44/synthesis_aqc.md b/docs/api/qiskit/0.44/synthesis_aqc.md index b154c4af635..50bfc0876f2 100644 --- a/docs/api/qiskit/0.44/synthesis_aqc.md +++ b/docs/api/qiskit/0.44/synthesis_aqc.md @@ -130,7 +130,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`qiskit.transpiler.synthesis.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`qiskit.transpiler.synthesis.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.44/tools.md b/docs/api/qiskit/0.44/tools.md index 13b91063ac4..2032661975d 100644 --- a/docs/api/qiskit/0.44/tools.md +++ b/docs/api/qiskit/0.44/tools.md @@ -24,7 +24,7 @@ A helper function for calling a custom function with python `ProcessPoolExecutor -`qiskit.tools.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/parallel.py "view source code") +`qiskit.tools.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -81,7 +81,7 @@ A helper module to get IBM backend information and submitted job status. -`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/monitor/job_monitor.py "view source code") +`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. @@ -115,7 +115,7 @@ job_monitor(job_sim) -`qiskit.tools.backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. @@ -136,7 +136,7 @@ Examples: .. code-block:: python -`qiskit.tools.backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. @@ -159,7 +159,7 @@ A helper component for publishing and subscribing to events. -`qiskit.tools.events.TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/events/progressbar.py "view source code") +`qiskit.tools.events.TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/tools/events/progressbar.py "view source code") A simple text-based progress bar. diff --git a/docs/api/qiskit/0.44/transpiler.md b/docs/api/qiskit/0.44/transpiler.md index 90d9ebf8447..935acbe1979 100644 --- a/docs/api/qiskit/0.44/transpiler.md +++ b/docs/api/qiskit/0.44/transpiler.md @@ -938,7 +938,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor -`qiskit.transpiler.TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. @@ -948,7 +948,7 @@ Set the error message. -`qiskit.transpiler.TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. @@ -958,7 +958,7 @@ Set the error message. -`qiskit.transpiler.CouplingError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CouplingError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") Base class for errors raised by the coupling graph object. @@ -968,7 +968,7 @@ Set the error message. -`qiskit.transpiler.LayoutError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.LayoutError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/exceptions.py "view source code") Errors raised by the layout object. diff --git a/docs/api/qiskit/0.44/transpiler_plugins.md b/docs/api/qiskit/0.44/transpiler_plugins.md index 2632f03516c..a1f57e633a4 100644 --- a/docs/api/qiskit/0.44/transpiler_plugins.md +++ b/docs/api/qiskit/0.44/transpiler_plugins.md @@ -101,7 +101,7 @@ Note that the entry point `name = path` is a single string not a Python expressi -`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. @@ -125,7 +125,7 @@ plugins -`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/0.44/transpiler_preset.md b/docs/api/qiskit/0.44/transpiler_preset.md index cabbdd17f3f..bac6f31441e 100644 --- a/docs/api/qiskit/0.44/transpiler_preset.md +++ b/docs/api/qiskit/0.44/transpiler_preset.md @@ -28,7 +28,7 @@ This module contains functions for generating the preset pass managers for the t -`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -101,7 +101,7 @@ The preset pass manager for the given options -`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -129,7 +129,7 @@ a level 0 pass manager. -`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -155,7 +155,7 @@ a level 1 pass manager. -`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. @@ -183,7 +183,7 @@ a level 2 pass manager. -`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. @@ -215,7 +215,7 @@ a level 3 pass manager. -`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. @@ -231,7 +231,7 @@ a pass manager that populates the `contains_x` properties for each of the contro -`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. @@ -239,7 +239,7 @@ Get a pass manager that always raises an error if control flow is present in a g -`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -264,7 +264,7 @@ The unroll 3q or more pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -288,7 +288,7 @@ set has been set in earlier stages -`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -316,7 +316,7 @@ The routing pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -340,7 +340,7 @@ The pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -372,7 +372,7 @@ The basis translation pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.44/utils.md b/docs/api/qiskit/0.44/utils.md index de286a217b9..a969dcc6297 100644 --- a/docs/api/qiskit/0.44/utils.md +++ b/docs/api/qiskit/0.44/utils.md @@ -22,7 +22,7 @@ python_api_name: qiskit.utils -`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") Dynamically insert the deprecation message into `func`’s docstring. @@ -37,7 +37,7 @@ Dynamically insert the deprecation message into `func`’s docstring. -`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit-terra', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit-terra', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") Decorator to indicate an argument has been deprecated in some way. @@ -67,7 +67,7 @@ Callable -`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_arg. @@ -89,7 +89,7 @@ Callable -`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit-terra', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit-terra', removal_timeline='no earlier than 3 months after the release date', is_property=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") Decorator to indicate a function has been deprecated. @@ -118,7 +118,7 @@ Callable -`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_func. @@ -141,7 +141,7 @@ Callable -`qiskit.utils.local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. @@ -159,7 +159,7 @@ The hardware information. -`qiskit.utils.is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one @@ -167,7 +167,7 @@ Checks whether the current process is the main one -`qiskit.utils.apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/units.py "view source code") +`qiskit.utils.apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. @@ -200,7 +200,7 @@ Converted value. -`qiskit.utils.detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/units.py "view source code") +`qiskit.utils.detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. @@ -244,7 +244,7 @@ A tuple of scaled value and prefix. -`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/classtools.py "view source code") +`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. @@ -269,7 +269,7 @@ If either `before` or `after` are given, they should be callables with a compati -`qiskit.utils.summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/circuit_utils.py "view source code") +`qiskit.utils.summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/circuit_utils.py "view source code") **Summarize circuits based on QuantumCircuit, and five metrics are summarized.** @@ -297,7 +297,7 @@ a formatted string records the summary -`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. @@ -323,7 +323,7 @@ A map of qubit index to an array of indexes to which this should be entangled -`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. @@ -351,7 +351,7 @@ Validated/converted map -`qiskit.utils.has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed. @@ -363,7 +363,7 @@ Check if IBMQ is installed. -`qiskit.utils.has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/backend_utils.py "view source code") Check if Aer is installed. @@ -375,7 +375,7 @@ Check if Aer is installed. -`qiskit.utils.name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/name_unnamed_args.py "view source code") +`qiskit.utils.name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. @@ -482,7 +482,7 @@ from qiskit.utils import LazyImportTester -`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -603,7 +603,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -617,7 +617,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. diff --git a/docs/api/qiskit/0.44/visualization.md b/docs/api/qiskit/0.44/visualization.md index 3af9e359c58..94a9cb108c2 100644 --- a/docs/api/qiskit/0.44/visualization.md +++ b/docs/api/qiskit/0.44/visualization.md @@ -237,7 +237,7 @@ You can find code examples for each visualization functions on the individual fu -`qiskit.visualization.VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/exceptions.py "view source code") +`qiskit.visualization.VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. From 27179fc2bbb45159454662eb42f7c81871d7b40a Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:00:51 +0100 Subject: [PATCH 25/41] Regenerate qiskit 0.45.3 --- docs/api/qiskit/0.45/algorithms.md | 6 +- docs/api/qiskit/0.45/assembler.md | 6 +- docs/api/qiskit/0.45/circuit.md | 4 +- docs/api/qiskit/0.45/circuit_classical.md | 66 ++++---- docs/api/qiskit/0.45/circuit_library.md | 142 ++++++++--------- docs/api/qiskit/0.45/circuit_singleton.md | 6 +- docs/api/qiskit/0.45/compiler.md | 8 +- docs/api/qiskit/0.45/converters.md | 18 +-- docs/api/qiskit/0.45/dagcircuit.md | 4 +- docs/api/qiskit/0.45/exceptions.md | 8 +- docs/api/qiskit/0.45/execute.md | 2 +- docs/api/qiskit/0.45/extensions.md | 2 +- docs/api/qiskit/0.45/opflow.md | 8 +- docs/api/qiskit/0.45/passmanager.md | 2 +- docs/api/qiskit/0.45/providers.md | 10 +- .../qiskit/0.45/providers_fake_provider.md | 8 +- docs/api/qiskit/0.45/pulse.md | 144 +++++++++--------- docs/api/qiskit/0.45/qasm.md | 8 +- docs/api/qiskit/0.45/qasm2.md | 16 +- docs/api/qiskit/0.45/qasm3.md | 16 +- .../0.45/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.45/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- .../qiskit.algorithms.EvolutionProblem.md | 2 +- .../0.45/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.45/qiskit.algorithms.Grover.md | 2 +- .../0.45/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- .../qiskit.algorithms.ImaginaryEvolver.md | 2 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../api/qiskit/0.45/qiskit.algorithms.PVQD.md | 2 +- .../0.45/qiskit.algorithms.PVQDResult.md | 2 +- .../0.45/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.45/qiskit.algorithms.QAOA.md | 2 +- .../0.45/qiskit.algorithms.RealEvolver.md | 2 +- .../0.45/qiskit.algorithms.RealTimeEvolver.md | 2 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 2 +- .../qiskit.algorithms.SciPyRealEvolver.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 2 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.45/qiskit.algorithms.TrotterQRTE.md | 2 +- docs/api/qiskit/0.45/qiskit.algorithms.VQD.md | 2 +- .../0.45/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.45/qiskit.algorithms.VQE.md | 2 +- .../qiskit/0.45/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.45/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 2 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 2 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 2 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.BaseQGT.md | 2 +- ...lgorithms.gradients.BaseSamplerGradient.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.45/qiskit.algorithms.gradients.QFI.md | 2 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 2 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 2 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 2 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 2 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 2 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 2 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.45/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.45/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.45/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.45/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.45/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.45/qiskit.algorithms.optimizers.GSLS.md | 2 +- ...t.algorithms.optimizers.GradientDescent.md | 2 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.45/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.45/qiskit.algorithms.optimizers.SPSA.md | 2 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 2 +- ...lgorithms.optimizers.SteppableOptimizer.md | 2 +- .../0.45/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.45/qiskit.algorithms.optimizers.UMDA.md | 2 +- ...optimizers.optimizer_utils.LearningRate.md | 2 +- ...thms.state_fidelities.BaseStateFidelity.md | 2 +- ...ithms.state_fidelities.ComputeUncompute.md | 2 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 2 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 2 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 2 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 2 +- .../qiskit/0.45/qiskit.assembler.RunConfig.md | 2 +- .../0.45/qiskit.circuit.AncillaQubit.md | 2 +- .../0.45/qiskit.circuit.AncillaRegister.md | 2 +- .../0.45/qiskit.circuit.AnnotatedOperation.md | 2 +- docs/api/qiskit/0.45/qiskit.circuit.Bit.md | 2 +- .../qiskit/0.45/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.45/qiskit.circuit.CircuitInstruction.md | 2 +- .../0.45/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.45/qiskit.circuit.Clbit.md | 2 +- .../0.45/qiskit.circuit.CommutationChecker.md | 2 +- .../0.45/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.45/qiskit.circuit.ControlFlowOp.md | 2 +- .../0.45/qiskit.circuit.ControlModifier.md | 2 +- .../0.45/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.45/qiskit.circuit.Delay.md | 2 +- .../0.45/qiskit.circuit.EquivalenceLibrary.md | 2 +- .../qiskit/0.45/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/0.45/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.45/qiskit.circuit.IfElseOp.md | 2 +- .../qiskit/0.45/qiskit.circuit.Instruction.md | 2 +- .../0.45/qiskit.circuit.InstructionSet.md | 2 +- .../0.45/qiskit.circuit.InverseModifier.md | 2 +- .../qiskit/0.45/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.45/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.45/qiskit.circuit.ParameterVector.md | 2 +- .../0.45/qiskit.circuit.PowerModifier.md | 2 +- .../0.45/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.45/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.45/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.45/qiskit.circuit.Register.md | 2 +- .../0.45/qiskit.circuit.SwitchCaseOp.md | 2 +- .../qiskit/0.45/qiskit.circuit.WhileLoopOp.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.AND.md | 2 +- .../0.45/qiskit.circuit.library.Barrier.md | 2 +- .../0.45/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.45/qiskit.circuit.library.C3XGate.md | 2 +- .../0.45/qiskit.circuit.library.C4XGate.md | 2 +- .../0.45/qiskit.circuit.library.CCXGate.md | 2 +- .../0.45/qiskit.circuit.library.CCZGate.md | 2 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.45/qiskit.circuit.library.CHGate.md | 2 +- .../0.45/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.45/qiskit.circuit.library.CRXGate.md | 2 +- .../0.45/qiskit.circuit.library.CRYGate.md | 2 +- .../0.45/qiskit.circuit.library.CRZGate.md | 2 +- .../0.45/qiskit.circuit.library.CSGate.md | 2 +- .../0.45/qiskit.circuit.library.CSXGate.md | 2 +- .../0.45/qiskit.circuit.library.CSdgGate.md | 2 +- .../0.45/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.45/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.45/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.45/qiskit.circuit.library.CUGate.md | 2 +- .../0.45/qiskit.circuit.library.CXGate.md | 2 +- .../0.45/qiskit.circuit.library.CYGate.md | 2 +- .../0.45/qiskit.circuit.library.CZGate.md | 2 +- .../0.45/qiskit.circuit.library.DCXGate.md | 2 +- .../0.45/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DiagonalGate.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.45/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.GRZ.md | 2 +- .../qiskit.circuit.library.GlobalPhaseGate.md | 2 +- .../0.45/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.45/qiskit.circuit.library.HGate.md | 2 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- .../qiskit.circuit.library.HamiltonianGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.45/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.IQP.md | 2 +- .../0.45/qiskit.circuit.library.Initialize.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- .../0.45/qiskit.circuit.library.Isometry.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- .../qiskit.circuit.library.LinearFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.45/qiskit.circuit.library.MCMT.md | 2 +- .../0.45/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.45/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.45/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.45/qiskit.circuit.library.MSGate.md | 2 +- .../0.45/qiskit.circuit.library.Measure.md | 2 +- .../0.45/qiskit.circuit.library.NLocal.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../0.45/qiskit.circuit.library.PauliGate.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.45/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.45/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.45/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.45/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.45/qiskit.circuit.library.RGate.md | 2 +- .../0.45/qiskit.circuit.library.RVGate.md | 2 +- .../0.45/qiskit.circuit.library.RXGate.md | 2 +- .../0.45/qiskit.circuit.library.RXXGate.md | 2 +- .../0.45/qiskit.circuit.library.RYGate.md | 2 +- .../0.45/qiskit.circuit.library.RYYGate.md | 2 +- .../0.45/qiskit.circuit.library.RZGate.md | 2 +- .../0.45/qiskit.circuit.library.RZXGate.md | 2 +- .../0.45/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.45/qiskit.circuit.library.Reset.md | 2 +- .../0.45/qiskit.circuit.library.SGate.md | 2 +- .../0.45/qiskit.circuit.library.SXGate.md | 2 +- .../0.45/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.45/qiskit.circuit.library.SdgGate.md | 2 +- ...qiskit.circuit.library.StatePreparation.md | 2 +- .../0.45/qiskit.circuit.library.SwapGate.md | 2 +- .../0.45/qiskit.circuit.library.TGate.md | 2 +- .../0.45/qiskit.circuit.library.TdgGate.md | 2 +- .../0.45/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.45/qiskit.circuit.library.U1Gate.md | 2 +- .../0.45/qiskit.circuit.library.U2Gate.md | 2 +- .../0.45/qiskit.circuit.library.U3Gate.md | 2 +- .../0.45/qiskit.circuit.library.UCGate.md | 2 +- .../qiskit.circuit.library.UCPauliRotGate.md | 2 +- .../0.45/qiskit.circuit.library.UCRXGate.md | 2 +- .../0.45/qiskit.circuit.library.UCRYGate.md | 2 +- .../0.45/qiskit.circuit.library.UCRZGate.md | 2 +- .../0.45/qiskit.circuit.library.UGate.md | 2 +- .../qiskit.circuit.library.UnitaryGate.md | 2 +- .../qiskit.circuit.library.UnitaryOverlap.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.45/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.45/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 2 +- .../qiskit.circuit.library.XXPlusYYGate.md | 2 +- .../0.45/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.45/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../0.45/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.45/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.45/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.45/qiskit.dagcircuit.DAGDependency.md | 2 +- .../0.45/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.45/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.45/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.45/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../qiskit.extensions.SingleQubitUnitary.md | 2 +- .../qiskit/0.45/qiskit.extensions.Snapshot.md | 2 +- .../qiskit/0.45/qiskit.opflow.OperatorBase.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.45/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.45/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.45/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.45/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.45/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.45/qiskit.opflow.gradients.QFI.md | 2 +- .../0.45/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.45/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.45/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.45/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.45/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.45/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- .../0.45/qiskit.passmanager.BaseController.md | 2 +- .../qiskit.passmanager.BasePassManager.md | 2 +- ...iskit.passmanager.ConditionalController.md | 2 +- .../qiskit.passmanager.DoWhileController.md | 2 +- .../0.45/qiskit.passmanager.FlowController.md | 2 +- ...qiskit.passmanager.FlowControllerLinear.md | 2 +- .../0.45/qiskit.passmanager.GenericPass.md | 2 +- .../qiskit.passmanager.PassManagerState.md | 2 +- .../0.45/qiskit.passmanager.PropertySet.md | 2 +- .../0.45/qiskit.passmanager.WorkflowStatus.md | 2 +- .../qiskit.primitives.BackendEstimator.md | 2 +- .../0.45/qiskit.primitives.BackendSampler.md | 2 +- .../0.45/qiskit.primitives.BaseEstimator.md | 2 +- .../0.45/qiskit.primitives.BaseSampler.md | 2 +- .../0.45/qiskit.primitives.Estimator.md | 2 +- .../0.45/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.45/qiskit.primitives.Sampler.md | 2 +- .../0.45/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.45/qiskit.providers.Backend.md | 2 +- .../qiskit/0.45/qiskit.providers.BackendV1.md | 2 +- .../qiskit/0.45/qiskit.providers.BackendV2.md | 2 +- .../qiskit.providers.BackendV2Converter.md | 2 +- docs/api/qiskit/0.45/qiskit.providers.Job.md | 2 +- .../qiskit/0.45/qiskit.providers.JobStatus.md | 2 +- .../api/qiskit/0.45/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.45/qiskit.providers.Options.md | 2 +- .../qiskit/0.45/qiskit.providers.Provider.md | 2 +- .../0.45/qiskit.providers.ProviderV1.md | 2 +- .../0.45/qiskit.providers.QubitProperties.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 2 +- .../qiskit.providers.fake_provider.Fake1Q.md | 2 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 2 +- ...t.providers.fake_provider.FakeBackendV2.md | 2 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 2 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 2 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 2 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 2 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 2 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 2 +- ....fake_provider.FakeProviderForBackendV2.md | 2 +- ...oviders.fake_provider.FakeQasmSimulator.md | 2 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 2 +- ...iskit.providers.fake_provider.FakeTokyo.md | 2 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.45/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../qiskit.providers.models.GateProperties.md | 2 +- .../0.45/qiskit.providers.models.JobStatus.md | 2 +- .../0.45/qiskit.providers.models.Nduv.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- docs/api/qiskit/0.45/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.45/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.45/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.45/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.45/qiskit.pulse.instructions.Call.md | 2 +- .../0.45/qiskit.pulse.instructions.Delay.md | 2 +- .../0.45/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- ...qiskit.pulse.library.Constant_class.rst.md | 2 +- .../qiskit.pulse.library.Cos_class.rst.md | 2 +- .../qiskit.pulse.library.Drag_class.rst.md | 2 +- .../qiskit.pulse.library.GaussianDeriv.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- ...qiskit.pulse.library.Gaussian_class.rst.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 2 +- ...qiskit.pulse.library.Sawtooth_class.rst.md | 2 +- .../0.45/qiskit.pulse.library.SechDeriv.md | 2 +- .../0.45/qiskit.pulse.library.Sech_fun.rst.md | 2 +- .../qiskit.pulse.library.Sin_class.rst.md | 2 +- .../qiskit.pulse.library.Square_fun.rst.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 2 +- ...qiskit.pulse.library.Triangle_class.rst.md | 2 +- .../0.45/qiskit.pulse.library.Waveform.md | 2 +- ...skit.pulse.library.gaussian_square_echo.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 2 +- .../0.45/qiskit.pulse.transforms.AlignFunc.md | 2 +- .../0.45/qiskit.pulse.transforms.AlignLeft.md | 2 +- .../qiskit.pulse.transforms.AlignRight.md | 2 +- ...qiskit.pulse.transforms.AlignSequential.md | 2 +- .../0.45/qiskit.qobj.GateCalibration.md | 2 +- .../0.45/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.md | 2 +- .../0.45/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.45/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.45/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.45/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.45/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.45/qiskit.qobj.QasmQobjInstruction.md | 2 +- .../0.45/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.45/qiskit.qobj.QobjHeader.md | 2 +- .../0.45/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.45/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.45/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.45/qiskit.quantum_info.Choi.md | 2 +- .../0.45/qiskit.quantum_info.Clifford.md | 2 +- .../0.45/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.45/qiskit.quantum_info.Kraus.md | 2 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 2 +- .../0.45/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.45/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.45/qiskit.quantum_info.Pauli.md | 2 +- .../0.45/qiskit.quantum_info.PauliList.md | 2 +- .../0.45/qiskit.quantum_info.Quaternion.md | 2 +- .../0.45/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.45/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerState.md | 2 +- .../0.45/qiskit.quantum_info.Statevector.md | 2 +- .../0.45/qiskit.quantum_info.Stinespring.md | 2 +- .../0.45/qiskit.quantum_info.SuperOp.md | 2 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 2 +- .../0.45/qiskit.quantum_info.XXDecomposer.md | 2 +- .../0.45/qiskit.quantum_info.Z2Symmetries.md | 2 +- .../0.45/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 2 +- ...iskit.result.CorrelatedReadoutMitigator.md | 2 +- docs/api/qiskit/0.45/qiskit.result.Counts.md | 2 +- .../qiskit.result.LocalReadoutMitigator.md | 2 +- .../0.45/qiskit.result.ProbDistribution.md | 2 +- .../0.45/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/0.45/qiskit.result.Result.md | 2 +- .../qiskit/0.45/qiskit.result.ResultError.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 2 +- .../0.45/qiskit.synthesis.LieTrotter.md | 2 +- .../qiskit.synthesis.MatrixExponential.md | 2 +- .../0.45/qiskit.synthesis.ProductFormula.md | 2 +- .../qiskit/0.45/qiskit.synthesis.QDrift.md | 2 +- ...it.synthesis.SolovayKitaevDecomposition.md | 2 +- .../0.45/qiskit.synthesis.SuzukiTrotter.md | 2 +- .../0.45/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.45/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.45/qiskit.transpiler.Layout.md | 2 +- .../0.45/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 2 +- .../qiskit/0.45/qiskit.transpiler.Target.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- .../0.45/qiskit.transpiler.TranspileLayout.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.AlignMeasures.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.45/qiskit.transpiler.passes.CheckMap.md | 2 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...r.passes.CommutativeInverseCancellation.md | 2 +- ...transpiler.passes.Commuting2qGateRouter.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- ...transpiler.passes.ConstrainedReschedule.md | 2 +- ...t.transpiler.passes.ContainsInstruction.md | 2 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 2 +- .../0.45/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.45/qiskit.transpiler.passes.Depth.md | 2 +- ...t.transpiler.passes.DynamicalDecoupling.md | 2 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- .../qiskit.transpiler.passes.GatesInBasis.md | 2 +- ...it.transpiler.passes.HighLevelSynthesis.md | 2 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 2 +- ...nspiler.passes.InstructionDurationCheck.md | 2 +- ...t.transpiler.passes.InverseCancellation.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- .../qiskit.transpiler.passes.MinimumPoint.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NormalizeRXAngle.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...passes.Optimize1qGatesSimpleCommutation.md | 2 +- ...kit.transpiler.passes.OptimizeCliffords.md | 2 +- .../0.45/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 2 +- ....transpiler.passes.RXCalibrationBuilder.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 2 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- ....passes.ResetAfterMeasureSimplification.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- ...qiskit.transpiler.passes.SabrePreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetIOLatency.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.45/qiskit.transpiler.passes.Size.md | 2 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 2 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- ...it.transpiler.passes.TimeUnitConversion.md | 2 +- ...iler.passes.TranslateParameterizedGates.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- ...qiskit.transpiler.passes.UnrollForLoops.md | 2 +- .../0.45/qiskit.transpiler.passes.Unroller.md | 2 +- .../qiskit.transpiler.passes.VF2Layout.md | 2 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 2 +- ...it.transpiler.passes.ValidatePulseGates.md | 2 +- .../0.45/qiskit.transpiler.passes.Width.md | 2 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 2 +- ....plugin.HighLevelSynthesisPluginManager.md | 2 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 2 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 2 +- ...rs.plugin.PassManagerStagePluginManager.md | 2 +- .../qiskit.transpiler.synthesis.aqc.AQC.md | 2 +- ...spiler.synthesis.aqc.AQCSynthesisPlugin.md | 2 +- ...spiler.synthesis.aqc.ApproximateCircuit.md | 2 +- ...er.synthesis.aqc.ApproximatingObjective.md | 2 +- ...ranspiler.synthesis.aqc.CNOTUnitCircuit.md | 2 +- ...nspiler.synthesis.aqc.CNOTUnitObjective.md | 2 +- ....synthesis.aqc.DefaultCNOTUnitObjective.md | 2 +- ...ler.synthesis.aqc.FastCNOTUnitObjective.md | 2 +- .../0.45/qiskit.utils.QuantumInstance.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 2 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.45/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.qcstyle.DefaultStyle.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.45/qpy.md | 6 +- docs/api/qiskit/0.45/quantum_info.md | 56 +++---- docs/api/qiskit/0.45/result.md | 8 +- docs/api/qiskit/0.45/scheduler.md | 8 +- docs/api/qiskit/0.45/synthesis.md | 38 ++--- docs/api/qiskit/0.45/synthesis_aqc.md | 2 +- docs/api/qiskit/0.45/tools.md | 10 +- docs/api/qiskit/0.45/transpiler.md | 8 +- docs/api/qiskit/0.45/transpiler_plugins.md | 4 +- docs/api/qiskit/0.45/transpiler_preset.md | 26 ++-- docs/api/qiskit/0.45/utils.md | 38 ++--- docs/api/qiskit/0.45/visualization.md | 2 +- 774 files changed, 1087 insertions(+), 1087 deletions(-) diff --git a/docs/api/qiskit/0.45/algorithms.md b/docs/api/qiskit/0.45/algorithms.md index 0df1ac10953..292fdcecfb7 100644 --- a/docs/api/qiskit/0.45/algorithms.md +++ b/docs/api/qiskit/0.45/algorithms.md @@ -197,7 +197,7 @@ Algorithms that compute the fidelity of pairs of quantum states. -`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/exceptions.py "view source code") +`qiskit.algorithms.AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. @@ -219,7 +219,7 @@ Utility functions used by algorithms. -`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/aux_ops_evaluator.py "view source code") Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. @@ -253,7 +253,7 @@ ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in P -`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/observables_evaluator.py "view source code") +`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.45/assembler.md b/docs/api/qiskit/0.45/assembler.md index 761fecc58df..b6bc3e8244b 100644 --- a/docs/api/qiskit/0.45/assembler.md +++ b/docs/api/qiskit/0.45/assembler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.assembler -`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_circuits.py "view source code") +`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. @@ -69,7 +69,7 @@ qobj = assemble_circuits(circuits=[qc], -`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_schedules.py "view source code") +`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. @@ -135,7 +135,7 @@ pulseQobj = assemble_schedules(schedules=[schedule], -`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/disassemble.py "view source code") +`qiskit.assembler.disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.45/circuit.md b/docs/api/qiskit/0.45/circuit.md index 95e64bbe162..0cfc9f8b4bc 100644 --- a/docs/api/qiskit/0.45/circuit.md +++ b/docs/api/qiskit/0.45/circuit.md @@ -288,7 +288,7 @@ with qc.switch(cr) as case: -`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/random/utils.py "view source code") +`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. @@ -348,7 +348,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c -`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/exceptions.py "view source code") +`qiskit.circuit.CircuitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/exceptions.py "view source code") Base class for errors raised while processing a circuit. diff --git a/docs/api/qiskit/0.45/circuit_classical.md b/docs/api/qiskit/0.45/circuit_classical.md index 594c9574042..dfe15faf3d0 100644 --- a/docs/api/qiskit/0.45/circuit_classical.md +++ b/docs/api/qiskit/0.45/circuit_classical.md @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are -`qiskit.circuit.classical.expr.Expr`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`qiskit.circuit.classical.expr.Expr` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap -`final class qiskit.circuit.classical.expr.Var(var, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Var(var, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` -`final class qiskit.circuit.classical.expr.Value(value, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Value(value, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p -`final class qiskit.circuit.classical.expr.Unary(op, operand, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Unary(op, operand, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") A unary expression. @@ -118,7 +118,7 @@ Logical negation. `!operand`. -`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") A binary expression. @@ -235,7 +235,7 @@ Expressions in this system are defined to act only on certain sets of types. How -`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") A cast from one type to another, implied by the use of an expression in a different context. @@ -251,7 +251,7 @@ The functions and methods described in this section are a more user-friendly way -`qiskit.circuit.classical.expr.lift(value, /, type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift(value, /, type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Lift the given Python `value` to a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value") or [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var"). @@ -291,7 +291,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo -`qiskit.circuit.classical.expr.cast(operand, type, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.cast(operand, type, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create an explicit cast from the given value to the given type. @@ -316,7 +316,7 @@ There are helper constructor functions for each of the unary operations. -`qiskit.circuit.classical.expr.bit_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -339,7 +339,7 @@ Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) -`qiskit.circuit.classical.expr.logic_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -364,7 +364,7 @@ Similarly, the binary operations and relations have helper functions defined. -`qiskit.circuit.classical.expr.bit_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -387,7 +387,7 @@ Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint -`qiskit.circuit.classical.expr.bit_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -410,7 +410,7 @@ Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint( -`qiskit.circuit.classical.expr.bit_xor(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_xor(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘exclusive or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -433,7 +433,7 @@ Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.logic_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -456,7 +456,7 @@ Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool -`qiskit.circuit.classical.expr.logic_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -479,7 +479,7 @@ Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool( -`qiskit.circuit.classical.expr.equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create an ‘equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -502,7 +502,7 @@ Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3 -`qiskit.circuit.classical.expr.not_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.not_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘not equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -525,7 +525,7 @@ Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Ui -`qiskit.circuit.classical.expr.less(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -548,7 +548,7 @@ Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3) -`qiskit.circuit.classical.expr.less_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -571,7 +571,7 @@ Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(Classi -`qiskit.circuit.classical.expr.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -594,7 +594,7 @@ Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.greater_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -619,7 +619,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition -`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") Lift a legacy two-tuple equality condition into a new-style [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"). @@ -648,7 +648,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. @@ -720,7 +720,7 @@ For the convenience of simple visitors that only need to inspect the variables i -`qiskit.circuit.classical.expr.iter_vars(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.iter_vars(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") Get an iterator over the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") nodes referenced at any level in the given [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr"). @@ -750,7 +750,7 @@ Two expressions can be compared for direct structural equality by using the buil -`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") Do these two expressions have exactly the same tree structure, up to some key function for the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") objects? @@ -809,7 +809,7 @@ All types inherit from an abstract base class: -`qiskit.circuit.classical.types.Type`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") +`qiskit.circuit.classical.types.Type` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -821,13 +821,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q -`final class qiskit.circuit.classical.types.Bool`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Bool` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") The Boolean type. This has exactly two values: `True` and `False`. -`final class qiskit.circuit.classical.types.Uint(width)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Uint(width)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") An unsigned integer of fixed bit width. @@ -843,7 +843,7 @@ The low-level interface to querying the subtyping relationship is the [`order()` -`qiskit.circuit.classical.types.order(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.order(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") Get the ordering relationship between the two types as an enumeration value. @@ -872,7 +872,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. -`qiskit.circuit.classical.types.Ordering(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.Ordering(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -884,7 +884,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis -`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \le \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -915,7 +915,7 @@ False -`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \ge \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -946,7 +946,7 @@ False -`qiskit.circuit.classical.types.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") Get the greater of the two types, assuming that there is an ordering relation between them. Technically, this is a slightly restricted version of the concept of the ‘meet’ of the two types in that the return value must be one of the inputs. In practice in the type system there is no concept of a ‘sum’ type, so the ‘meet’ exists if and only if there is an ordering between the two types, and is equal to the greater of the two types. diff --git a/docs/api/qiskit/0.45/circuit_library.md b/docs/api/qiskit/0.45/circuit_library.md index 705e5eaa1e3..567ba26d88e 100644 --- a/docs/api/qiskit/0.45/circuit_library.md +++ b/docs/api/qiskit/0.45/circuit_library.md @@ -328,7 +328,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib -`qiskit.circuit.library.templates.nct.template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** @@ -342,7 +342,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** @@ -356,7 +356,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** @@ -370,7 +370,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** @@ -384,7 +384,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** @@ -398,7 +398,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** @@ -412,7 +412,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** @@ -426,7 +426,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** @@ -440,7 +440,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** @@ -454,7 +454,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** @@ -468,7 +468,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** @@ -482,7 +482,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** @@ -496,7 +496,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** @@ -510,7 +510,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** @@ -524,7 +524,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** @@ -538,7 +538,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** @@ -552,7 +552,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** @@ -566,7 +566,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** @@ -580,7 +580,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** @@ -594,7 +594,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** @@ -608,7 +608,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** @@ -622,7 +622,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** @@ -636,7 +636,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** @@ -650,7 +650,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** @@ -664,7 +664,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** @@ -678,7 +678,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** @@ -692,7 +692,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** @@ -706,7 +706,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** @@ -720,7 +720,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** @@ -734,7 +734,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** @@ -748,7 +748,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** @@ -762,7 +762,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** @@ -776,7 +776,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** @@ -790,7 +790,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** @@ -804,7 +804,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** @@ -818,7 +818,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** @@ -832,7 +832,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** @@ -846,7 +846,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** @@ -860,7 +860,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** @@ -874,7 +874,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** @@ -888,7 +888,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** @@ -902,7 +902,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** @@ -916,7 +916,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** @@ -930,7 +930,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** @@ -944,7 +944,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** @@ -958,7 +958,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** @@ -972,7 +972,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** @@ -990,7 +990,7 @@ Template circuits over Clifford gates. -`qiskit.circuit.library.clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`qiskit.circuit.library.clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** @@ -1004,7 +1004,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`qiskit.circuit.library.clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** @@ -1018,7 +1018,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`qiskit.circuit.library.clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** @@ -1032,7 +1032,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`qiskit.circuit.library.clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** @@ -1046,7 +1046,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`qiskit.circuit.library.clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** @@ -1060,7 +1060,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`qiskit.circuit.library.clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** @@ -1074,7 +1074,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`qiskit.circuit.library.clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** @@ -1088,7 +1088,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`qiskit.circuit.library.clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** @@ -1102,7 +1102,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`qiskit.circuit.library.clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** @@ -1116,7 +1116,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`qiskit.circuit.library.clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** @@ -1130,7 +1130,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`qiskit.circuit.library.clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** @@ -1144,7 +1144,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`qiskit.circuit.library.clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** @@ -1158,7 +1158,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`qiskit.circuit.library.clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** @@ -1172,7 +1172,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`qiskit.circuit.library.clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** @@ -1186,7 +1186,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`qiskit.circuit.library.clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** @@ -1200,7 +1200,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`qiskit.circuit.library.clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** @@ -1214,7 +1214,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`qiskit.circuit.library.clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** @@ -1228,7 +1228,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`qiskit.circuit.library.clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** @@ -1246,7 +1246,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui -`qiskit.circuit.library.rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`qiskit.circuit.library.rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. @@ -1254,7 +1254,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`qiskit.circuit.library.rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. @@ -1262,7 +1262,7 @@ Template for CX - RXGate - CX. -`qiskit.circuit.library.rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`qiskit.circuit.library.rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. @@ -1270,7 +1270,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`qiskit.circuit.library.rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. @@ -1278,7 +1278,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`qiskit.circuit.library.rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. @@ -1286,7 +1286,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`qiskit.circuit.library.rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.45/circuit_singleton.md b/docs/api/qiskit/0.45/circuit_singleton.md index 780729a79db..546692d681d 100644 --- a/docs/api/qiskit/0.45/circuit_singleton.md +++ b/docs/api/qiskit/0.45/circuit_singleton.md @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir -`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. @@ -56,7 +56,7 @@ The exception to be aware of with this class though are the [`Instruction`](qisk -`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. @@ -64,7 +64,7 @@ This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton -`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances diff --git a/docs/api/qiskit/0.45/compiler.md b/docs/api/qiskit/0.45/compiler.md index 69001d97c01..8f24cf1c7b9 100644 --- a/docs/api/qiskit/0.45/compiler.md +++ b/docs/api/qiskit/0.45/compiler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.compiler -`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/assembler.py "view source code") +`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. @@ -107,7 +107,7 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will -`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/scheduler.py "view source code") +`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`. @@ -136,7 +136,7 @@ A pulse `Schedule` that implements the input circuit -`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/transpiler.py "view source code") +`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. @@ -284,7 +284,7 @@ The transpiled circuit(s). -`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/sequencer.py "view source code") +`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.45/converters.md b/docs/api/qiskit/0.45/converters.md index c3fc7845d83..3f52688090c 100644 --- a/docs/api/qiskit/0.45/converters.md +++ b/docs/api/qiskit/0.45/converters.md @@ -22,7 +22,7 @@ python_api_name: qiskit.converters -`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_dag.py "view source code") +`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_dag.py "view source code") Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -66,7 +66,7 @@ dag = circuit_to_dag(circ) -`qiskit.converters.dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dag_to_circuit.py "view source code") +`qiskit.converters.dag_to_circuit(dag, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. @@ -110,7 +110,7 @@ circuit.draw('mpl') -`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_instruction.py "view source code") +`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -155,7 +155,7 @@ circuit_to_instruction(circ) -`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_gate.py "view source code") +`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -184,7 +184,7 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g -`qiskit.converters.ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/ast_to_dag.py "view source code") +`qiskit.converters.ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. @@ -226,7 +226,7 @@ dag = ast_to_dag(ast) -`qiskit.converters.dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dagdependency_to_circuit.py "view source code") +`qiskit.converters.dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. @@ -246,7 +246,7 @@ the circuit representing the input dag dependency. -`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_dagdependency.py "view source code") +`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -267,7 +267,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dag_to_dagdependency.py "view source code") +`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. @@ -288,7 +288,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dagdependency_to_dag.py "view source code") +`qiskit.converters.dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.45/dagcircuit.md b/docs/api/qiskit/0.45/dagcircuit.md index c8c7edd1531..6f4edc1b984 100644 --- a/docs/api/qiskit/0.45/dagcircuit.md +++ b/docs/api/qiskit/0.45/dagcircuit.md @@ -36,7 +36,7 @@ python_api_name: qiskit.dagcircuit -`qiskit.dagcircuit.DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. @@ -46,7 +46,7 @@ Set the error message. -`qiskit.dagcircuit.DAGDependencyError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGDependencyError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGDependency object. diff --git a/docs/api/qiskit/0.45/exceptions.md b/docs/api/qiskit/0.45/exceptions.md index 75f0f6a127d..272055feefa 100644 --- a/docs/api/qiskit/0.45/exceptions.md +++ b/docs/api/qiskit/0.45/exceptions.md @@ -24,7 +24,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: -`qiskit.exceptions.QiskitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") Base class for errors raised by Qiskit. @@ -42,7 +42,7 @@ Qiskit has several optional features that depend on other packages that are not -`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") Raised when an optional library is missing. @@ -54,7 +54,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, -`qiskit.exceptions.QiskitUserConfigError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitUserConfigError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") Raised when an error is encountered reading a user config file. @@ -64,7 +64,7 @@ Set the error message. -`qiskit.exceptions.InvalidFileError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.InvalidFileError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") Raised when the file provided is not valid for the specific task. diff --git a/docs/api/qiskit/0.45/execute.md b/docs/api/qiskit/0.45/execute.md index 9cf90e10d83..a1c2df1083b 100644 --- a/docs/api/qiskit/0.45/execute.md +++ b/docs/api/qiskit/0.45/execute.md @@ -22,7 +22,7 @@ python_api_name: qiskit.execute_function -`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/execute_function.py "view source code") +`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.45/extensions.md b/docs/api/qiskit/0.45/extensions.md index b5cc42e1b05..f040f780390 100644 --- a/docs/api/qiskit/0.45/extensions.md +++ b/docs/api/qiskit/0.45/extensions.md @@ -38,7 +38,7 @@ The additional gates in this module will tend to raise a custom exception when t -`qiskit.extensions.ExtensionError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/exceptions.py "view source code") +`qiskit.extensions.ExtensionError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/exceptions.py "view source code") Base class for errors raised by extensions module. diff --git a/docs/api/qiskit/0.45/opflow.md b/docs/api/qiskit/0.45/opflow.md index 00e79515761..062c8f3a9a2 100644 --- a/docs/api/qiskit/0.45/opflow.md +++ b/docs/api/qiskit/0.45/opflow.md @@ -99,7 +99,7 @@ The Converter submodules include objects which manipulate Operators, usually rec -`qiskit.opflow.commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") Deprecated: Compute commutator of op\_a and op\_b. @@ -128,7 +128,7 @@ the commutator -`qiskit.opflow.anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") Deprecated: Compute anti-commutator of op\_a and op\_b. @@ -157,7 +157,7 @@ the anti-commutator -`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") Deprecated: Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) @@ -202,7 +202,7 @@ the double commutator -`qiskit.opflow.OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/exceptions.py "view source code") +`qiskit.opflow.OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/exceptions.py "view source code") Deprecated: For Opflow specific errors. diff --git a/docs/api/qiskit/0.45/passmanager.md b/docs/api/qiskit/0.45/passmanager.md index a2eb80c1741..23b9bef942a 100644 --- a/docs/api/qiskit/0.45/passmanager.md +++ b/docs/api/qiskit/0.45/passmanager.md @@ -165,7 +165,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza -`qiskit.passmanager.PassManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/exceptions.py "view source code") +`qiskit.passmanager.PassManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/exceptions.py "view source code") Pass manager error. diff --git a/docs/api/qiskit/0.45/providers.md b/docs/api/qiskit/0.45/providers.md index 96f745f9479..3bf54ae7c28 100644 --- a/docs/api/qiskit/0.45/providers.md +++ b/docs/api/qiskit/0.45/providers.md @@ -79,7 +79,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p -`qiskit.providers.QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. @@ -89,7 +89,7 @@ Set the error message. -`qiskit.providers.BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. @@ -99,7 +99,7 @@ Set the error message. -`qiskit.providers.JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. @@ -109,7 +109,7 @@ Set the error message. -`qiskit.providers.JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. @@ -119,7 +119,7 @@ Set the error message. -`qiskit.providers.BackendConfigurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendConfigurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") Base class for errors raised by the BackendConfiguration. diff --git a/docs/api/qiskit/0.45/providers_fake_provider.md b/docs/api/qiskit/0.45/providers_fake_provider.md index fbccc42bc66..0e3cad783c1 100644 --- a/docs/api/qiskit/0.45/providers_fake_provider.md +++ b/docs/api/qiskit/0.45/providers_fake_provider.md @@ -211,7 +211,7 @@ The fake backends based on IBM hardware are based on a set of base classes: -`qiskit.providers.fake_provider.fake_backend.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.fake_backend.FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend.py "view source code") A fake backend class for testing and noisy simulation using real backend snapshots. @@ -221,7 +221,7 @@ FakeBackendV2 initializer. -`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend.py "view source code") This is a dummy backend just for testing purposes. @@ -234,7 +234,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakeQasmBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") +`qiskit.providers.fake_provider.FakeQasmBackend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") A fake OpenQASM backend. @@ -247,7 +247,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakePulseBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") +`qiskit.providers.fake_provider.FakePulseBackend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") A fake pulse backend. diff --git a/docs/api/qiskit/0.45/pulse.md b/docs/api/qiskit/0.45/pulse.md index a3b4d244a98..219cd1ced34 100644 --- a/docs/api/qiskit/0.45/pulse.md +++ b/docs/api/qiskit/0.45/pulse.md @@ -73,7 +73,7 @@ These are all instances of the same base class: -`qiskit.pulse.instructions.Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/instruction.py "view source code") +`qiskit.pulse.instructions.Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -118,7 +118,7 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -`qiskit.pulse.library.constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -146,7 +146,7 @@ $$ -`qiskit.pulse.library.zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -173,7 +173,7 @@ $$ -`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -205,7 +205,7 @@ with the convention $\text{sign}(0) = 1$. -`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -254,7 +254,7 @@ plt.show() -`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -303,7 +303,7 @@ plt.show() -`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -333,7 +333,7 @@ $$ -`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -363,7 +363,7 @@ $$ -`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -405,7 +405,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -437,7 +437,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -477,7 +477,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -510,7 +510,7 @@ i.e. the derivative of $\text{sech}$. -`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -554,7 +554,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -646,7 +646,7 @@ All channels are children of the same abstract base class: -`qiskit.pulse.channels.Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.Channel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -701,7 +701,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`qiskit.pulse.transforms.AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -717,7 +717,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -742,7 +742,7 @@ A `Schedule` with the additional acquisition instructions. -`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. @@ -811,7 +811,7 @@ The input list of schedules transformed to have their measurements aligned. -`qiskit.pulse.transforms.block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. @@ -840,7 +840,7 @@ Scheduled pulse program. -`qiskit.pulse.transforms.compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. @@ -860,7 +860,7 @@ Compressed schedules. -`qiskit.pulse.transforms.flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. @@ -884,7 +884,7 @@ Flatten pulse program. -`qiskit.pulse.transforms.inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. @@ -910,7 +910,7 @@ A schedule without subroutine. -`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. @@ -938,7 +938,7 @@ The padded schedule. -`qiskit.pulse.transforms.remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. @@ -958,7 +958,7 @@ A schedule without directives. -`qiskit.pulse.transforms.remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. @@ -984,7 +984,7 @@ The DAG transforms create DAG representation of input program. This can be used -`qiskit.pulse.transforms.block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/dag.py "view source code") +`qiskit.pulse.transforms.block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. @@ -1044,7 +1044,7 @@ A sequence of transformations to generate a target code. -`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/base_transforms.py "view source code") +`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. @@ -1257,7 +1257,7 @@ The above is just a small taste of what is possible with the builder. See the re -`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. @@ -1321,7 +1321,7 @@ DriveChannel(0) -`qiskit.pulse.builder.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. @@ -1349,7 +1349,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. @@ -1386,7 +1386,7 @@ List of control channels associated with the supplied ordered list of qubits. -`qiskit.pulse.builder.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. @@ -1414,7 +1414,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. @@ -1475,7 +1475,7 @@ drive_sched.draw() -`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1514,7 +1514,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. @@ -1583,7 +1583,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1799,7 +1799,7 @@ ScheduleBlock( -`qiskit.pulse.builder.delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. @@ -1824,7 +1824,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. @@ -1849,7 +1849,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. @@ -1876,7 +1876,7 @@ main_prog.assign_references(subroutine_dict={("x_gate", "q0"): subroutine}) -`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. @@ -1901,7 +1901,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. @@ -1928,7 +1928,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. @@ -1953,7 +1953,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. @@ -1980,7 +1980,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Simulator snapshot. @@ -2024,7 +2024,7 @@ pulse_prog.draw() -`qiskit.pulse.builder.align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. @@ -2072,7 +2072,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. @@ -2126,7 +2126,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. @@ -2163,7 +2163,7 @@ None -`qiskit.pulse.builder.align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. @@ -2200,7 +2200,7 @@ None -`qiskit.pulse.builder.align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. @@ -2237,7 +2237,7 @@ None -`qiskit.pulse.builder.circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. @@ -2268,7 +2268,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. @@ -2314,7 +2314,7 @@ None -`qiskit.pulse.builder.phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. @@ -2351,7 +2351,7 @@ None -`qiskit.pulse.builder.transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. @@ -2401,7 +2401,7 @@ MemorySlot(0) -`qiskit.pulse.builder.measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. @@ -2458,7 +2458,7 @@ The `register` the qubit measurement result will be stored in. -`qiskit.pulse.builder.measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. @@ -2493,7 +2493,7 @@ The `register`s the qubit measurement results will be stored in. -`qiskit.pulse.builder.delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -2543,7 +2543,7 @@ with pulse.build(backend) as u3_sched: -`qiskit.pulse.builder.cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.cx(control, target)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. @@ -2567,7 +2567,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u1(theta, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. @@ -2593,7 +2593,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u2(phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. @@ -2619,7 +2619,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u3(theta, phi, lam, qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. @@ -2645,7 +2645,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.x(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. @@ -2698,7 +2698,7 @@ There are 1e-06 seconds in 4500 samples. -`qiskit.pulse.builder.active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. @@ -2720,7 +2720,7 @@ builder context. -`qiskit.pulse.builder.active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. @@ -2751,7 +2751,7 @@ with pulse.build(backend, -`qiskit.pulse.builder.active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. @@ -2783,7 +2783,7 @@ with pulse.build( -`qiskit.pulse.builder.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. @@ -2815,7 +2815,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. @@ -2851,7 +2851,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2871,7 +2871,7 @@ The time that elapses in `samples`. -`qiskit.pulse.builder.seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. @@ -2901,7 +2901,7 @@ The number of samples for the time to elapse -`qiskit.pulse.PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. @@ -2911,7 +2911,7 @@ Set the error message. -`qiskit.pulse.BackendNotSet(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.BackendNotSet(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") Raised if the builder context does not have a backend. @@ -2921,7 +2921,7 @@ Set the error message. -`qiskit.pulse.NoActiveBuilder(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.NoActiveBuilder(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") Raised if no builder context is active. @@ -2931,7 +2931,7 @@ Set the error message. -`qiskit.pulse.UnassignedDurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedDurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") Raised if instruction duration is unassigned. @@ -2941,7 +2941,7 @@ Set the error message. -`qiskit.pulse.UnassignedReferenceError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedReferenceError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") Raised if subroutine is unassigned. diff --git a/docs/api/qiskit/0.45/qasm.md b/docs/api/qiskit/0.45/qasm.md index 6f48b00437e..9d8fe647ce3 100644 --- a/docs/api/qiskit/0.45/qasm.md +++ b/docs/api/qiskit/0.45/qasm.md @@ -22,7 +22,7 @@ python_api_name: qiskit.qasm -`qiskit.qasm.Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/qasm.py "view source code") +`qiskit.qasm.Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. @@ -32,19 +32,19 @@ Create an OPENQASM circuit object. -`qiskit.qasm.OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. -`qiskit.qasm.QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). -`qiskit.qasm.QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.45/qasm2.md b/docs/api/qiskit/0.45/qasm2.md index 83dc3a58f5d..8a12713c197 100644 --- a/docs/api/qiskit/0.45/qasm2.md +++ b/docs/api/qiskit/0.45/qasm2.md @@ -34,7 +34,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -59,7 +59,7 @@ A circuit object representing the same OpenQASM 2 program. -`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -89,7 +89,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/parse.py "view source code") +`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/parse.py "view source code") Information about a custom instruction that should be defined during the parse. @@ -129,7 +129,7 @@ Similar to other serialisation modules in Python, this module offers two public -`qiskit.qasm2.dump(circuit, filename_or_stream, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dump(circuit, filename_or_stream, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/export.py "view source code") Dump a circuit as an OpenQASM 2 program to a file or stream. @@ -146,7 +146,7 @@ Dump a circuit as an OpenQASM 2 program to a file or stream. -`qiskit.qasm2.dumps(circuit, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dumps(circuit, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/export.py "view source code") Export a circuit to an OpenQASM 2 program in a string. @@ -174,7 +174,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep -`qiskit.qasm2.QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2Error(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") A general error raised by the OpenQASM 2 interoperation layer. @@ -186,7 +186,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`qiskit.qasm2.QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to parse an OpenQASM 2 file. @@ -198,7 +198,7 @@ When the exporters fail to export a circuit, likely because it has structure tha -`qiskit.qasm2.QASM2ExportError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ExportError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. diff --git a/docs/api/qiskit/0.45/qasm3.md b/docs/api/qiskit/0.45/qasm3.md index 8f96a521671..2a9d9e16303 100644 --- a/docs/api/qiskit/0.45/qasm3.md +++ b/docs/api/qiskit/0.45/qasm3.md @@ -28,7 +28,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`qiskit.qasm3.dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. @@ -42,7 +42,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`qiskit.qasm3.dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. @@ -63,7 +63,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exporter.py "view source code") +`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -117,7 +117,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`qiskit.qasm3.QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -129,7 +129,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`qiskit.qasm3.ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/experimental.py "view source code") +`qiskit.qasm3.ExperimentalFeatures(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/experimental.py "view source code") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -190,7 +190,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`qiskit.qasm3.load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -214,7 +214,7 @@ a circuit representation of the OpenQASM 3 program. -`qiskit.qasm3.loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -240,7 +240,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`qiskit.qasm3.QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.md index de4979fcd99..f7a44231266 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/algorithm_job.py "view source code") +`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/algorithm_job.py "view source code") Bases: `PrimitiveJob` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.md index 917231f57c9..f0bbf38d4a4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.md index dc53ceaf236..1ca59c5b198 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`qiskit.algorithms.AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`qiskit.algorithms.AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.md index 9778e265b20..98670efb719 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.md index edd0e272638..8b3c7b1c14f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`qiskit.algorithms.AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.md index 4051be0e334..576b2006bd6 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`qiskit.algorithms.AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.md index 4d0d6eb3215..a6907afe27f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`qiskit.algorithms.AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.md index a9498e8a8a3..8122fa76566 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`qiskit.algorithms.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.md index 9c18a62150c..a7dc7e7fd8c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`qiskit.algorithms.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.md index c6164dcfff2..50e3586b6b5 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.md index 4cb176ff032..eda98864be7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.md index 0a5cb85807f..42fc24a6c66 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.md index 046c70efdee..aa07d022cf8 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7a7f35d26f4..ede52bf06be 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`qiskit.algorithms.FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.45/qiskit.algorithms.Grover.md index 0b94a105480..f55b760327f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.md index 977d2a9a396..0f5a30b8edd 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`qiskit.algorithms.GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.md index 74957695570..5ce0f297069 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index ece430429e2..af13f14dc95 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.md index 72546c03fc1..0d35f82c490 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`qiskit.algorithms.ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`qiskit.algorithms.ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.md index e6291e3956a..b8d6068c417 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`qiskit.algorithms.ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`qiskit.algorithms.ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.md index 40c5faef7d9..b53e53c53fc 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index b8f98e20d09..5f920d7999c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`qiskit.algorithms.IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.md index 1a601c58880..48a18b0df3b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 2669b311112..914517d33f3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 45df5bbb0c3..acaed788652 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.md index 29bb257e00a..90c88bbec90 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`qiskit.algorithms.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.md index bdf4d5b8bf4..9e1273a4fea 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`qiskit.algorithms.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.md index aea3b8f1573..1fe4e741d90 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.md index 1727f1dea96..19cf36d0c41 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.md index 76b98a19098..b075c4693a7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.md index cf02d72af1d..48535cc70d7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.md index 63b2cd76608..a1d947b12e0 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.md index bc306b087e6..f6a9608d55c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `PhaseEstimatorResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.md index 486abb9802e..e9abe4143d1 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`qiskit.algorithms.PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`qiskit.algorithms.PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.md index 5e726cf8378..9709e4f0590 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.md index e85bbab6c44..464d8029aad 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`qiskit.algorithms.RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`qiskit.algorithms.RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.md index 8549abdc95a..0121cc6137a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`qiskit.algorithms.RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`qiskit.algorithms.RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.md index a3253e2dba3..2f399554898 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.md index 7668d8ac2c9..208501f39da 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`qiskit.algorithms.SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`qiskit.algorithms.SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.md index d752525d45b..0300b9c94f9 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.md index 05c79622ae1..a75b45b4e1b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.md index b640cb7bfc7..855eeba2105 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.45/qiskit.algorithms.VQD.md index d01539315fc..8dce984e71b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.md index c03946ee637..4cb2bd32126 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`qiskit.algorithms.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.45/qiskit.algorithms.VQE.md index ae44fc557e2..d77ad4a6dd2 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.md index e9ac9c36924..b74257b4879 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.md index 5051acbb1eb..632a137af00 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.md index 25b8ec04483..604f1949c6e 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`qiskit.algorithms.eigensolvers.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.md index c39d4438a22..550b161871e 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`qiskit.algorithms.eigensolvers.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index 6d0fcde3f76..5155e5c8cd6 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index ac2acee428a..ac232e8403d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`qiskit.algorithms.eigensolvers.NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.md index 90336a6eabb..ddcf5db9d32 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.md index 49757ecb292..d06f637f376 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`qiskit.algorithms.eigensolvers.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 021186f237d..fdc6ed19241 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.md index 347b52b2992..ed95ca07f9e 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_qgt.py "view source code") +`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_qgt.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.md index 627f8d2532f..b92760cfeba 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.md index e61d975c556..11d6403c19c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") +`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 54113ee9d27..423cf3bfd05 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index cc4d7ab60f7..ab70499c028 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index 486e63fce91..77657d45544 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.md index 89d85d0d3b2..d14c4d7b776 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") +`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.md index b9d4203b5fb..52d3584ac31 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 2863d166d3a..f11e6967abb 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 5ad6e4b81f1..b2370b2e2f3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.md index d6ea8e1efd8..7e17a89c6b9 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`qiskit.algorithms.gradients.QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/qfi.py "view source code") +`qiskit.algorithms.gradients.QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/qfi.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.md index e55a4ebf3d7..5067ea3144f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/qfi_result.py "view source code") +`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.md index 3ff98992718..b6bb4abd3d7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/qgt_result.py "view source code") +`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/qgt_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index 8f9e0dcd72e..38921d8979b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") +`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.md index 96d16f70964..0a5e43a648b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") +`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 362c7b0345b..0842dbef846 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.md index 1a9bc1a1451..6025682f05e 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.md index dedf1b224b7..b0506850327 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") +`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 16bd085efe8..0ce42092d81 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 0337787f8cb..41a8593edd0 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 7bd1550fa24..acc27ceccc9 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 4ff601282ab..cef3ee04ad4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 45021770dba..2bdd63646b4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 09fca631dbb..3afaf3d3891 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.md index a45882aefb0..141618c21b7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 1188443cd57..3eb022c7ad2 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 326bc4e6f31..5230af83f20 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index d2f56c4c03e..9ee8a14442c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index ca26544e4c5..ff8bbaf95d3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.md index d1e8653adee..5d1f66fcf79 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 2cd37f8883d..36a8855c9d8 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`qiskit.algorithms.minimum_eigensolvers.VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.md index 485f6374ff2..09482a96c18 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.md index 4ddcac2f047..aee47c58314 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/aqgd.py "view source code") +`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.md index 0f77b251d92..5a274ecb5e1 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.md index 361a483071b..ca772aeef65 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.md index db426a5c852..153512c46dc 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/cg.py "view source code") +`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.md index 7543d839ccb..2a09e8bb732 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/cobyla.py "view source code") +`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.md index bf00d89e728..bb6a67a7e0b 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`qiskit.algorithms.optimizers.CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`qiskit.algorithms.optimizers.CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.md index b05d7706b7d..b50196ea6d7 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 749c06808ab..55b9adef7c4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.md index 4829502d2be..1331caa8737 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`qiskit.algorithms.optimizers.ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`qiskit.algorithms.optimizers.ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.md index b0bd87a923a..f22c1be58d4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gsls.py "view source code") +`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.md index ab79d295b05..c7826ea82ae 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.md index ae38ffb5889..a5070b6c48e 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.md index 310b791c2be..cccad01a1aa 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/imfil.py "view source code") +`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.md index ff87982268e..3e2aa775e40 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`qiskit.algorithms.optimizers.ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`qiskit.algorithms.optimizers.ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.md index 10eae8f72cb..8652d4734ae 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.md index e406ed20fb6..f2155ef9ad5 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.md index 555829e93f0..4aa6c035cda 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.md index 7026c543671..4cb349da668 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nft.py "view source code") +`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.md index 5581ae79888..f9b98337162 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`qiskit.algorithms.optimizers.Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.md index 392b99e21a5..ccdb2d5ce90 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`qiskit.algorithms.optimizers.OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.md index 67dd4e9dd9e..1421c3808a3 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index ec8cef4aa89..828473c9adb 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.md index 98a326734b9..a69eb0c5c46 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/powell.py "view source code") +`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.md index 0d0c6306e99..b0aa3766881 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.P_BFGS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.md index b922ae32aff..19495ad0f51 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.md index 3cbe1d75c6c..aeaeb0fb2e4 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/slsqp.py "view source code") +`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.md index 8f3f4d3d0db..86888dd4a2f 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/snobfit.py "view source code") +`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.md index 4396609369a..3806dbdcaab 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/spsa.py "view source code") +`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.md index 04441979a33..6bd53069245 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.md index 0c70d0cfb1d..838599407f5 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.md index ceb54fd70d4..3ee20e82641 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/tnc.py "view source code") +`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.md index e131b1ece73..3c8481aca16 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.md index 75b9c4da7d2..8e9f0a70e3d 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/umda.py "view source code") +`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 4f5a3260b66..26ce6ab9045 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index c42c31301b6..3f0fa11a6a0 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`qiskit.algorithms.state_fidelities.BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`qiskit.algorithms.state_fidelities.BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.md index e7a031cd074..27cb4d9a8f1 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.md index bfd66bbeb57..4f3241726f1 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index 081006659db..b10cab2b823 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index ee27e90431f..510346d602a 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `OdeSolver` diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index 7319880a54c..232b2d9cdb8 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index 6fafef56ce8..bb312d4f8af 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index b1c287fe947..f38c1dcb427 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 78006e66704..00a3808f267 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 60928096a0f..26146961572 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.45/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.md index 1f028d663be..48dca71c37a 100644 --- a/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.45/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/run_config.py "view source code") +`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/run_config.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.md index a6314e23692..51afb6b3900 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`qiskit.circuit.AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.md index 880158d874f..fe4c64abd36 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.md b/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.md index 357f3dbb6eb..12cee266c70 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.AnnotatedOperation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation -`qiskit.circuit.AnnotatedOperation(base_op, modifiers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.AnnotatedOperation(base_op, modifiers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Bit.md b/docs/api/qiskit/0.45/qiskit.circuit.Bit.md index 9f6d134d4c0..6c338e5825f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`qiskit.circuit.Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/bit.py "view source code") +`qiskit.circuit.Bit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/bit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.md index b98a871547a..582a9c601f5 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/break_loop.py "view source code") +`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.md index 7162f0d3591..02ed4d4eca5 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumcircuitdata.py "view source code") +`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.md index 5d967a4e0f8..11e35a88ed6 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.45/qiskit.circuit.Clbit.md index 209625521d5..fdd263d0e53 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`qiskit.circuit.Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.md b/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.md index 6b93a777383..af61f9e0cab 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.CommutationChecker.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CommutationChecker -`qiskit.circuit.CommutationChecker`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/commutation_checker.py "view source code") +`qiskit.circuit.CommutationChecker` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/commutation_checker.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.md index 0eeedf7594f..e6f333e8ceb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/continue_loop.py "view source code") +`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.md index a69fda2bc84..9a37717e543 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/control_flow.py "view source code") +`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.md b/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.md index 94b34cf4a62..df2b651f5bc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ControlModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlModifier -`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.md index eb7e10fdd82..648facdb014 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlledgate.py "view source code") +`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlledgate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Delay.md b/docs/api/qiskit/0.45/qiskit.circuit.Delay.md index 0e3a2be0a02..7071ee40d02 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`qiskit.circuit.Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/delay.py "view source code") +`qiskit.circuit.Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/delay.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.md index 237124e5bfa..ddee5bba5c1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`qiskit.circuit.EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/equivalence.py "view source code") +`qiskit.circuit.EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/equivalence.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.md index 85f1e80aab3..e87dcf718d3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/for_loop.py "view source code") +`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Gate.md b/docs/api/qiskit/0.45/qiskit.circuit.Gate.md index e3c3554d203..632f9370159 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/gate.py "view source code") +`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/gate.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.md index 80d997f5458..057e2ae1dd2 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/if_else.py "view source code") +`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.45/qiskit.circuit.Instruction.md index 5c2bb38505e..c6814359f82 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/instruction.py "view source code") +`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/instruction.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.md index 03f5ebfccfd..f50b6110d61 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`qiskit.circuit.InstructionSet(*, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/instructionset.py "view source code") +`qiskit.circuit.InstructionSet(*, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/instructionset.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.md b/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.md index 84b7b5700ab..975166e5927 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.InverseModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InverseModifier -`qiskit.circuit.InverseModifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.InverseModifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Operation.md b/docs/api/qiskit/0.45/qiskit.circuit.Operation.md index 8adfb1183fc..823a3ef5bfc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`qiskit.circuit.Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/operation.py "view source code") +`qiskit.circuit.Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/operation.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.45/qiskit.circuit.Parameter.md index 781fd7bddbb..3f293598e30 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`qiskit.circuit.Parameter(name, *, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parameter.py "view source code") +`qiskit.circuit.Parameter(name, *, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parameter.py "view source code") Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.md index 5ae48d16a63..56795fbf412 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`qiskit.circuit.ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parameterexpression.py "view source code") +`qiskit.circuit.ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parameterexpression.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.md index 520f093a3f5..713980d4fbe 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`qiskit.circuit.ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parametervector.py "view source code") +`qiskit.circuit.ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parametervector.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.md b/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.md index dbdcdbdbfa6..9178c74c0b9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.PowerModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.PowerModifier -`qiskit.circuit.PowerModifier(power)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.PowerModifier(power)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md index 85db6df4436..d6ae9a28d8f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumcircuit.py "view source code") +`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.md index 875090d8766..f35bf12a7f9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.45/qiskit.circuit.Qubit.md index eb99c735f57..9f87fa913dd 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`qiskit.circuit.Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.Register.md b/docs/api/qiskit/0.45/qiskit.circuit.Register.md index 1372468dc74..c40886c5224 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.Register.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`qiskit.circuit.Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/register.py "view source code") +`qiskit.circuit.Register(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/register.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.md index e3576de6fd5..19e19d402a3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/switch_case.py "view source code") +`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/switch_case.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.md index 3421f930641..e52404bedbb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`qiskit.circuit.WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/while_loop.py "view source code") +`qiskit.circuit.WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.md index 608eee1ffc9..77b19a5e5a2 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.md index 580a0dc5635..970bc41add9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 7976aaf3589..ad9078a7884 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index a608a715e01..cd0e5a92488 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.45/qiskit.circuit.library.AND.md index da66e384d33..a83d01d4256 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.md index da292d986e0..f873b80b61f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`qiskit.circuit.library.Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/barrier.py "view source code") +`qiskit.circuit.library.Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/barrier.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.md index 88aef8a9d43..24fea8377e4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.md index 1603e258da9..4ace79ec468 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.md index c772d0c9d26..32c45b8daf4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.md index 005d4e7141c..26b96709464 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.md index b66e079c981..ea96b4d1b4a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.md index 439257ea181..4408084169b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.md index 3fced622d01..40b655b85da 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.md index 01f6559dd4e..3d41817462c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.md index 130afebbe27..7ad6b3bcc29 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.md index 41ac30da875..b0ff2e2c61c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.md index b6f029642c5..e4dd059caf7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.md index b8db5df3f56..bb10b2f6d35 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.md index 30f80989626..79790d27cf8 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.md index 0c9a79b4e7f..1c3d21a6d98 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.md index e5fb3e61f31..e6160b26734 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.md index 8c585ab64cc..615a6d6ae4e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.md index 22bf88e97d1..e0edfa9a872 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.md index ba548116fc6..db6af393262 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.md index 3f18b6ccbe2..674a1a356ee 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.md index 591e29927a3..4479a790515 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.md index b99f5a5f3c2..273aac5767d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.md index 59c8f679ef7..3d751f8cb4c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.md index 63276c21f1d..af46a4015cd 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`qiskit.circuit.library.Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.md index 4166007c664..dfe3734b47d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.DiagonalGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate -`qiskit.circuit.library.DiagonalGate(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.DiagonalGate(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.md index 0cac1f4e175..dc24ba78fbf 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.md index 1143367b1ad..3319a70e991 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.md index 0a082563402..42795b95c49 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.md index b35160ece17..9d4b678731f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.md index db255724018..e95baa43296 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.md index 799c4c5eae8..c43d694bf77 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.md index 82035cc7f7e..14b54929043 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`qiskit.circuit.library.FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/fourier_checking.py "view source code") +`qiskit.circuit.library.FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.md index 2b347945bcc..ff69638f099 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.md index 2d920bebeef..ea2f291c07c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`qiskit.circuit.library.GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GR.md index 183eb138dea..3d714c82cbb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`qiskit.circuit.library.GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.md index c0f5fc38b4c..0f07b3068ef 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`qiskit.circuit.library.GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.md index 5ec5ea73c2f..c8040c0e700 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`qiskit.circuit.library.GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.md index 0ac047689a0..332eebfe77b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`qiskit.circuit.library.GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.md index baca94e36a8..06b2f51de13 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.md index 8d529f699ea..192899710b4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`qiskit.circuit.library.GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/graph_state.py "view source code") +`qiskit.circuit.library.GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/graph_state.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.md index e6d71ba00ed..c7469873eb2 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/grover_operator.py "view source code") +`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.md index c042e26076f..bf39a830d49 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.md index 006e6223217..989873fea1e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.md index 87942e621ab..80e14da82f8 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate -`qiskit.circuit.library.HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/hamiltonian_gate.py "view source code") +`qiskit.circuit.library.HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/hamiltonian_gate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.md index c5d834ff0ee..b86e9106e8b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/hidden_linear_function.py "view source code") +`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.md index 2c342ec3430..2dc7baaea51 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/i.py "view source code") +`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.md index 92e99d86667..331b29c6895 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`qiskit.circuit.library.IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/iqp.py "view source code") +`qiskit.circuit.library.IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/iqp.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.md index 2d217ed5490..b340fab8429 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Initialize -`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/initializer.py "view source code") +`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/initializer.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.md index b37d8c90357..4dddd64de85 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`qiskit.circuit.library.InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`qiskit.circuit.library.InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.md index 6d6bcd695a7..d96ccb4cd6e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.md index ff302fca799..c52b4694881 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Isometry.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Isometry -`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/isometry.py "view source code") +`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/isometry.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.md index 270cd2c35d1..3cb2c3067f3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.md index fc910e432ab..6e70869619d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`qiskit.circuit.library.LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`qiskit.circuit.library.LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.md index 698c2069af7..da8059bdca4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.md index e1eb044a717..6a3974c4985 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.md index 340863d6cbb..5cc3a196e1c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.md index b4f6daa56cd..4724726c7ac 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.md index 7ed72e21f76..45d2269683e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.md index b7a54907c72..6028d6f8dc9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.md index ebe1c080425..7a906f4c292 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.md index 095c07c7a0e..16e7f962816 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.md index 900219b2ccb..595f4ec2ef7 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.md index fdf4c6ec683..17fd61ad284 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`qiskit.circuit.library.Measure(label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/measure.py "view source code") +`qiskit.circuit.library.Measure(label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/measure.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.md index da8f856006b..39e0e4169d6 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/n_local.py "view source code") +`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.45/qiskit.circuit.library.OR.md index 3052aa5d179..5522c739a2e 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.md index b0595276aa5..0e2a4e6e8ca 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/pauli_evolution.py "view source code") +`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.md index 16a79464337..b11d0ce7b8a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.md index 0df193f63e2..f9261f642b3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`qiskit.circuit.library.PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`qiskit.circuit.library.PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.md index 6ad107169c2..6c1d2501cda 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.md index 81fa982ca8c..360e221d97f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.md index 8d6c5c7889b..4988adf5738 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`qiskit.circuit.library.PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.md index 3e0b6e66807..d3bc5f08b9f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/phase_estimation.py "view source code") +`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.md index 7ba7ce5a0d9..992d8eed3a4 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.md index efbe9c39024..bba2b506b55 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/phase_oracle.py "view source code") +`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.md index 0a91ba4b9e1..5bd38d16699 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 2ca0a368ddc..cd62b517a5c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 04f81ec2e53..35d06f09a7f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.md index 9ab40ea798d..e1048f5c295 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.md index 9aca9e1e909..c3eb7152c1c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.md index f0d74d9cc1f..a69204b49b2 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/basis_change/qft.py "view source code") +`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.md index 44c5e1f3b78..a5016e69e51 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.md index 20757e749c0..125e936177a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/quantum_volume.py "view source code") +`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.md index 9d953d0374c..c56da9980ab 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.md index 8c56065d434..de2658b6bf6 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.md index e8eb00db6a1..820d8b3991d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.md index 8a8ccc74a4f..3d6a800a9a1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/r.py "view source code") +`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.md index ced6c33df23..205d2a8dc6a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.md index f0e5ce02843..5bbae44338d 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.md index 24061aa495b..326395e5636 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.md index 3c79f9edb38..e7bcaea131f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.md index 5cf099df232..03095185e63 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.md index 0df7f8ba424..10e3d063436 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.md index c207023711d..6acb1c21db1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.md index 9192cf789be..8356358b8ca 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.md index 5836a49165b..34b7110cf34 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.md index 73b4339221c..b03cfc972b8 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`qiskit.circuit.library.Reset(label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/reset.py "view source code") +`qiskit.circuit.library.Reset(label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/reset.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.md index 1aa1ed685e3..f0903189c9f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.md index 38dc8dbdd11..71b995e9752 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.md index c33cccaa5c7..a91add88cf0 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.md index e50947cbe03..02a0e841045 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.md index 56b3136b379..d9f0c94c4e3 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.md index 11c3413fcb3..ab84d6624b5 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.md index c7ac1298598..ac5fbc0564a 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.md index f790dabf811..3ad175b56d2 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.md index aa6a19615d9..6180acacaa1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/two_local.py "view source code") +`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.md index a262c6b8948..37a0b7c0f1c 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.md index 55621ca0a7e..04226f13134 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u2.py "view source code") +`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.md index c481af14cda..336e509bcf9 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.md index d4b07d26065..d3810f94ddb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCGate -`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/uc.py "view source code") +`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/uc.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.md index 9912c3a8258..08dcf88c479 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate -`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") +`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.md index c28208b8eb1..ccd8f2d24ee 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRXGate -`qiskit.circuit.library.UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") +`qiskit.circuit.library.UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.md index 4bf04566d1f..1cc1ef16115 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRYGate -`qiskit.circuit.library.UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucry.py "view source code") +`qiskit.circuit.library.UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucry.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.md index eed0c3e1a64..99610e38abc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRZGate -`qiskit.circuit.library.UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") +`qiskit.circuit.library.UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.md index fbc072acf5b..0792927c7fc 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.md index 9657c32d1c5..84607269e2b 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate -`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/unitary.py "view source code") +`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/unitary.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.md b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.md index ef1938733d3..e71f934ce9f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.UnitaryOverlap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap -`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/overlap.py "view source code") +`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/overlap.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.md index 61fd1da07b5..c9442d184b2 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.md index c557a0d0930..715519d13d0 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.md index a98a30e2034..697db8482d1 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.md index d229f3fa473..6ffc7a6d8ce 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.md index baf31e743ef..51811f12622 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.md index 6d1b6790ea3..a979cf50631 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.md index 43e2817deda..14f691e8bdb 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.md index 692905af5e8..952be48b112 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.md index 2809871517d..9cfc54bfe8f 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.md index 9550f4d79ff..71e3da46a97 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.md index 89d2f8a0873..bc8375f4867 100644 --- a/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.45/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.md index aa69630a3c3..77378144d61 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`qiskit.dagcircuit.DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagcircuit.py "view source code") +`qiskit.dagcircuit.DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.md index edd4f906b84..e64507fead3 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagdepnode.py "view source code") +`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.md index f234be5b4a7..c473d91de94 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`qiskit.dagcircuit.DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagdependency.py "view source code") +`qiskit.dagcircuit.DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagdependency.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.md index b86ca8de448..48f0a1b4e94 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`qiskit.dagcircuit.DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.md index 91d0c85d266..28c4ed648bf 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`qiskit.dagcircuit.DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGNode(nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.md index daca6781a38..5d9a97d62e7 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.md index bed2b624465..7bbe8cf73b5 100644 --- a/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.45/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`qiskit.dagcircuit.DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.md index 41fdd9e4d30..cc5eb3c89ca 100644 --- a/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.45/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/quantum_initializer/squ.py "view source code") +`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.md index ef2ed4c36db..a39506edb19 100644 --- a/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.45/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/simulator/snapshot.py "view source code") +`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.md index cb8df8266b1..66fc971b599 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`qiskit.opflow.OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/operator_base.py "view source code") +`qiskit.opflow.OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/operator_base.py "view source code") Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.md index 092b19c9545..58a3f197728 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`qiskit.opflow.converters.AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/abelian_grouper.py "view source code") +`qiskit.opflow.converters.AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.md index 633026a34c7..ae9b9b3b615 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/circuit_sampler.py "view source code") +`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.md index 8fe872d7297..9a0f4e87be6 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`qiskit.opflow.converters.ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/converter_base.py "view source code") +`qiskit.opflow.converters.ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/converter_base.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.md index 880f85cbce5..dd2ecc15f9b 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.md index 7219e14cd1d..1935f2a604d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.md index ba4e63e54de..381d5320582 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`qiskit.opflow.converters.TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`qiskit.opflow.converters.TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.md index 681a9756df7..592e0f5f57b 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`qiskit.opflow.evolutions.EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolution_base.py "view source code") +`qiskit.opflow.evolutions.EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.md index 3956ded6da9..d29b785b726 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`qiskit.opflow.evolutions.EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`qiskit.opflow.evolutions.EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.md index 71ab6f0a888..225f258ba4c 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolved_op.py "view source code") +`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.md index 1118d4b84b0..7743193db2a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`qiskit.opflow.evolutions.MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`qiskit.opflow.evolutions.MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 03e2ca2237a..6ec804cdb0e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.md index f4f34e73122..25d50a36bb5 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`qiskit.opflow.evolutions.QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`qiskit.opflow.evolutions.QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.md index 0455dfa148c..a9ff53a8d8a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.md index 4618854927e..fc1691b7d66 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`qiskit.opflow.evolutions.Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`qiskit.opflow.evolutions.Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.md index 3bace41fcdc..f94676dbb3e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`qiskit.opflow.evolutions.TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`qiskit.opflow.evolutions.TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.md index a24e1c42d0c..01c71eb603e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`qiskit.opflow.evolutions.TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`qiskit.opflow.evolutions.TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.md index 877e57d23ac..96009eece03 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`qiskit.opflow.expectations.AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`qiskit.opflow.expectations.AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.md index 5866c737c1c..6b51440d070 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.md index 7a64d226431..57632541d9c 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`qiskit.opflow.expectations.ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/expectation_base.py "view source code") +`qiskit.opflow.expectations.ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.md index 84b23068105..9bf7af59d2e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`qiskit.opflow.expectations.ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/expectation_factory.py "view source code") +`qiskit.opflow.expectations.ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.md index 2c2b22ce630..36db25f3e8e 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`qiskit.opflow.expectations.MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`qiskit.opflow.expectations.MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.md index d1ba24ba1f2..f996c0b862d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.md index e5593c520b6..ae16528f18a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`qiskit.opflow.gradients.CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`qiskit.opflow.gradients.CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.md index de37ede6866..7585e332e3a 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`qiskit.opflow.gradients.CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`qiskit.opflow.gradients.CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.md index a6f7ff076f9..2e2cdfd8b25 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`qiskit.opflow.gradients.DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/derivative_base.py "view source code") +`qiskit.opflow.gradients.DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.md index 9c950f72434..a19539a8b21 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/gradient.py "view source code") +`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.md index 2260f64fc60..fa2fcdef0ef 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/gradient_base.py "view source code") +`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.md index 2704ebe5a34..3cb2e4bad44 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/hessian.py "view source code") +`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.md index 6115711186c..fc95948e775 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/hessian_base.py "view source code") +`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.md index a77f0dbcf98..7b87fba7197 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/natural_gradient.py "view source code") +`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.md index 434e6bb2c53..4744d6948f3 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/qfi.py "view source code") +`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.md index f0af5b6a5a9..c9566dade3d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/qfi_base.py "view source code") +`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.md index 07dd681fec4..6746792e6ec 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/composed_op.py "view source code") +`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.md index 6a65a0d285b..8d267872f6d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/list_op.py "view source code") +`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.md index 4bb226953ee..3a51e182388 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/summed_op.py "view source code") +`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.md index 5f28be96c59..8bbf85c1f7d 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/tensored_op.py "view source code") +`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.md index a518b7092bf..fbf8d4b5810 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.md index 5cd3a721f2e..f8a93c856fb 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.md index c933213dd05..f39e07c7bcc 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.md index 0f8e5c2a7fe..9a44d2adc50 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.md index 5e81821b8c2..8e74633c6ba 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index d53a4f7d5d2..ceb49f0ab99 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.md index f5ed7e783d0..c35d8ece6f4 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.md index 3e0b98e707a..706cf468c05 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.md index 25bda7a61c4..1cae55404a2 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.md index 5a8ce82cdf4..7b1bb9622f8 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.md index a6b9e73383b..8fe453cb282 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.md index 5e39db48fc1..5215555bb49 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.md index 8e055158a7e..8d1bd6721dc 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/state_fn.py "view source code") +`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.md index 1552f7f4c13..1899b9f9cb6 100644 --- a/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.45/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.md b/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.md index 51192d98c3d..abd2e381ab0 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.BaseController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BaseController -`qiskit.passmanager.BaseController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.BaseController(options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.md b/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.md index dcfc8e8557e..ef6cf2b2706 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.BasePassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BasePassManager -`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/passmanager.py "view source code") +`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/passmanager.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.md b/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.md index fb47a2473fe..489946ef64f 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.ConditionalController -`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.md b/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.md index d49a880b108..e5d839bad71 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.DoWhileController -`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.md b/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.md index 8d4c1504d14..763a6080351 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowController -`qiskit.passmanager.FlowController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowController(options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.md b/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.md index fa9fc62a6fc..3867791cc3b 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.FlowControllerLinear.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear -`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.md b/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.md index bd69b66f884..86748fdd2c0 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.GenericPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.GenericPass -`qiskit.passmanager.GenericPass`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.GenericPass` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.md b/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.md index fd43363e51b..29918dd3080 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.PassManagerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PassManagerState -`qiskit.passmanager.PassManagerState(workflow_status, property_set)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PassManagerState(workflow_status, property_set)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.md b/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.md index cd1bd99adaa..aaf61f6f36a 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PropertySet -`qiskit.passmanager.PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.md b/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.md index 986097f024d..01f3f4377f0 100644 --- a/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.md +++ b/docs/api/qiskit/0.45/qiskit.passmanager.WorkflowStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus -`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.md index 1d01649e1f0..c7253d4693c 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/backend_estimator.py "view source code") +`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/backend_estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.md index b8817a6b8ab..88e75f29e62 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/backend_sampler.py "view source code") +`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/backend_sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.md index 8691685cad6..3d7e598b6ba 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`qiskit.primitives.BaseEstimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/base_estimator.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.md index baf32b4a1d0..72084cbb2b4 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`qiskit.primitives.BaseSampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/base_sampler.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/0.45/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.45/qiskit.primitives.Estimator.md index cd198c5d9fc..de3dfb7da5f 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`qiskit.primitives.Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/estimator.py "view source code") +`qiskit.primitives.Estimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.md index 784b435ca28..f382064b8f2 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`qiskit.primitives.EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/estimator_result.py "view source code") +`qiskit.primitives.EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/estimator_result.py "view source code") Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/0.45/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.45/qiskit.primitives.Sampler.md index 3ba25821c99..53d62288f05 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`qiskit.primitives.Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/sampler.py "view source code") +`qiskit.primitives.Sampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.md index ac3ff6c983d..2293bc391d5 100644 --- a/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.45/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`qiskit.primitives.SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/sampler_result.py "view source code") +`qiskit.primitives.SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/sampler_result.py "view source code") Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/0.45/qiskit.providers.Backend.md b/docs/api/qiskit/0.45/qiskit.providers.Backend.md index 62359cd80b8..79f378999e0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.45/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`qiskit.providers.Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.45/qiskit.providers.BackendV1.md index 6b7c239eacd..c3ea0ba2c53 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.45/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`qiskit.providers.BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.45/qiskit.providers.BackendV2.md index 458f0180677..865652bac71 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.md index 45e6db95541..5280b4405ed 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.45/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend_compat.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.Job.md b/docs/api/qiskit/0.45/qiskit.providers.Job.md index b5b6378e5ce..d66baa386b6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.45/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`qiskit.providers.Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/job.py "view source code") +`qiskit.providers.Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/job.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.45/qiskit.providers.JobStatus.md index 7c24556c8ef..e34244b8d0c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.45/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`qiskit.providers.JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/jobstatus.py "view source code") +`qiskit.providers.JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/jobstatus.py "view source code") Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.JobV1.md b/docs/api/qiskit/0.45/qiskit.providers.JobV1.md index 1725d2f0fe2..7226ce27c6d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.45/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`qiskit.providers.JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/job.py "view source code") +`qiskit.providers.JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/job.py "view source code") Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.Options.md b/docs/api/qiskit/0.45/qiskit.providers.Options.md index 6d2487c5645..6efd3e4c054 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.45/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`qiskit.providers.Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/options.py "view source code") +`qiskit.providers.Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/options.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.Provider.md b/docs/api/qiskit/0.45/qiskit.providers.Provider.md index 2032d2ce22a..32b7fc81878 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.45/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`qiskit.providers.Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/provider.py "view source code") +`qiskit.providers.Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/provider.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.md index 3e5b2202af7..c4e165b8ec2 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.45/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`qiskit.providers.ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/provider.py "view source code") +`qiskit.providers.ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/provider.py "view source code") Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.md index cd9d488acb3..8ebd002e237 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.45/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.md index e0bdd44dadf..9af441af2db 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`qiskit.providers.basicaer.BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/exceptions.py "view source code") +`qiskit.providers.basicaer.BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.md index 21edef3c744..b6162180acf 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/basicaerjob.py "view source code") +`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.md index 32fe7dbc5e6..344fd6b346f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`qiskit.providers.basicaer.BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`qiskit.providers.basicaer.BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.md index 1dfc4a01e9e..78fdee2383f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 3c6f4ecfafc..57e3d6c3240 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.md index ea819ff0571..ac9f253153d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.45/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/0.45/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.45/qiskit.providers.convert_to_target.md index 10a10f82a93..17ec0c7cb36 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.45/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 7feb0cfea33..4726b42ba9d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.md index d0cb41658fa..3e21e595064 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`qiskit.providers.fake_provider.Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_1q.py "view source code") +`qiskit.providers.fake_provider.Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.md index ec5cee5cc61..78c89e1b453 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`qiskit.providers.fake_provider.FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.md index f0e46d75785..ebe8369074f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`qiskit.providers.fake_provider.FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.md index 074541754b8..d1b7651e12d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`qiskit.providers.fake_provider.FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.md index b72f097d0f0..ef82298323d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`qiskit.providers.fake_provider.FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.md index 051cdf2bca5..82c1731816d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`qiskit.providers.fake_provider.FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.md index eb463e89dcf..2834480d30a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`qiskit.providers.fake_provider.FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.md index 09676b0ad76..5e43ca38691 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`qiskit.providers.fake_provider.FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`qiskit.providers.fake_provider.FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.md index 893dca820c5..2763e70a3b6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.md index 68d06ee7836..eabd08998a4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`qiskit.providers.fake_provider.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.md index dca51076a46..af71ebda507 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`qiskit.providers.fake_provider.FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.md index 83ae063e28b..10d1c3eba7a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`qiskit.providers.fake_provider.FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.md index 9b285c460ec..717f7aa8bdc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`qiskit.providers.fake_provider.FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.md index e9dcb3cd1f1..8b0ef230709 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`qiskit.providers.fake_provider.FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.md index 51554739947..b9f2aeb78ed 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`qiskit.providers.fake_provider.FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.md index 2e553301009..f193e06e786 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`qiskit.providers.fake_provider.FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.md index 5bca91c7fcd..d34464e65f4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`qiskit.providers.fake_provider.FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.md index fe08f6fe6c2..74d51b39fad 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`qiskit.providers.fake_provider.FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.md index ebae3de7720..f4d0245c645 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`qiskit.providers.fake_provider.FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.md index d2ac10f8fc4..0ba0d8a82b4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`qiskit.providers.fake_provider.FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.md index adc0d2a71c6..e689871943b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`qiskit.providers.fake_provider.FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.md index 05dc8b7569a..0732b9bf49e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`qiskit.providers.fake_provider.FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.md index 8a515e0967c..116ccf8d5fb 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`qiskit.providers.fake_provider.FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.md index 051790bf9fe..9628d803db3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`qiskit.providers.fake_provider.FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.md index 712bd2ec8b6..3e5810abc34 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`qiskit.providers.fake_provider.FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.md index 14c6b460b40..856fb255f64 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`qiskit.providers.fake_provider.FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.md index 91bd0bd0116..8b6a5cd8650 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`qiskit.providers.fake_provider.FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.md index 6711d7b03f9..d8530e855b4 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`qiskit.providers.fake_provider.FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.md index a4d0b784111..90826719d38 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`qiskit.providers.fake_provider.FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`qiskit.providers.fake_provider.FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.md index 93659eb2237..fbe9ee4c23e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`qiskit.providers.fake_provider.FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.md index a8985135990..964a2de8e6b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`qiskit.providers.fake_provider.FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.md index 0cb629277aa..a533fd816bd 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`qiskit.providers.fake_provider.FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.md index ec9b3f87406..51bbb8ccf50 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`qiskit.providers.fake_provider.FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.md index 498d4ced79c..840b8fd4976 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`qiskit.providers.fake_provider.FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.md index cf99aac6e19..84f8b15a976 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`qiskit.providers.fake_provider.FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.md index 8202576b3de..e8c1bdfd23f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`qiskit.providers.fake_provider.FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.md index c54208c3839..36bf43b33c6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`qiskit.providers.fake_provider.FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.md index 18ae49759a5..3ebadb6e183 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`qiskit.providers.fake_provider.FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.md index 1e17f526532..59684476fe7 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`qiskit.providers.fake_provider.FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.md index d62cdbc2f24..446afd6268d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`qiskit.providers.fake_provider.FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.md index 7cb375a18e7..dff9f708166 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`qiskit.providers.fake_provider.FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.md index 4219d8cbe16..0ac65325da0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`qiskit.providers.fake_provider.FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.md index b312abdaa83..fde51b965da 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`qiskit.providers.fake_provider.FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.md index 328e5527fc8..cd2d7a7c20b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`qiskit.providers.fake_provider.FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.md index fe84c711980..34c1230b347 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`qiskit.providers.fake_provider.FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.md index 7423aaf37a9..e0a987212c2 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`qiskit.providers.fake_provider.FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.md index 946f45565c2..330cdc0ee23 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`qiskit.providers.fake_provider.FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.md index dfc950fb0b8..6c15a5bf910 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`qiskit.providers.fake_provider.FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.md index de33a912859..c2602a3bb3a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`qiskit.providers.fake_provider.FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.md index 392dc4dc901..2f416dd9c89 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`qiskit.providers.fake_provider.FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.md index 026997dfdb5..fd357c33e7b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`qiskit.providers.fake_provider.FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.md index 1115654c769..6569667fc68 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`qiskit.providers.fake_provider.FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.md index 571070bb2ac..a42c5f3698d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`qiskit.providers.fake_provider.FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.md index 608b591d751..42e9eb764b6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`qiskit.providers.fake_provider.FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index 1a3d51c3586..251fd85ff36 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`qiskit.providers.fake_provider.FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.md index 083b013be64..69e0a4116ea 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`qiskit.providers.fake_provider.FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.md index db921f147de..7db19693304 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`qiskit.providers.fake_provider.FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.md index 4ddff4406e4..5c51d6e10b1 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`qiskit.providers.fake_provider.FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 6571307a809..a32ea3b6657 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`qiskit.providers.fake_provider.FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index e42d7656859..34d066af720 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`qiskit.providers.fake_provider.FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.md index f85bcef48e2..908e9d7eaee 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`qiskit.providers.fake_provider.FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`qiskit.providers.fake_provider.FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.md index 441c8639628..7928db32093 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`qiskit.providers.fake_provider.FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.md index b7dbcea6c77..8b5dca207f9 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`qiskit.providers.fake_provider.FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.md index eb071f42525..84e2378a801 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`qiskit.providers.fake_provider.FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.md index feaf81d363c..bcb31efb33a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`qiskit.providers.fake_provider.FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.md index 7c2afea78b6..496e0b04b86 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`qiskit.providers.fake_provider.FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`qiskit.providers.fake_provider.FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.md index 7cc30a04efe..4f0a0f84513 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`qiskit.providers.fake_provider.FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 174063cbbd6..242cc88005e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`qiskit.providers.fake_provider.FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.md index 1a371a50cb6..bfffc9c9471 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`qiskit.providers.fake_provider.FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`qiskit.providers.fake_provider.FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.md index a1036d8e7e9..8d8c66862d1 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`qiskit.providers.fake_provider.FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index faab743e288..2cccbb19ec7 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`qiskit.providers.fake_provider.FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.md index 7d083dc6d68..e428cbad2d6 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`qiskit.providers.fake_provider.FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`qiskit.providers.fake_provider.FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.md index 0f3ba5ea4ab..2bc1f08c2be 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`qiskit.providers.fake_provider.FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.md index b580984e88c..55b68e8e198 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`qiskit.providers.fake_provider.FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.md index e69badac109..85e2cb8acb9 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`qiskit.providers.fake_provider.FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.md index a569e6a5cdc..75908eb4971 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`qiskit.providers.fake_provider.FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.md index 1d95443956b..4af59d5b720 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`qiskit.providers.fake_provider.FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.md index 1b259e43eba..d89d033359e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`qiskit.providers.fake_provider.FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.md index 6f8b982a527..1897bd6850e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`qiskit.providers.fake_provider.FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`qiskit.providers.fake_provider.FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.md index 78c7b013006..e6a69aeb76f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`qiskit.providers.fake_provider.FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.md index 6524d234b4a..0ae641af3d0 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`qiskit.providers.fake_provider.FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.md index 313be6aa2f8..25f9629b01c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`qiskit.providers.fake_provider.FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`qiskit.providers.fake_provider.FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.md index 117864edaa4..f0be4473574 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`qiskit.providers.fake_provider.FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.md index fa5cacb0503..7d88ba119df 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`qiskit.providers.fake_provider.FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.md index a6640f46f91..5b308a61b8b 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`qiskit.providers.fake_provider.FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.md index 79c7e87e504..97b62c10ff2 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`qiskit.providers.fake_provider.FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.md index e5c2e85880b..69195dd2fff 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`qiskit.providers.fake_provider.FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`qiskit.providers.fake_provider.FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.md index 7ac18b43227..34f351347ee 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`qiskit.providers.fake_provider.FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`qiskit.providers.fake_provider.FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.md index 1d5cc449e18..48e68711240 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`qiskit.providers.fake_provider.FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.md index d48c23a9f9f..e6cc730e284 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`qiskit.providers.fake_provider.FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.md index 2df03e6f131..7806f848397 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`qiskit.providers.fake_provider.FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.md index d36ebf498eb..f8a02b2d233 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`qiskit.providers.fake_provider.FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.md index 21de4a495df..dca579e27e7 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`qiskit.providers.fake_provider.FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.md index 388dfe997dc..0d7dd6deb7f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`qiskit.providers.fake_provider.FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.md index bbef8f54716..02a73239f99 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`qiskit.providers.fake_provider.FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.md index 1ca09b3ea8d..033ea91e47c 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`qiskit.providers.fake_provider.FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.md index 8974cbb710f..3b3cf21ff0d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`qiskit.providers.fake_provider.FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.md index 2f5c6d8e917..75218f12f6a 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.45/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`qiskit.providers.fake_provider.FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.md index aee46eb5927..49fcd4d8d0e 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.md index df444b03bc8..dc39bda3f43 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.md index dc14671bc95..be7250dede1 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendstatus.py "view source code") +`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.Command.md b/docs/api/qiskit/0.45/qiskit.providers.models.Command.md index 5f84446be45..aaf623ba620 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.md index cab9e0b38ce..079e1fbecf3 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.md b/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.md index 2bab76171f1..985ac84926d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.GateProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateProperties -`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.md index 8504dd913b8..659afd47c91 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/jobstatus.py "view source code") +`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/jobstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.md b/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.md index 854ca69e2cf..5240ce9fa5f 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.Nduv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Nduv -`qiskit.providers.models.Nduv(date, name, unit, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.Nduv(date, name, unit, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.md index 0d1b4d69991..60b8aab3272 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.md index f5107452ef8..5692bf4dafc 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.md index d97a6cabb37..438582b6b09 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.md index 31428649f9c..ad4d952420d 100644 --- a/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.45/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`qiskit.providers.models.UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.md index 123d06b7f48..d974056625a 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`qiskit.pulse.InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instruction_schedule_map.py "view source code") +`qiskit.pulse.InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.45/qiskit.pulse.Schedule.md index ce1250e1008..a99342abcd0 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.md index ad5f4e0b6de..a2c479867cf 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.md index 294e84a36a4..6dcc530fb30 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.md index 8d95ea0e19b..09477e8177c 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`qiskit.pulse.channels.ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.ControlChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.md index 920937fe3b5..781460c6089 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`qiskit.pulse.channels.DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.DriveChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.md index 8eb4bb86b74..a951ebf89b2 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.md index c1d32365dae..733b3894273 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`qiskit.pulse.channels.MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MemorySlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.md index 5da418c9ec1..06de5c207e2 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.md index 86a15e41b6e..17b32e63f1d 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.md index 91d22808942..025e8699fcb 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/acquire.py "view source code") +`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.md index ddd7662da31..9c1cd00d4f9 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/call.py "view source code") +`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/call.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.md index 47bd86f3602..2891e194e5e 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`qiskit.pulse.instructions.Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/delay.py "view source code") +`qiskit.pulse.instructions.Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/delay.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.md index 9f4d9865aad..4bb29f1153c 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`qiskit.pulse.instructions.Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/play.py "view source code") +`qiskit.pulse.instructions.Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/play.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.md index 796bb98a459..1d267c950ae 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`qiskit.pulse.instructions.Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/reference.py "view source code") +`qiskit.pulse.instructions.Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/reference.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.md index 800675d2a0c..3f8c9a8c598 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.md index 9205a3c9593..55031073006 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.md index f9a84acf06a..21185372f3c 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.md index a3ceeb93f98..fb475274433 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.md index d13dbb2a8fe..86b693768fa 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.md index 6beb5f574ce..34238ee3a93 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/snapshot.py "view source code") +`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.md index 288e410d494..77349766978 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.md index ba664f2bfb9..a4f91efd815 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Cos_class.rst.md index 393f33676b4..4c9ca60d446 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") A cosine pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.md index 3ecb7b47c98..aa01dc02d93 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianDeriv.md b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianDeriv.md index aebc1f81dae..aa11c1343d2 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianDeriv.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv -`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized Gaussian derivative pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.md index f764476250d..69f485df94c 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquareDrag.md index 6b3ae4c7951..810083d0bfc 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.md index 8a992a5e404..8307d356af9 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.md index 4eed5de5d68..f4698c5301a 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/parametric_pulses.py "view source code") +`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Sawtooth_class.rst.md index 9a0288b7693..e58009b4481 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") A sawtooth pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.SechDeriv.md b/docs/api/qiskit/0.45/qiskit.pulse.library.SechDeriv.md index d96ffc46e4f..e3d3571c2c4 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.SechDeriv.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.SechDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.SechDeriv -`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech derivative pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Sech_fun.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Sech_fun.rst.md index 318eff0d6a6..1b32b0cfa50 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Sech_fun.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Sech_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sech -`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Sin_class.rst.md index a51aede9f4c..710d6d61a33 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") A sinusoidal pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Square_fun.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Square_fun.rst.md index deda09d6cbf..a0e5296f0ea 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Square_fun.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Square_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Square -`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") A square wave pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.md index c149e6418a8..9b51810b12c 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Triangle_class.rst.md index 0f9ec9e4231..8f040fec38c 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") A triangle wave pulse. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.md index 2fe1f492cb7..fdc882e7b0f 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/waveform.py "view source code") +`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/waveform.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.45/qiskit.pulse.library.gaussian_square_echo.md b/docs/api/qiskit/0.45/qiskit.pulse.library.gaussian_square_echo.md index f52fd94f739..d7640dc5a2e 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.library.gaussian_square_echo.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.library.gaussian_square_echo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo -`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") An echoed Gaussian square pulse with an active tone overlaid on it. diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.md index 8d0f30b3fdf..a73486abdbc 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`qiskit.pulse.transforms.AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.md index e3d7acfd756..5ca5d4a3606 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`qiskit.pulse.transforms.AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.md index edf9dff5700..c49e3245a46 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`qiskit.pulse.transforms.AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.md index dc8344d1e4a..c39ce8e4850 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`qiskit.pulse.transforms.AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.md index d52a0969183..b68ce81e47e 100644 --- a/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.45/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`qiskit.pulse.transforms.AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.md index e7de1386443..d37531bc78f 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`qiskit.qobj.GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.md index f47d1dc890d..eb0658ee1d8 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`qiskit.qobj.PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.md index d7764420baf..fb50ebf6e24 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.md index 904a326e2ef..a26e8e1991f 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.md index ca9aec4c7dc..77bc20d7405 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.md index ae70efeff8f..406d1999e99 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.md index 57f5223e5a4..2bd79dd3210 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.md index 5962f3cacb7..d2542151323 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`qiskit.qobj.QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.md index 0292444098b..b057659ee53 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.md index e9d76062156..06476099908 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.md index fa16a4fb300..d8a50d7e6cc 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.md index 4479d4a19a7..9d3d684c6d4 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.md index 53ee4327425..26aacd32857 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.md index c6171989fcd..ace5d6bd1be 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`qiskit.qobj.QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/common.py "view source code") Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.md index e239fdf1836..5caed678713 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`qiskit.qobj.QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/common.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.md index a0a8811031b..4a823c79946 100644 --- a/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.45/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`qiskit.qobj.QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.md index dd14804ec99..9addb051d0f 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.md index 91d32f8321c..48b953dbff8 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/chi.py "view source code") +`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.md index 363008ca819..9f5c7bf4681 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/choi.py "view source code") +`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.md index 1e07e94e3db..b102eb41937 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`qiskit.quantum_info.Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`qiskit.quantum_info.Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.md index 7c833af38dc..a7830359f62 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`qiskit.quantum_info.DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/densitymatrix.py "view source code") +`qiskit.quantum_info.DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.md index c67358470ed..47b6e5d442d 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.md index 822a936e21a..7832345b837 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`qiskit.quantum_info.OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`qiskit.quantum_info.OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.md index 88ca8e42040..a10544f15a5 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/operator.py "view source code") +`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/operator.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.md index 3dcb5ff8a35..064fe4f83b8 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.md index 2f7d91e5fb7..7ed3e13c72d 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`qiskit.quantum_info.Pauli(data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`qiskit.quantum_info.Pauli(data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `BasePauli` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.md index 963d5440eb1..a96fe32d750 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`qiskit.quantum_info.PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`qiskit.quantum_info.PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `BasePauli`, `LinearMixin`, `GroupMixin` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.md index 840477e8169..6125b0db60b 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`qiskit.quantum_info.Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`qiskit.quantum_info.Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.md index c57a2a2e95f..318c435bfa4 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/scalar_op.py "view source code") +`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.md index c072867030b..ac69fd1fcae 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.md index 569a60619b1..83101fce6bf 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`qiskit.quantum_info.StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`qiskit.quantum_info.StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `QuantumState` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.md index f9591fda32f..f2ac8cbd42d 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`qiskit.quantum_info.Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/statevector.py "view source code") +`qiskit.quantum_info.Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/statevector.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.md index 92035c97218..b709934a9e0 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.md index c1fe079d9c4..c1705363a14 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/superop.py "view source code") +`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 1055f35b981..ac8382dc099 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`qiskit.quantum_info.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`qiskit.quantum_info.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.md index ca50078df1c..1b1d315ae2a 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`qiskit.quantum_info.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`qiskit.quantum_info.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.md index 55d69421e32..f3c9a53fe13 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.45/qiskit.quantum_info.pauli_basis.md index 37e4b061a60..9a135437d36 100644 --- a/docs/api/qiskit/0.45/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.45/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.md index d4181a2fb6d..56e50f2504b 100644 --- a/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.45/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`qiskit.result.BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`qiskit.result.BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.md index a901c387e7a..8bae8560b50 100644 --- a/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.45/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/0.45/qiskit.result.Counts.md b/docs/api/qiskit/0.45/qiskit.result.Counts.md index cbee1e5b798..f863e48153d 100644 --- a/docs/api/qiskit/0.45/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.45/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/counts.py "view source code") +`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/counts.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.md index 6f302ac6b64..aeaf172f9a1 100644 --- a/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.45/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.md index 929acfe4627..2f076194412 100644 --- a/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.45/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`qiskit.result.ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/distributions/probability.py "view source code") +`qiskit.result.ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/distributions/probability.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.md index 212b2774037..ad3d6b2cc71 100644 --- a/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.45/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/distributions/quasi.py "view source code") +`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/distributions/quasi.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.result.Result.md b/docs/api/qiskit/0.45/qiskit.result.Result.md index 645faf8b615..52de4a9b766 100644 --- a/docs/api/qiskit/0.45/qiskit.result.Result.md +++ b/docs/api/qiskit/0.45/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/result.py "view source code") +`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.result.ResultError.md b/docs/api/qiskit/0.45/qiskit.result.ResultError.md index 8b3c6acd330..b74fa08014f 100644 --- a/docs/api/qiskit/0.45/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.45/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`qiskit.result.ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/exceptions.py "view source code") +`qiskit.result.ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.md index 16e1272dc35..e8ec101490e 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`qiskit.synthesis.EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`qiskit.synthesis.EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.md index 68db0b40f1b..50ef39b9053 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.md index 27a627d5a20..3a18509b11a 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`qiskit.synthesis.MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`qiskit.synthesis.MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.md index 364747686b8..e2a40be946c 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/product_formula.py "view source code") +`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.md index 43d9aedf182..8c6d7986582 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/qdrift.py "view source code") +`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.md index ba3b1b4d75e..202fe86e7d3 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.md index b2edb9c7422..3c0ab1866b3 100644 --- a/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.45/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.md index eadff3baceb..95ebafd17e3 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`qiskit.transpiler.AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.md index 8fbf52777df..801b24f7bbb 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/coupling.py "view source code") +`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/coupling.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.md index 3955f484134..b1fd7cface7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.md index 81d6a218bc0..2bbe8eedf6a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`qiskit.transpiler.FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.md index f704bc6bacd..c38a28b4f8f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/instruction_durations.py "view source code") +`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/instruction_durations.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.md index 2510ec84c2a..c8ac97c3dfe 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/target.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.45/qiskit.transpiler.Layout.md index dd7a93c9f5c..be704307c0f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`qiskit.transpiler.Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.md index 6b76d1631e2..501ae095b78 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager.py "view source code") Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.md index 7ebbf671430..0e1d3d3213a 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager_config.py "view source code") +`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager_config.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.md index e51d02fbc3b..e1d4b9d3617 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager.py "view source code") Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.Target.md b/docs/api/qiskit/0.45/qiskit.transpiler.Target.md index efba322d4ea..40eb9cab31c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/target.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.md index c816ce69953..ddf9003a227 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`qiskit.transpiler.TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.md index 8bb078b4dac..152a2f5b443 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.md index 98575e60fea..20161ca0fa7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 2f3b31ff56b..4297322b3fe 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.md index b348f7fbbb7..d9c4eaf6801 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 6447e0ec5b1..85a60682bac 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.md index d438059488c..80c24739daf 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.md index d320ee6e8b6..6a9b1c23514 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 22cd1c709fe..8c1c7ca8d64 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.md index 67e8e6e0680..03cf4acdc09 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.md index 722ded54888..7a79ca54ff1 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.md index 063f1891b14..7624c033328 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.md index 0cf88adf3cf..a0b0ab7477c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.md index 1fbf535abf8..8ebff8159bb 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.md index f143891086f..b22eea4d2d8 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`qiskit.transpiler.passes.CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/check_map.py "view source code") +`qiskit.transpiler.passes.CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.md index cf789b0327b..e99c797f883 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.md index efecf531ec1..fe120f31869 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.md index 0203ca681d2..c7b16b9806f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.md index 0e700255c1a..c02cc84f7ec 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.md index 77d59cc6a6f..1db4fc8af00 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.md index 9578e3592ff..d8fee9d9f19 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.md index e191679bc41..4ac769f52bc 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 8691919d931..165a075df15 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.md index e1e4f055e76..aa1bc1d79b2 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.md index e11626fba25..c19446a5af9 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.md index 14e44a74b94..1d63cb9b6d0 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.md index 42af8403f38..5117da1f2cc 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 4c2957a3a7b..064f7c7030c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.md index 1ce0b210b6e..c8987f84318 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`qiskit.transpiler.passes.CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`qiskit.transpiler.passes.CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.md index 84faa921af8..586bdd04895 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 9b554814f00..ed730058c6b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.md index 4696b1134b3..98e4ef13094 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.md index 7158d789da8..ee1056b8909 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.md index 9534c1c41ce..c55b33c5e1f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`qiskit.transpiler.passes.Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/decompose.py "view source code") +`qiskit.transpiler.passes.Decompose(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.md index e7331be8064..e793293166b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.md index 9b4a84f4f96..0b4fd1fd6ea 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`qiskit.transpiler.passes.Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/depth.py "view source code") +`qiskit.transpiler.passes.Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.md index 699100d1080..16331315d1e 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 1cf0b315f87..fb3abedbcfa 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.md index 1e9efa7b3d5..6654cf0f3a2 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.md index 45a3a711636..a320bffaa2d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.md index d947e7c32d0..d1a5431eca2 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.md index 6259fd0c60b..fcdce5ca35f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`qiskit.transpiler.passes.GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`qiskit.transpiler.passes.GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.md index 5851a01a3c7..71c2006edb7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.md index 9c286af8d3b..ce6fdad4591 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.md index 3f683578018..ae4613a02fa 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.md index af2e2322b0f..263f37642ff 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.md index 49eaebe069f..608212b0372 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.md index bfbcaf73e2d..8a51da91d54 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index f1e7ba92ed1..4327af5d49b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 3e84894e1b2..045d7081b1c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.md index 0cc44469d27..6a3121b79e3 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 98829bb5d31..eaa4ea95078 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.md index e738f2e1228..4ab776a4850 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 1902e31af13..600cd188a4d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.md index a5542c190a3..b6ebf4ad90c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NormalizeRXAngle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle -`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") +`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.md index 8a387c663a8..fee081b1de1 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.md index 003f8b8da4f..80308e1bd02 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 6d4e217d452..29f94216119 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index b4df3c16caa..52e40cea18b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.md index 577cddd0f94..41987f16281 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.md index a174ad9b101..0a064052cc4 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`qiskit.transpiler.passes.PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`qiskit.transpiler.passes.PadDelay(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 60a856812e5..eddb8e5fc75 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.md index edac44d83eb..6242619bfed 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`qiskit.transpiler.passes.PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`qiskit.transpiler.passes.PulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.md index d0b3a48a5fc..caa55fcee2f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder -`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") +`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 588f5a341bd..19d77bcdc4d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 7388811512a..bb198f3b250 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.md index d67c199429c..7fd903c4977 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index b53c796eaab..113fb7df2ed 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.md index ada8ca68f8e..e888c8fe39b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.md index d4592707001..0806ce7b26d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 466d7a5a6cb..087e99f42fe 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.md index 4129bc5434e..c965385ae0c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.md index f3fb11cb26a..88fe215fc7f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabrePreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout -`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") +`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.md index 3fd0f38b697..9792c10effa 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.md index 415ce8ec0ca..d1914ffd273 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.md index 8d3e15b2db8..a2d5de01c09 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`qiskit.transpiler.passes.SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`qiskit.transpiler.passes.SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.md index 86de98b655f..fcd6ccca312 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`qiskit.transpiler.passes.Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/size.py "view source code") +`qiskit.transpiler.passes.Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.md index 90692815309..52b3ec415eb 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index 9ecb61a5af0..0a562394907 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`qiskit.transpiler.passes.SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.md index 2e534f94677..1ed08ac77ae 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.md index 67de417a750..693abdfbb65 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.md index 104d94ef30a..81e9351a3e5 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.md index 87b2e3a0e5e..dcf1fce7d81 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.md index f21b8537a36..764369a21cc 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.md index 70f870c0e19..188ce5f88cd 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.md index 175c4550d0b..e592274f3cd 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 6d66e39858a..75abc711224 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.md index 50801ebe0ca..cdd7a631d8c 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.md index 1aa56be9666..16af44edf81 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`qiskit.transpiler.passes.Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroller.py "view source code") +`qiskit.transpiler.passes.Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.md index 0ae039a6e7c..3c630296248 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.md index 293c33c0cb7..d41400d4036 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md index 1e4e1c789a5..2f6b8f3550b 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.md index ef8d06a9df3..1d198bfcd50 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`qiskit.transpiler.passes.Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/width.py "view source code") +`qiskit.transpiler.passes.Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 32d0beb833c..a92eeeab8ce 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index 4a61d2aeb0c..9df74031865 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index d7e59f6c52e..f7f58999bc3 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index bbbdf419a48..6b4f30948f7 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index ab2c85c4047..b0b5d533606 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 5d851b2df1c..0689df6e16d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index da676f4458e..4d55815cc4d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.md index dadcc1891e6..ee9b02d56da 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`qiskit.transpiler.synthesis.aqc.AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`qiskit.transpiler.synthesis.aqc.AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 7e56c138be8..1cf39071a30 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index eddf9758f71..ae4c1600bba 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`qiskit.transpiler.synthesis.aqc.ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`qiskit.transpiler.synthesis.aqc.ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 71ba4c7285c..49f124db07f 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`qiskit.transpiler.synthesis.aqc.ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`qiskit.transpiler.synthesis.aqc.ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index ca3edb203c4..6c07fba9ac8 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index ecc72d0969f..d72f0ccacf4 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`qiskit.transpiler.synthesis.aqc.CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 61decbe1cb4..bce5022f06d 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index f035b48f47b..2547871ceb8 100644 --- a/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.md index 6fa86d4b236..c71ef3fd2b9 100644 --- a/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.45/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/quantum_instance.py "view source code") +`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/quantum_instance.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.md index bef75b9f59d..0159b222f30 100644 --- a/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.45/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/mitigation/fitters.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.md index d9808684915..392a55e013c 100644 --- a/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.45/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/mitigation/fitters.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.45/qiskit.visualization.array_to_latex.md index d20b3720d01..f879342bba5 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/array.py "view source code") +`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.45/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.45/qiskit.visualization.circuit_drawer.md index 1d02b085bbc..57a126fea01 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.45/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.45/qiskit.visualization.dag_drawer.md index 28c79374ee3..4bb607de548 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/dag_visualization.py "view source code") +`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.45/qiskit.visualization.pass_manager_drawer.md index efe74b8f3d6..e91293c4d2e 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pass_manager_visualization.py "view source code") +`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_multivector.md index a9c0f6bd9a7..a0548e3b387 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_vector.md index 94e7c263428..7efc6ec6250 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_circuit_layout.md index d6ff5eda927..df67d36035a 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_coupling_map.md index 6e009da1c66..9bc654f9001 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_distribution.md index 721e110760d..3950b2cefdf 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_error_map.md index 6241c471b39..ebe71921861 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_gate_map.md index 6bded14cee1..5b3a307db7d 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_histogram.md index 624630566aa..d54780989b6 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_city.md index abb9876affb..961d4406fe6 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_hinton.md index e5fc9681ce0..0ddd790af62 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_paulivec.md index 64301db0c72..5054eeaafdc 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") Plot the Pauli-vector representation of a quantum state as bar graph. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_qsphere.md index b8b44b4b857..c63d096c5bc 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.md index 52703719c90..016d0f76f9e 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`qiskit.visualization.pulse.IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.md index 9dfe01b6c89..ee6c0cd99b2 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`qiskit.visualization.pulse.IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.md index 44fe10a690c..d2487c710b8 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`qiskit.visualization.pulse.IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.md index e8b1d4b47e0..d0f827b4481 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`qiskit.visualization.qcstyle.DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/circuit/qcstyle.py "view source code") +`qiskit.visualization.qcstyle.DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.45/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.45/qiskit.visualization.visualize_transition.md index 4e1d038eac0..912c5a383c4 100644 --- a/docs/api/qiskit/0.45/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.45/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/transition_visualization.py "view source code") +`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.45/qpy.md b/docs/api/qiskit/0.45/qpy.md index c06e485872d..926a6ff78ee 100644 --- a/docs/api/qiskit/0.45/qpy.md +++ b/docs/api/qiskit/0.45/qpy.md @@ -59,7 +59,7 @@ and then loading that file will return a list with all the circuits -`qiskit.qpy.load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/interface.py "view source code") Load a QPY binary file @@ -106,7 +106,7 @@ The list of Qiskit programs contained in the QPY data. A list is always returned -`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file @@ -160,7 +160,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski -`qiskit.qpy.QpyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QpyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/exceptions.py "view source code") Errors raised by the qpy module. diff --git a/docs/api/qiskit/0.45/quantum_info.md b/docs/api/qiskit/0.45/quantum_info.md index 82f79e780db..e1c37cda545 100644 --- a/docs/api/qiskit/0.45/quantum_info.md +++ b/docs/api/qiskit/0.45/quantum_info.md @@ -60,7 +60,7 @@ python_api_name: qiskit.quantum_info -`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. @@ -102,7 +102,7 @@ The average gate fidelity $F_{\text{ave}}$. -`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. @@ -151,7 +151,7 @@ The process fidelity $F_{\text{pro}}$. -`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. @@ -188,7 +188,7 @@ The average gate error $E$. -`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. @@ -228,7 +228,7 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar -`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. @@ -264,7 +264,7 @@ The state fidelity $F(\rho_1, \rho_2)$. -`qiskit.quantum_info.purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. @@ -295,7 +295,7 @@ the purity $Tr[\rho^2]$. -`qiskit.quantum_info.concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. @@ -337,7 +337,7 @@ The concurrence. -`qiskit.quantum_info.entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. @@ -368,7 +368,7 @@ The von-Neumann entropy S(rho). -`qiskit.quantum_info.entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. @@ -396,7 +396,7 @@ The entanglement of formation. -`qiskit.quantum_info.mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. @@ -432,7 +432,7 @@ The mutual information $I(\rho_{AB})$. -`qiskit.quantum_info.partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. @@ -459,7 +459,7 @@ The reduced density matrix. -`qiskit.quantum_info.schmidt_decomposition(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.schmidt_decomposition(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") Return the Schmidt Decomposition of a pure quantum state. @@ -509,7 +509,7 @@ list of tuples `(s, u, v)`, where `s` (float) are the Schmidt coefficients $\lam -`qiskit.quantum_info.shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. @@ -538,7 +538,7 @@ The Shannon entropy H(pvec). -`qiskit.quantum_info.commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`qiskit.quantum_info.commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/commutator.py "view source code") Compute commutator of a and b. @@ -563,7 +563,7 @@ The commutator -`qiskit.quantum_info.anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`qiskit.quantum_info.anti_commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") Compute anti-commutator of a and b. @@ -588,7 +588,7 @@ The anti-commutator -`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") Compute symmetric double commutator of a, b and c. @@ -637,7 +637,7 @@ Methods of Molecular Quantum Mechanics. 2nd Edition, Academic Press, 1992. ISBN -`qiskit.quantum_info.random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. @@ -664,7 +664,7 @@ K. Zyczkowski and H. Sommers (2001), “Induced measures in the space of mixed q -`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. @@ -691,7 +691,7 @@ the random density matrix. -`qiskit.quantum_info.random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. @@ -714,7 +714,7 @@ a unitary operator. -`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. @@ -738,7 +738,7 @@ a Hermitian operator. -`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. @@ -760,7 +760,7 @@ a random Pauli -`qiskit.quantum_info.random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. @@ -787,7 +787,7 @@ a random Clifford operator. -`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. @@ -816,7 +816,7 @@ a quantum channel operator. -`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. @@ -837,7 +837,7 @@ a random CNOTDihedral element. -`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. @@ -862,7 +862,7 @@ a random PauliList. -`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. @@ -887,7 +887,7 @@ Distance -`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. @@ -960,7 +960,7 @@ hellinger_fidelity(res1.get_counts(), res2.get_counts()) -`qiskit.quantum_info.decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`qiskit.quantum_info.decompose_clifford(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.45/result.md b/docs/api/qiskit/0.45/result.md index e400af7e09f..54ab4873715 100644 --- a/docs/api/qiskit/0.45/result.md +++ b/docs/api/qiskit/0.45/result.md @@ -28,7 +28,7 @@ python_api_name: qiskit.result -`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -58,7 +58,7 @@ the observed counts, marginalized to only account for frequency of observations -`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -87,7 +87,7 @@ A marginalized dictionary -`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") Marginalize shot memory @@ -127,7 +127,7 @@ marginal\_memory -`qiskit.result.sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/sampled_expval.py "view source code") +`qiskit.result.sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.45/scheduler.md b/docs/api/qiskit/0.45/scheduler.md index 3cab339ba4a..9af5c48c84c 100644 --- a/docs/api/qiskit/0.45/scheduler.md +++ b/docs/api/qiskit/0.45/scheduler.md @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. -`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/config.py "view source code") +`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. @@ -38,7 +38,7 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched -`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/schedule_circuit.py "view source code") +`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. @@ -74,7 +74,7 @@ Pulse scheduling methods. -`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -98,7 +98,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. diff --git a/docs/api/qiskit/0.45/synthesis.md b/docs/api/qiskit/0.45/synthesis.md index da051539689..1282bf2ac10 100644 --- a/docs/api/qiskit/0.45/synthesis.md +++ b/docs/api/qiskit/0.45/synthesis.md @@ -37,7 +37,7 @@ python_api_name: qiskit.synthesis -`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear/cnot_synth.py "view source code") +`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear/cnot_synth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. @@ -68,7 +68,7 @@ a CX-only circuit implementing the linear transformation. -`qiskit.synthesis.synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. @@ -100,7 +100,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cz_depth_line_mr(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. @@ -126,7 +126,7 @@ a circuit implementation of the CZ circuit of depth 2\*n+2 for LNN connectivity. -`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") Joint synthesis of a -CZ-CX- circuit for linear nearest neighbour (LNN) connectivity, with 2-qubit depth at most 5n, based on Maslov and Yang. This method computes the CZ circuit inside the CX circuit via phase gate insertions. @@ -154,7 +154,7 @@ a circuit implementation of a CX circuit following a CZ circuit, denoted as a -C -`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. @@ -176,7 +176,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. @@ -198,7 +198,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. @@ -224,7 +224,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`qiskit.synthesis.synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. @@ -253,7 +253,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`qiskit.synthesis.synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. @@ -277,7 +277,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`qiskit.synthesis.synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. @@ -305,7 +305,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`qiskit.synthesis.synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. @@ -335,7 +335,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov. @@ -382,7 +382,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_depth_lnn(cliff)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers for linear-nearest neighbour connectivity. @@ -412,7 +412,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. @@ -437,7 +437,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. @@ -465,7 +465,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. @@ -497,7 +497,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of a stabilizer state into layers. @@ -546,7 +546,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth 2\*n+2 and two distinct CX layers, using CX and phase gates (S, Sdg or Z). @@ -577,7 +577,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/0.45/synthesis_aqc.md b/docs/api/qiskit/0.45/synthesis_aqc.md index 450ea9ad79b..553bca76aa9 100644 --- a/docs/api/qiskit/0.45/synthesis_aqc.md +++ b/docs/api/qiskit/0.45/synthesis_aqc.md @@ -130,7 +130,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`qiskit.transpiler.synthesis.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`qiskit.transpiler.synthesis.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.45/tools.md b/docs/api/qiskit/0.45/tools.md index d2e32ede663..ac8d4222311 100644 --- a/docs/api/qiskit/0.45/tools.md +++ b/docs/api/qiskit/0.45/tools.md @@ -24,7 +24,7 @@ A helper function for calling a custom function with python `ProcessPoolExecutor -`qiskit.tools.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/parallel.py "view source code") +`qiskit.tools.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -81,7 +81,7 @@ A helper module to get IBM backend information and submitted job status. -`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/job_monitor.py "view source code") +`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. @@ -115,7 +115,7 @@ job_monitor(job_sim) -`qiskit.tools.backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. @@ -136,7 +136,7 @@ Examples: .. code-block:: python -`qiskit.tools.backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. @@ -159,7 +159,7 @@ A helper component for publishing and subscribing to events. -`qiskit.tools.events.TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/events/progressbar.py "view source code") +`qiskit.tools.events.TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/events/progressbar.py "view source code") A simple text-based progress bar. diff --git a/docs/api/qiskit/0.45/transpiler.md b/docs/api/qiskit/0.45/transpiler.md index d790c331d1a..73c340f99ab 100644 --- a/docs/api/qiskit/0.45/transpiler.md +++ b/docs/api/qiskit/0.45/transpiler.md @@ -942,7 +942,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor -`qiskit.transpiler.TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. @@ -952,7 +952,7 @@ Set the error message. -`qiskit.transpiler.TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. @@ -962,7 +962,7 @@ Set the error message. -`qiskit.transpiler.CouplingError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CouplingError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") Base class for errors raised by the coupling graph object. @@ -972,7 +972,7 @@ Set the error message. -`qiskit.transpiler.LayoutError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.LayoutError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") Errors raised by the layout object. diff --git a/docs/api/qiskit/0.45/transpiler_plugins.md b/docs/api/qiskit/0.45/transpiler_plugins.md index a13a33dde18..f213376671f 100644 --- a/docs/api/qiskit/0.45/transpiler_plugins.md +++ b/docs/api/qiskit/0.45/transpiler_plugins.md @@ -101,7 +101,7 @@ Note that the entry point `name = path` is a single string not a Python expressi -`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. @@ -125,7 +125,7 @@ plugins -`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/0.45/transpiler_preset.md b/docs/api/qiskit/0.45/transpiler_preset.md index 8b1e074653a..2ebfc6012f5 100644 --- a/docs/api/qiskit/0.45/transpiler_preset.md +++ b/docs/api/qiskit/0.45/transpiler_preset.md @@ -28,7 +28,7 @@ This module contains functions for generating the preset pass managers for the t -`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -101,7 +101,7 @@ The preset pass manager for the given options -`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -129,7 +129,7 @@ a level 0 pass manager. -`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -155,7 +155,7 @@ a level 1 pass manager. -`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. @@ -183,7 +183,7 @@ a level 2 pass manager. -`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. @@ -215,7 +215,7 @@ a level 3 pass manager. -`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. @@ -231,7 +231,7 @@ a pass manager that populates the `contains_x` properties for each of the contro -`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. @@ -239,7 +239,7 @@ Get a pass manager that always raises an error if control flow is present in a g -`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -264,7 +264,7 @@ The unroll 3q or more pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -288,7 +288,7 @@ set has been set in earlier stages -`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -316,7 +316,7 @@ The routing pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -340,7 +340,7 @@ The pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -372,7 +372,7 @@ The basis translation pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.45/utils.md b/docs/api/qiskit/0.45/utils.md index 7b6f958032c..a4ecb7eed66 100644 --- a/docs/api/qiskit/0.45/utils.md +++ b/docs/api/qiskit/0.45/utils.md @@ -22,7 +22,7 @@ python_api_name: qiskit.utils -`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") Dynamically insert the deprecation message into `func`’s docstring. @@ -37,7 +37,7 @@ Dynamically insert the deprecation message into `func`’s docstring. -`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") Decorator to indicate an argument has been deprecated in some way. @@ -67,7 +67,7 @@ Callable -`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_arg. @@ -89,7 +89,7 @@ Callable -`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") Decorator to indicate a function has been deprecated. @@ -118,7 +118,7 @@ Callable -`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_func. @@ -141,7 +141,7 @@ Callable -`qiskit.utils.local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. @@ -159,7 +159,7 @@ The hardware information. -`qiskit.utils.is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one @@ -167,7 +167,7 @@ Checks whether the current process is the main one -`qiskit.utils.apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/units.py "view source code") +`qiskit.utils.apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. @@ -200,7 +200,7 @@ Converted value. -`qiskit.utils.detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/units.py "view source code") +`qiskit.utils.detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. @@ -244,7 +244,7 @@ A tuple of scaled value and prefix. -`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/classtools.py "view source code") +`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. @@ -269,7 +269,7 @@ If either `before` or `after` are given, they should be callables with a compati -`qiskit.utils.summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/circuit_utils.py "view source code") +`qiskit.utils.summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/circuit_utils.py "view source code") **Summarize circuits based on QuantumCircuit, and five metrics are summarized.** @@ -297,7 +297,7 @@ a formatted string records the summary -`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. @@ -323,7 +323,7 @@ A map of qubit index to an array of indexes to which this should be entangled -`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. @@ -351,7 +351,7 @@ Validated/converted map -`qiskit.utils.has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed. @@ -363,7 +363,7 @@ Check if IBMQ is installed. -`qiskit.utils.has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/backend_utils.py "view source code") Check if Aer is installed. @@ -375,7 +375,7 @@ Check if Aer is installed. -`qiskit.utils.name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/name_unnamed_args.py "view source code") +`qiskit.utils.name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. @@ -482,7 +482,7 @@ from qiskit.utils import LazyImportTester -`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -603,7 +603,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -617,7 +617,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. diff --git a/docs/api/qiskit/0.45/visualization.md b/docs/api/qiskit/0.45/visualization.md index a117b86b94d..001ad05cde2 100644 --- a/docs/api/qiskit/0.45/visualization.md +++ b/docs/api/qiskit/0.45/visualization.md @@ -237,7 +237,7 @@ You can find code examples for each visualization functions on the individual fu -`qiskit.visualization.VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/exceptions.py "view source code") +`qiskit.visualization.VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. From b46d5f8f743c974e83845de4fc5871656934affa Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:02:26 +0100 Subject: [PATCH 26/41] Regenerate qiskit 0.46.0 --- docs/api/qiskit/0.46/algorithms.md | 6 +- docs/api/qiskit/0.46/assembler.md | 6 +- docs/api/qiskit/0.46/circuit.md | 4 +- docs/api/qiskit/0.46/circuit_classical.md | 66 ++++---- docs/api/qiskit/0.46/circuit_library.md | 142 +++++++++--------- docs/api/qiskit/0.46/circuit_singleton.md | 6 +- docs/api/qiskit/0.46/compiler.md | 8 +- docs/api/qiskit/0.46/converters.md | 18 +-- docs/api/qiskit/0.46/dagcircuit.md | 4 +- docs/api/qiskit/0.46/exceptions.md | 8 +- docs/api/qiskit/0.46/execute.md | 2 +- docs/api/qiskit/0.46/extensions.md | 2 +- docs/api/qiskit/0.46/opflow.md | 8 +- docs/api/qiskit/0.46/passmanager.md | 2 +- docs/api/qiskit/0.46/providers.md | 10 +- .../qiskit/0.46/providers_fake_provider.md | 8 +- docs/api/qiskit/0.46/pulse.md | 134 ++++++++--------- docs/api/qiskit/0.46/qasm.md | 8 +- docs/api/qiskit/0.46/qasm2.md | 16 +- docs/api/qiskit/0.46/qasm3.md | 16 +- .../0.46/qiskit.algorithms.AlgorithmJob.md | 2 +- .../qiskit.algorithms.AmplificationProblem.md | 2 +- .../qiskit.algorithms.AmplitudeAmplifier.md | 2 +- .../qiskit.algorithms.AmplitudeEstimation.md | 2 +- ...it.algorithms.AmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.AmplitudeEstimator.md | 2 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 2 +- .../0.46/qiskit.algorithms.Eigensolver.md | 2 +- .../qiskit.algorithms.EigensolverResult.md | 2 +- .../qiskit.algorithms.EstimationProblem.md | 2 +- .../qiskit.algorithms.EvolutionProblem.md | 2 +- .../0.46/qiskit.algorithms.EvolutionResult.md | 2 +- ...it.algorithms.FasterAmplitudeEstimation.md | 2 +- ...orithms.FasterAmplitudeEstimationResult.md | 2 +- .../qiskit/0.46/qiskit.algorithms.Grover.md | 2 +- .../0.46/qiskit.algorithms.GroverResult.md | 2 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 2 +- ...rithms.HamiltonianPhaseEstimationResult.md | 2 +- .../qiskit.algorithms.ImaginaryEvolver.md | 2 +- .../qiskit.algorithms.ImaginaryTimeEvolver.md | 2 +- ...algorithms.IterativeAmplitudeEstimation.md | 2 +- ...thms.IterativeAmplitudeEstimationResult.md | 2 +- ...kit.algorithms.IterativePhaseEstimation.md | 2 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 2 +- ...imumLikelihoodAmplitudeEstimationResult.md | 2 +- .../qiskit.algorithms.MinimumEigensolver.md | 2 +- ...kit.algorithms.MinimumEigensolverResult.md | 2 +- .../qiskit.algorithms.NumPyEigensolver.md | 2 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 2 +- .../api/qiskit/0.46/qiskit.algorithms.PVQD.md | 2 +- .../0.46/qiskit.algorithms.PVQDResult.md | 2 +- .../0.46/qiskit.algorithms.PhaseEstimation.md | 2 +- ...qiskit.algorithms.PhaseEstimationResult.md | 2 +- .../qiskit.algorithms.PhaseEstimationScale.md | 2 +- .../api/qiskit/0.46/qiskit.algorithms.QAOA.md | 2 +- .../0.46/qiskit.algorithms.RealEvolver.md | 2 +- .../0.46/qiskit.algorithms.RealTimeEvolver.md | 2 +- ...qiskit.algorithms.SciPyImaginaryEvolver.md | 2 +- .../qiskit.algorithms.SciPyRealEvolver.md | 2 +- .../qiskit.algorithms.TimeEvolutionProblem.md | 2 +- .../qiskit.algorithms.TimeEvolutionResult.md | 2 +- .../0.46/qiskit.algorithms.TrotterQRTE.md | 2 +- docs/api/qiskit/0.46/qiskit.algorithms.VQD.md | 2 +- .../0.46/qiskit.algorithms.VQDResult.md | 2 +- docs/api/qiskit/0.46/qiskit.algorithms.VQE.md | 2 +- .../qiskit/0.46/qiskit.algorithms.VarQITE.md | 2 +- .../qiskit/0.46/qiskit.algorithms.VarQRTE.md | 2 +- ...kit.algorithms.eigensolvers.Eigensolver.md | 2 +- ...gorithms.eigensolvers.EigensolverResult.md | 2 +- ...lgorithms.eigensolvers.NumPyEigensolver.md | 2 +- ...hms.eigensolvers.NumPyEigensolverResult.md | 2 +- .../qiskit.algorithms.eigensolvers.VQD.md | 2 +- ...iskit.algorithms.eigensolvers.VQDResult.md | 2 +- ...orithms.gradients.BaseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.BaseQGT.md | 2 +- ...lgorithms.gradients.BaseSamplerGradient.md | 2 +- ...ithms.gradients.EstimatorGradientResult.md | 2 +- ...s.gradients.FiniteDiffEstimatorGradient.md | 2 +- ...hms.gradients.FiniteDiffSamplerGradient.md | 2 +- ...thms.gradients.LinCombEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.LinCombQGT.md | 2 +- ...rithms.gradients.LinCombSamplerGradient.md | 2 +- ...s.gradients.ParamShiftEstimatorGradient.md | 2 +- ...hms.gradients.ParamShiftSamplerGradient.md | 2 +- .../0.46/qiskit.algorithms.gradients.QFI.md | 2 +- .../qiskit.algorithms.gradients.QFIResult.md | 2 +- .../qiskit.algorithms.gradients.QGTResult.md | 2 +- ...thms.gradients.ReverseEstimatorGradient.md | 2 +- .../qiskit.algorithms.gradients.ReverseQGT.md | 2 +- ...orithms.gradients.SPSAEstimatorGradient.md | 2 +- ...lgorithms.gradients.SPSASamplerGradient.md | 2 +- ...orithms.gradients.SamplerGradientResult.md | 2 +- ...lgorithms.minimum_eigensolvers.AdaptVQE.md | 2 +- ...hms.minimum_eigensolvers.AdaptVQEResult.md | 2 +- ...minimum_eigensolvers.MinimumEigensolver.md | 2 +- ...m_eigensolvers.MinimumEigensolverResult.md | 2 +- ...um_eigensolvers.NumPyMinimumEigensolver.md | 2 +- ...ensolvers.NumPyMinimumEigensolverResult.md | 2 +- ...it.algorithms.minimum_eigensolvers.QAOA.md | 2 +- ...eigensolvers.SamplingMinimumEigensolver.md | 2 +- ...olvers.SamplingMinimumEigensolverResult.md | 2 +- ...rithms.minimum_eigensolvers.SamplingVQE.md | 2 +- ....minimum_eigensolvers.SamplingVQEResult.md | 2 +- ...kit.algorithms.minimum_eigensolvers.VQE.md | 2 +- ...gorithms.minimum_eigensolvers.VQEResult.md | 2 +- .../0.46/qiskit.algorithms.optimizers.ADAM.md | 2 +- .../0.46/qiskit.algorithms.optimizers.AQGD.md | 2 +- .../qiskit.algorithms.optimizers.AskData.md | 2 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 2 +- .../0.46/qiskit.algorithms.optimizers.CG.md | 2 +- .../qiskit.algorithms.optimizers.COBYLA.md | 2 +- .../0.46/qiskit.algorithms.optimizers.CRS.md | 2 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 2 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 2 +- .../0.46/qiskit.algorithms.optimizers.ESCH.md | 2 +- .../0.46/qiskit.algorithms.optimizers.GSLS.md | 2 +- ...t.algorithms.optimizers.GradientDescent.md | 2 +- ...orithms.optimizers.GradientDescentState.md | 2 +- .../qiskit.algorithms.optimizers.IMFIL.md | 2 +- .../qiskit.algorithms.optimizers.ISRES.md | 2 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 2 +- .../qiskit.algorithms.optimizers.Minimizer.md | 2 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 2 +- .../0.46/qiskit.algorithms.optimizers.NFT.md | 2 +- .../qiskit.algorithms.optimizers.Optimizer.md | 2 +- ...t.algorithms.optimizers.OptimizerResult.md | 2 +- ...it.algorithms.optimizers.OptimizerState.md | 2 +- ...rithms.optimizers.OptimizerSupportLevel.md | 2 +- .../qiskit.algorithms.optimizers.POWELL.md | 2 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 2 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 2 +- .../qiskit.algorithms.optimizers.SLSQP.md | 2 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 2 +- .../0.46/qiskit.algorithms.optimizers.SPSA.md | 2 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 2 +- ...lgorithms.optimizers.SteppableOptimizer.md | 2 +- .../0.46/qiskit.algorithms.optimizers.TNC.md | 2 +- .../qiskit.algorithms.optimizers.TellData.md | 2 +- .../0.46/qiskit.algorithms.optimizers.UMDA.md | 2 +- ...optimizers.optimizer_utils.LearningRate.md | 2 +- ...thms.state_fidelities.BaseStateFidelity.md | 2 +- ...ithms.state_fidelities.ComputeUncompute.md | 2 +- ...ms.state_fidelities.StateFidelityResult.md | 2 +- ...ime_evolvers.trotterization.TrotterQRTE.md | 2 +- ...evolvers.variational.ForwardEulerSolver.md | 2 +- ...variational.ImaginaryMcLachlanPrinciple.md | 2 +- ...riational.ImaginaryVariationalPrinciple.md | 2 +- ...vers.variational.RealMcLachlanPrinciple.md | 2 +- ...rs.variational.RealVariationalPrinciple.md | 2 +- ...olvers.variational.VariationalPrinciple.md | 2 +- .../qiskit/0.46/qiskit.assembler.RunConfig.md | 2 +- .../0.46/qiskit.circuit.AncillaQubit.md | 2 +- .../0.46/qiskit.circuit.AncillaRegister.md | 2 +- .../0.46/qiskit.circuit.AnnotatedOperation.md | 2 +- docs/api/qiskit/0.46/qiskit.circuit.Bit.md | 2 +- .../qiskit/0.46/qiskit.circuit.BreakLoopOp.md | 2 +- .../0.46/qiskit.circuit.CircuitInstruction.md | 2 +- .../0.46/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/0.46/qiskit.circuit.Clbit.md | 2 +- .../0.46/qiskit.circuit.CommutationChecker.md | 2 +- .../0.46/qiskit.circuit.ContinueLoopOp.md | 2 +- .../0.46/qiskit.circuit.ControlFlowOp.md | 2 +- .../0.46/qiskit.circuit.ControlModifier.md | 2 +- .../0.46/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/0.46/qiskit.circuit.Delay.md | 2 +- .../0.46/qiskit.circuit.EquivalenceLibrary.md | 2 +- .../qiskit/0.46/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/0.46/qiskit.circuit.Gate.md | 2 +- .../qiskit/0.46/qiskit.circuit.IfElseOp.md | 2 +- .../qiskit/0.46/qiskit.circuit.Instruction.md | 2 +- .../0.46/qiskit.circuit.InstructionSet.md | 2 +- .../0.46/qiskit.circuit.InverseModifier.md | 2 +- .../qiskit/0.46/qiskit.circuit.Operation.md | 2 +- .../qiskit/0.46/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../0.46/qiskit.circuit.ParameterVector.md | 2 +- .../0.46/qiskit.circuit.PowerModifier.md | 2 +- .../0.46/qiskit.circuit.QuantumCircuit.md | 2 +- .../0.46/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/0.46/qiskit.circuit.Qubit.md | 2 +- .../qiskit/0.46/qiskit.circuit.Register.md | 2 +- .../0.46/qiskit.circuit.SwitchCaseOp.md | 2 +- .../qiskit/0.46/qiskit.circuit.WhileLoopOp.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.AND.md | 2 +- .../0.46/qiskit.circuit.library.Barrier.md | 2 +- .../0.46/qiskit.circuit.library.C3SXGate.md | 2 +- .../0.46/qiskit.circuit.library.C3XGate.md | 2 +- .../0.46/qiskit.circuit.library.C4XGate.md | 2 +- .../0.46/qiskit.circuit.library.CCXGate.md | 2 +- .../0.46/qiskit.circuit.library.CCZGate.md | 2 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../0.46/qiskit.circuit.library.CHGate.md | 2 +- .../0.46/qiskit.circuit.library.CPhaseGate.md | 2 +- .../0.46/qiskit.circuit.library.CRXGate.md | 2 +- .../0.46/qiskit.circuit.library.CRYGate.md | 2 +- .../0.46/qiskit.circuit.library.CRZGate.md | 2 +- .../0.46/qiskit.circuit.library.CSGate.md | 2 +- .../0.46/qiskit.circuit.library.CSXGate.md | 2 +- .../0.46/qiskit.circuit.library.CSdgGate.md | 2 +- .../0.46/qiskit.circuit.library.CSwapGate.md | 2 +- .../0.46/qiskit.circuit.library.CU1Gate.md | 2 +- .../0.46/qiskit.circuit.library.CU3Gate.md | 2 +- .../0.46/qiskit.circuit.library.CUGate.md | 2 +- .../0.46/qiskit.circuit.library.CXGate.md | 2 +- .../0.46/qiskit.circuit.library.CYGate.md | 2 +- .../0.46/qiskit.circuit.library.CZGate.md | 2 +- .../0.46/qiskit.circuit.library.DCXGate.md | 2 +- .../0.46/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DiagonalGate.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../0.46/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.GR.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.GRZ.md | 2 +- .../qiskit.circuit.library.GlobalPhaseGate.md | 2 +- .../0.46/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../0.46/qiskit.circuit.library.HGate.md | 2 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- .../qiskit.circuit.library.HamiltonianGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../0.46/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.IQP.md | 2 +- .../0.46/qiskit.circuit.library.Initialize.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- .../0.46/qiskit.circuit.library.Isometry.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- .../qiskit.circuit.library.LinearFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../0.46/qiskit.circuit.library.MCMT.md | 2 +- .../0.46/qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../0.46/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../0.46/qiskit.circuit.library.MCXVChain.md | 2 +- .../0.46/qiskit.circuit.library.MSGate.md | 2 +- .../0.46/qiskit.circuit.library.Measure.md | 2 +- .../0.46/qiskit.circuit.library.NLocal.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../0.46/qiskit.circuit.library.PauliGate.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../0.46/qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../0.46/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../0.46/qiskit.circuit.library.RC3XGate.md | 2 +- .../0.46/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../0.46/qiskit.circuit.library.RGate.md | 2 +- .../0.46/qiskit.circuit.library.RVGate.md | 2 +- .../0.46/qiskit.circuit.library.RXGate.md | 2 +- .../0.46/qiskit.circuit.library.RXXGate.md | 2 +- .../0.46/qiskit.circuit.library.RYGate.md | 2 +- .../0.46/qiskit.circuit.library.RYYGate.md | 2 +- .../0.46/qiskit.circuit.library.RZGate.md | 2 +- .../0.46/qiskit.circuit.library.RZXGate.md | 2 +- .../0.46/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../0.46/qiskit.circuit.library.Reset.md | 2 +- .../0.46/qiskit.circuit.library.SGate.md | 2 +- .../0.46/qiskit.circuit.library.SXGate.md | 2 +- .../0.46/qiskit.circuit.library.SXdgGate.md | 2 +- .../0.46/qiskit.circuit.library.SdgGate.md | 2 +- ...qiskit.circuit.library.StatePreparation.md | 2 +- .../0.46/qiskit.circuit.library.SwapGate.md | 2 +- .../0.46/qiskit.circuit.library.TGate.md | 2 +- .../0.46/qiskit.circuit.library.TdgGate.md | 2 +- .../0.46/qiskit.circuit.library.TwoLocal.md | 2 +- .../0.46/qiskit.circuit.library.U1Gate.md | 2 +- .../0.46/qiskit.circuit.library.U2Gate.md | 2 +- .../0.46/qiskit.circuit.library.U3Gate.md | 2 +- .../0.46/qiskit.circuit.library.UCGate.md | 2 +- .../qiskit.circuit.library.UCPauliRotGate.md | 2 +- .../0.46/qiskit.circuit.library.UCRXGate.md | 2 +- .../0.46/qiskit.circuit.library.UCRYGate.md | 2 +- .../0.46/qiskit.circuit.library.UCRZGate.md | 2 +- .../0.46/qiskit.circuit.library.UGate.md | 2 +- .../qiskit.circuit.library.UnitaryGate.md | 2 +- .../qiskit.circuit.library.UnitaryOverlap.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../0.46/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/0.46/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 2 +- .../qiskit.circuit.library.XXPlusYYGate.md | 2 +- .../0.46/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../0.46/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../0.46/qiskit.circuit.library.iSwapGate.md | 2 +- .../0.46/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../0.46/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../0.46/qiskit.dagcircuit.DAGDependency.md | 2 +- .../0.46/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/0.46/qiskit.dagcircuit.DAGNode.md | 2 +- .../0.46/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../0.46/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../qiskit.extensions.SingleQubitUnitary.md | 2 +- .../qiskit/0.46/qiskit.extensions.Snapshot.md | 2 +- .../qiskit/0.46/qiskit.opflow.OperatorBase.md | 2 +- ...qiskit.opflow.converters.AbelianGrouper.md | 2 +- ...qiskit.opflow.converters.CircuitSampler.md | 2 +- .../qiskit.opflow.converters.ConverterBase.md | 2 +- ...skit.opflow.converters.DictToCircuitSum.md | 2 +- ...skit.opflow.converters.PauliBasisChange.md | 2 +- ...kit.opflow.converters.TwoQubitReduction.md | 2 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 2 +- ...skit.opflow.evolutions.EvolutionFactory.md | 2 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 2 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 2 +- ...opflow.evolutions.PauliTrotterEvolution.md | 2 +- .../0.46/qiskit.opflow.evolutions.QDrift.md | 2 +- .../0.46/qiskit.opflow.evolutions.Suzuki.md | 2 +- .../0.46/qiskit.opflow.evolutions.Trotter.md | 2 +- ...it.opflow.evolutions.TrotterizationBase.md | 2 +- ...opflow.evolutions.TrotterizationFactory.md | 2 +- ...opflow.expectations.AerPauliExpectation.md | 2 +- ...kit.opflow.expectations.CVaRExpectation.md | 2 +- ...kit.opflow.expectations.ExpectationBase.md | 2 +- ....opflow.expectations.ExpectationFactory.md | 2 +- ...t.opflow.expectations.MatrixExpectation.md | 2 +- ...it.opflow.expectations.PauliExpectation.md | 2 +- ...qiskit.opflow.gradients.CircuitGradient.md | 2 +- .../qiskit.opflow.gradients.CircuitQFI.md | 2 +- .../qiskit.opflow.gradients.DerivativeBase.md | 2 +- .../0.46/qiskit.opflow.gradients.Gradient.md | 2 +- .../qiskit.opflow.gradients.GradientBase.md | 2 +- .../0.46/qiskit.opflow.gradients.Hessian.md | 2 +- .../qiskit.opflow.gradients.HessianBase.md | 2 +- ...qiskit.opflow.gradients.NaturalGradient.md | 2 +- .../0.46/qiskit.opflow.gradients.QFI.md | 2 +- .../0.46/qiskit.opflow.gradients.QFIBase.md | 2 +- .../0.46/qiskit.opflow.list_ops.ComposedOp.md | 2 +- .../0.46/qiskit.opflow.list_ops.ListOp.md | 2 +- .../0.46/qiskit.opflow.list_ops.SummedOp.md | 2 +- .../0.46/qiskit.opflow.list_ops.TensoredOp.md | 2 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 2 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 2 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 2 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 2 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 2 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 2 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 2 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 2 +- .../qiskit.opflow.state_fns.DictStateFn.md | 2 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 2 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 2 +- .../0.46/qiskit.opflow.state_fns.StateFn.md | 2 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 2 +- .../0.46/qiskit.passmanager.BaseController.md | 2 +- .../qiskit.passmanager.BasePassManager.md | 2 +- ...iskit.passmanager.ConditionalController.md | 2 +- .../qiskit.passmanager.DoWhileController.md | 2 +- .../0.46/qiskit.passmanager.FlowController.md | 2 +- ...qiskit.passmanager.FlowControllerLinear.md | 2 +- .../0.46/qiskit.passmanager.GenericPass.md | 2 +- .../qiskit.passmanager.PassManagerState.md | 2 +- .../0.46/qiskit.passmanager.PropertySet.md | 2 +- .../0.46/qiskit.passmanager.WorkflowStatus.md | 2 +- .../qiskit.primitives.BackendEstimator.md | 2 +- .../0.46/qiskit.primitives.BackendSampler.md | 2 +- .../0.46/qiskit.primitives.BaseEstimator.md | 2 +- .../0.46/qiskit.primitives.BaseSampler.md | 2 +- .../0.46/qiskit.primitives.Estimator.md | 2 +- .../0.46/qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/0.46/qiskit.primitives.Sampler.md | 2 +- .../0.46/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit/0.46/qiskit.providers.Backend.md | 2 +- .../qiskit/0.46/qiskit.providers.BackendV1.md | 2 +- .../qiskit/0.46/qiskit.providers.BackendV2.md | 2 +- .../qiskit.providers.BackendV2Converter.md | 2 +- docs/api/qiskit/0.46/qiskit.providers.Job.md | 2 +- .../qiskit/0.46/qiskit.providers.JobStatus.md | 2 +- .../api/qiskit/0.46/qiskit.providers.JobV1.md | 2 +- .../qiskit/0.46/qiskit.providers.Options.md | 2 +- .../qiskit/0.46/qiskit.providers.Provider.md | 2 +- .../0.46/qiskit.providers.ProviderV1.md | 2 +- .../0.46/qiskit.providers.QubitProperties.md | 2 +- ....providers.basic_provider.BasicProvider.md | 2 +- ...iders.basic_provider.BasicProviderError.md | 2 +- ...oviders.basic_provider.BasicProviderJob.md | 2 +- ...providers.basic_provider.BasicSimulator.md | 2 +- ...qiskit.providers.basicaer.BasicAerError.md | 2 +- .../qiskit.providers.basicaer.BasicAerJob.md | 2 +- ...kit.providers.basicaer.BasicAerProvider.md | 2 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 2 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 2 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 2 +- .../qiskit.providers.convert_to_target.md | 2 +- ...s.fake_provider.ConfigurableFakeBackend.md | 2 +- .../qiskit.providers.fake_provider.Fake1Q.md | 2 +- ...kit.providers.fake_provider.FakeAlmaden.md | 2 +- ...t.providers.fake_provider.FakeAlmadenV2.md | 2 +- ...skit.providers.fake_provider.FakeArmonk.md | 2 +- ...it.providers.fake_provider.FakeArmonkV2.md | 2 +- ...skit.providers.fake_provider.FakeAthens.md | 2 +- ...it.providers.fake_provider.FakeAthensV2.md | 2 +- ...it.providers.fake_provider.FakeAuckland.md | 2 +- ...providers.fake_provider.FakeBackend5QV2.md | 2 +- ...t.providers.fake_provider.FakeBackendV2.md | 2 +- ...iskit.providers.fake_provider.FakeBelem.md | 2 +- ...kit.providers.fake_provider.FakeBelemV2.md | 2 +- ....providers.fake_provider.FakeBoeblingen.md | 2 +- ...roviders.fake_provider.FakeBoeblingenV2.md | 2 +- ...skit.providers.fake_provider.FakeBogota.md | 2 +- ...it.providers.fake_provider.FakeBogotaV2.md | 2 +- ...it.providers.fake_provider.FakeBrooklyn.md | 2 +- ....providers.fake_provider.FakeBrooklynV2.md | 2 +- ....providers.fake_provider.FakeBurlington.md | 2 +- ...roviders.fake_provider.FakeBurlingtonV2.md | 2 +- ...iskit.providers.fake_provider.FakeCairo.md | 2 +- ...kit.providers.fake_provider.FakeCairoV2.md | 2 +- ...t.providers.fake_provider.FakeCambridge.md | 2 +- ...providers.fake_provider.FakeCambridgeV2.md | 2 +- ....providers.fake_provider.FakeCasablanca.md | 2 +- ...roviders.fake_provider.FakeCasablancaV2.md | 2 +- ...iskit.providers.fake_provider.FakeEssex.md | 2 +- ...kit.providers.fake_provider.FakeEssexV2.md | 2 +- ...skit.providers.fake_provider.FakeGeneva.md | 2 +- ...t.providers.fake_provider.FakeGuadalupe.md | 2 +- ...providers.fake_provider.FakeGuadalupeV2.md | 2 +- ...iskit.providers.fake_provider.FakeHanoi.md | 2 +- ...kit.providers.fake_provider.FakeHanoiV2.md | 2 +- ...kit.providers.fake_provider.FakeJakarta.md | 2 +- ...t.providers.fake_provider.FakeJakartaV2.md | 2 +- ...roviders.fake_provider.FakeJohannesburg.md | 2 +- ...viders.fake_provider.FakeJohannesburgV2.md | 2 +- ...kit.providers.fake_provider.FakeKolkata.md | 2 +- ...t.providers.fake_provider.FakeKolkataV2.md | 2 +- ...iskit.providers.fake_provider.FakeLagos.md | 2 +- ...kit.providers.fake_provider.FakeLagosV2.md | 2 +- ...qiskit.providers.fake_provider.FakeLima.md | 2 +- ...skit.providers.fake_provider.FakeLimaV2.md | 2 +- ...skit.providers.fake_provider.FakeLondon.md | 2 +- ...it.providers.fake_provider.FakeLondonV2.md | 2 +- ...t.providers.fake_provider.FakeManhattan.md | 2 +- ...providers.fake_provider.FakeManhattanV2.md | 2 +- ...skit.providers.fake_provider.FakeManila.md | 2 +- ...it.providers.fake_provider.FakeManilaV2.md | 2 +- ...t.providers.fake_provider.FakeMelbourne.md | 2 +- ...providers.fake_provider.FakeMelbourneV2.md | 2 +- ...it.providers.fake_provider.FakeMontreal.md | 2 +- ....providers.fake_provider.FakeMontrealV2.md | 2 +- ...skit.providers.fake_provider.FakeMumbai.md | 2 +- ...rs.fake_provider.FakeMumbaiFractionalCX.md | 2 +- ...it.providers.fake_provider.FakeMumbaiV2.md | 2 +- ...kit.providers.fake_provider.FakeNairobi.md | 2 +- ...t.providers.fake_provider.FakeNairobiV2.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 2 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 2 +- ...qiskit.providers.fake_provider.FakeOslo.md | 2 +- ...kit.providers.fake_provider.FakeOurense.md | 2 +- ...t.providers.fake_provider.FakeOurenseV2.md | 2 +- ...iskit.providers.fake_provider.FakeParis.md | 2 +- ...kit.providers.fake_provider.FakeParisV2.md | 2 +- ...iskit.providers.fake_provider.FakePerth.md | 2 +- ...roviders.fake_provider.FakePoughkeepsie.md | 2 +- ...viders.fake_provider.FakePoughkeepsieV2.md | 2 +- ...skit.providers.fake_provider.FakePrague.md | 2 +- ...it.providers.fake_provider.FakeProvider.md | 2 +- ....fake_provider.FakeProviderForBackendV2.md | 2 +- ...oviders.fake_provider.FakeQasmSimulator.md | 2 +- ...iskit.providers.fake_provider.FakeQuito.md | 2 +- ...kit.providers.fake_provider.FakeQuitoV2.md | 2 +- ...t.providers.fake_provider.FakeRochester.md | 2 +- ...providers.fake_provider.FakeRochesterV2.md | 2 +- ...qiskit.providers.fake_provider.FakeRome.md | 2 +- ...skit.providers.fake_provider.FakeRomeV2.md | 2 +- ...providers.fake_provider.FakeRueschlikon.md | 2 +- ...it.providers.fake_provider.FakeSantiago.md | 2 +- ....providers.fake_provider.FakeSantiagoV2.md | 2 +- ....providers.fake_provider.FakeSherbrooke.md | 2 +- ...t.providers.fake_provider.FakeSingapore.md | 2 +- ...providers.fake_provider.FakeSingaporeV2.md | 2 +- ...skit.providers.fake_provider.FakeSydney.md | 2 +- ...it.providers.fake_provider.FakeSydneyV2.md | 2 +- ...it.providers.fake_provider.FakeTenerife.md | 2 +- ...iskit.providers.fake_provider.FakeTokyo.md | 2 +- ...kit.providers.fake_provider.FakeToronto.md | 2 +- ...t.providers.fake_provider.FakeTorontoV2.md | 2 +- ...it.providers.fake_provider.FakeValencia.md | 2 +- ....providers.fake_provider.FakeValenciaV2.md | 2 +- ...qiskit.providers.fake_provider.FakeVigo.md | 2 +- ...skit.providers.fake_provider.FakeVigoV2.md | 2 +- ....providers.fake_provider.FakeWashington.md | 2 +- ...roviders.fake_provider.FakeWashingtonV2.md | 2 +- ...it.providers.fake_provider.FakeYorktown.md | 2 +- ....providers.fake_provider.FakeYorktownV2.md | 2 +- ...roviders.fake_provider.GenericBackendV2.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../0.46/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../qiskit.providers.models.GateProperties.md | 2 +- .../0.46/qiskit.providers.models.JobStatus.md | 2 +- .../0.46/qiskit.providers.models.Nduv.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- docs/api/qiskit/0.46/qiskit.pulse.Schedule.md | 2 +- .../qiskit/0.46/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../0.46/qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../0.46/qiskit.pulse.instructions.Acquire.md | 2 +- .../0.46/qiskit.pulse.instructions.Call.md | 2 +- .../0.46/qiskit.pulse.instructions.Delay.md | 2 +- .../0.46/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- ...qiskit.pulse.library.Constant_class.rst.md | 2 +- .../qiskit.pulse.library.Cos_class.rst.md | 2 +- .../qiskit.pulse.library.Drag_class.rst.md | 2 +- .../qiskit.pulse.library.GaussianDeriv.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- ...qiskit.pulse.library.Gaussian_class.rst.md | 2 +- .../qiskit.pulse.library.ParametricPulse.md | 2 +- ...qiskit.pulse.library.Sawtooth_class.rst.md | 2 +- .../0.46/qiskit.pulse.library.SechDeriv.md | 2 +- .../0.46/qiskit.pulse.library.Sech_fun.rst.md | 2 +- .../qiskit.pulse.library.Sin_class.rst.md | 2 +- .../qiskit.pulse.library.Square_fun.rst.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 2 +- ...qiskit.pulse.library.Triangle_class.rst.md | 2 +- .../0.46/qiskit.pulse.library.Waveform.md | 2 +- ...skit.pulse.library.gaussian_square_echo.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 2 +- .../0.46/qiskit.pulse.transforms.AlignFunc.md | 2 +- .../0.46/qiskit.pulse.transforms.AlignLeft.md | 2 +- .../qiskit.pulse.transforms.AlignRight.md | 2 +- ...qiskit.pulse.transforms.AlignSequential.md | 2 +- .../0.46/qiskit.qobj.GateCalibration.md | 2 +- .../0.46/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.md | 2 +- .../0.46/qiskit.qobj.PulseQobjConfig.md | 2 +- .../0.46/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../0.46/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/0.46/qiskit.qobj.QasmQobjConfig.md | 2 +- .../0.46/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../0.46/qiskit.qobj.QasmQobjInstruction.md | 2 +- .../0.46/qiskit.qobj.QobjExperimentHeader.md | 2 +- .../api/qiskit/0.46/qiskit.qobj.QobjHeader.md | 2 +- .../0.46/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../0.46/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../qiskit/0.46/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/0.46/qiskit.quantum_info.Choi.md | 2 +- .../0.46/qiskit.quantum_info.Clifford.md | 2 +- .../0.46/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/0.46/qiskit.quantum_info.Kraus.md | 2 +- .../0.46/qiskit.quantum_info.Operator.md | 2 +- .../qiskit/0.46/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/0.46/qiskit.quantum_info.Pauli.md | 2 +- .../0.46/qiskit.quantum_info.PauliList.md | 2 +- .../0.46/qiskit.quantum_info.Quaternion.md | 2 +- .../0.46/qiskit.quantum_info.ScalarOp.md | 2 +- .../0.46/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerState.md | 2 +- .../0.46/qiskit.quantum_info.Statevector.md | 2 +- .../0.46/qiskit.quantum_info.Stinespring.md | 2 +- .../0.46/qiskit.quantum_info.SuperOp.md | 2 +- .../0.46/qiskit.quantum_info.Z2Symmetries.md | 2 +- .../0.46/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 2 +- ...iskit.result.CorrelatedReadoutMitigator.md | 2 +- docs/api/qiskit/0.46/qiskit.result.Counts.md | 2 +- .../qiskit.result.LocalReadoutMitigator.md | 2 +- .../0.46/qiskit.result.ProbDistribution.md | 2 +- .../0.46/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/0.46/qiskit.result.Result.md | 2 +- .../qiskit/0.46/qiskit.result.ResultError.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 2 +- .../0.46/qiskit.synthesis.LieTrotter.md | 2 +- .../qiskit.synthesis.MatrixExponential.md | 2 +- ...iskit.synthesis.OneQubitEulerDecomposer.md | 2 +- .../0.46/qiskit.synthesis.ProductFormula.md | 2 +- .../qiskit/0.46/qiskit.synthesis.QDrift.md | 2 +- ...it.synthesis.SolovayKitaevDecomposition.md | 2 +- .../0.46/qiskit.synthesis.SuzukiTrotter.md | 2 +- ...iskit.synthesis.TwoQubitBasisDecomposer.md | 2 +- .../0.46/qiskit.synthesis.XXDecomposer.md | 2 +- .../0.46/qiskit.synthesis.unitary.aqc.AQC.md | 2 +- ...ynthesis.unitary.aqc.ApproximateCircuit.md | 2 +- ...esis.unitary.aqc.ApproximatingObjective.md | 2 +- ...t.synthesis.unitary.aqc.CNOTUnitCircuit.md | 2 +- ...synthesis.unitary.aqc.CNOTUnitObjective.md | 2 +- ...is.unitary.aqc.DefaultCNOTUnitObjective.md | 2 +- ...hesis.unitary.aqc.FastCNOTUnitObjective.md | 2 +- .../0.46/qiskit.transpiler.AnalysisPass.md | 2 +- .../0.46/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.FencedDAGCircuit.md | 2 +- .../qiskit.transpiler.FencedPropertySet.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/0.46/qiskit.transpiler.Layout.md | 2 +- .../0.46/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 2 +- .../qiskit/0.46/qiskit.transpiler.Target.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- .../0.46/qiskit.transpiler.TranspileLayout.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 2 +- ...it.transpiler.passes.AQCSynthesisPlugin.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.AlignMeasures.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../0.46/qiskit.transpiler.passes.CheckMap.md | 2 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...r.passes.CommutativeInverseCancellation.md | 2 +- ...transpiler.passes.Commuting2qGateRouter.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- ...transpiler.passes.ConstrainedReschedule.md | 2 +- ...t.transpiler.passes.ContainsInstruction.md | 2 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 2 +- .../0.46/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../0.46/qiskit.transpiler.passes.Depth.md | 2 +- ...t.transpiler.passes.DynamicalDecoupling.md | 2 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- .../qiskit.transpiler.passes.GatesInBasis.md | 2 +- ...it.transpiler.passes.HighLevelSynthesis.md | 2 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 2 +- ...nspiler.passes.InstructionDurationCheck.md | 2 +- ...t.transpiler.passes.InverseCancellation.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- ...nspiler.passes.LinearFunctionsSynthesis.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- .../qiskit.transpiler.passes.MinimumPoint.md | 2 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 2 +- ...skit.transpiler.passes.NormalizeRXAngle.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...passes.Optimize1qGatesSimpleCommutation.md | 2 +- ...kit.transpiler.passes.OptimizeCliffords.md | 2 +- .../0.46/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 2 +- ....transpiler.passes.RXCalibrationBuilder.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 2 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- ....passes.ResetAfterMeasureSimplification.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- ...qiskit.transpiler.passes.SabrePreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetIOLatency.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../0.46/qiskit.transpiler.passes.Size.md | 2 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 2 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- ...it.transpiler.passes.TimeUnitConversion.md | 2 +- ...iler.passes.TranslateParameterizedGates.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- ...qiskit.transpiler.passes.UnrollForLoops.md | 2 +- .../0.46/qiskit.transpiler.passes.Unroller.md | 2 +- .../qiskit.transpiler.passes.VF2Layout.md | 2 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 2 +- ...it.transpiler.passes.ValidatePulseGates.md | 2 +- .../0.46/qiskit.transpiler.passes.Width.md | 2 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 2 +- ....plugin.HighLevelSynthesisPluginManager.md | 2 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 2 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 2 +- ...rs.plugin.PassManagerStagePluginManager.md | 2 +- .../0.46/qiskit.utils.QuantumInstance.md | 2 +- ...kit.utils.mitigation.CompleteMeasFitter.md | 2 +- ...kit.utils.mitigation.TensoredMeasFitter.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- ...ualization.circuit.qcstyle.DefaultStyle.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../0.46/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...qiskit.visualization.pulse.IQXDebugging.md | 2 +- .../qiskit.visualization.pulse.IQXSimple.md | 2 +- .../qiskit.visualization.pulse.IQXStandard.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/0.46/qpy.md | 6 +- docs/api/qiskit/0.46/quantum_info.md | 54 +++---- docs/api/qiskit/0.46/result.md | 8 +- docs/api/qiskit/0.46/scheduler.md | 8 +- docs/api/qiskit/0.46/synthesis.md | 42 +++--- docs/api/qiskit/0.46/synthesis_aqc.md | 2 +- docs/api/qiskit/0.46/tools.md | 8 +- docs/api/qiskit/0.46/transpiler.md | 8 +- docs/api/qiskit/0.46/transpiler_plugins.md | 4 +- docs/api/qiskit/0.46/transpiler_preset.md | 26 ++-- docs/api/qiskit/0.46/utils.md | 40 ++--- docs/api/qiskit/0.46/visualization.md | 2 +- 779 files changed, 1088 insertions(+), 1088 deletions(-) diff --git a/docs/api/qiskit/0.46/algorithms.md b/docs/api/qiskit/0.46/algorithms.md index 069d9bd0d13..5aa12c41571 100644 --- a/docs/api/qiskit/0.46/algorithms.md +++ b/docs/api/qiskit/0.46/algorithms.md @@ -197,7 +197,7 @@ Algorithms that compute the fidelity of pairs of quantum states. -`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/exceptions.py "view source code") +`qiskit.algorithms.AlgorithmError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. @@ -219,7 +219,7 @@ Utility functions used by algorithms. -`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/aux_ops_evaluator.py "view source code") Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. @@ -253,7 +253,7 @@ ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in P -`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/observables_evaluator.py "view source code") +`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.46/assembler.md b/docs/api/qiskit/0.46/assembler.md index e41da15b1d5..2a6bf551513 100644 --- a/docs/api/qiskit/0.46/assembler.md +++ b/docs/api/qiskit/0.46/assembler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.assembler -`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/assemble_circuits.py "view source code") +`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. @@ -69,7 +69,7 @@ qobj = assemble_circuits(circuits=[qc], -`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/assemble_schedules.py "view source code") +`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. @@ -135,7 +135,7 @@ pulseQobj = assemble_schedules(schedules=[schedule], -`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/disassemble.py "view source code") +`qiskit.assembler.disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.46/circuit.md b/docs/api/qiskit/0.46/circuit.md index 0f3a54be0dd..14f845da5e3 100644 --- a/docs/api/qiskit/0.46/circuit.md +++ b/docs/api/qiskit/0.46/circuit.md @@ -289,7 +289,7 @@ with qc.switch(cr) as case: -`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/random/utils.py "view source code") +`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. @@ -349,7 +349,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c -`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/exceptions.py "view source code") +`qiskit.circuit.CircuitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/exceptions.py "view source code") Base class for errors raised while processing a circuit. diff --git a/docs/api/qiskit/0.46/circuit_classical.md b/docs/api/qiskit/0.46/circuit_classical.md index 844cf16d370..79763af0643 100644 --- a/docs/api/qiskit/0.46/circuit_classical.md +++ b/docs/api/qiskit/0.46/circuit_classical.md @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are -`qiskit.circuit.classical.expr.Expr`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") +`qiskit.circuit.classical.expr.Expr` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap -`final class qiskit.circuit.classical.expr.Var(var, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Var(var, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` -`final class qiskit.circuit.classical.expr.Value(value, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Value(value, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p -`final class qiskit.circuit.classical.expr.Unary(op, operand, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Unary(op, operand, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") A unary expression. @@ -118,7 +118,7 @@ Logical negation. `!operand`. -`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") A binary expression. @@ -235,7 +235,7 @@ Expressions in this system are defined to act only on certain sets of types. How -`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/expr.py "view source code") A cast from one type to another, implied by the use of an expression in a different context. @@ -251,7 +251,7 @@ The functions and methods described in this section are a more user-friendly way -`qiskit.circuit.classical.expr.lift(value, /, type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift(value, /, type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Lift the given Python `value` to a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value") or [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var"). @@ -291,7 +291,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo -`qiskit.circuit.classical.expr.cast(operand, type, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.cast(operand, type, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create an explicit cast from the given value to the given type. @@ -316,7 +316,7 @@ There are helper constructor functions for each of the unary operations. -`qiskit.circuit.classical.expr.bit_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -339,7 +339,7 @@ Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) -`qiskit.circuit.classical.expr.logic_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -364,7 +364,7 @@ Similarly, the binary operations and relations have helper functions defined. -`qiskit.circuit.classical.expr.bit_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -387,7 +387,7 @@ Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint -`qiskit.circuit.classical.expr.bit_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -410,7 +410,7 @@ Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint( -`qiskit.circuit.classical.expr.bit_xor(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_xor(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘exclusive or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -433,7 +433,7 @@ Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.logic_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -456,7 +456,7 @@ Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool -`qiskit.circuit.classical.expr.logic_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -479,7 +479,7 @@ Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool( -`qiskit.circuit.classical.expr.equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create an ‘equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -502,7 +502,7 @@ Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3 -`qiskit.circuit.classical.expr.not_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.not_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘not equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -525,7 +525,7 @@ Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Ui -`qiskit.circuit.classical.expr.less(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -548,7 +548,7 @@ Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3) -`qiskit.circuit.classical.expr.less_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -571,7 +571,7 @@ Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(Classi -`qiskit.circuit.classical.expr.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -594,7 +594,7 @@ Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.greater_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -619,7 +619,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition -`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/constructors.py "view source code") Lift a legacy two-tuple equality condition into a new-style [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"). @@ -648,7 +648,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/visitors.py "view source code") Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. @@ -720,7 +720,7 @@ For the convenience of simple visitors that only need to inspect the variables i -`qiskit.circuit.classical.expr.iter_vars(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.iter_vars(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/visitors.py "view source code") Get an iterator over the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") nodes referenced at any level in the given [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr"). @@ -750,7 +750,7 @@ Two expressions can be compared for direct structural equality by using the buil -`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/expr/visitors.py "view source code") Do these two expressions have exactly the same tree structure, up to some key function for the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") objects? @@ -809,7 +809,7 @@ All types inherit from an abstract base class: -`qiskit.circuit.classical.types.Type`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/types.py "view source code") +`qiskit.circuit.classical.types.Type` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/types.py "view source code") Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -821,13 +821,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q -`final class qiskit.circuit.classical.types.Bool`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Bool` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/types.py "view source code") The Boolean type. This has exactly two values: `True` and `False`. -`final class qiskit.circuit.classical.types.Uint(width)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Uint(width)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/types.py "view source code") An unsigned integer of fixed bit width. @@ -843,7 +843,7 @@ The low-level interface to querying the subtyping relationship is the [`order()` -`qiskit.circuit.classical.types.order(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.order(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") Get the ordering relationship between the two types as an enumeration value. @@ -872,7 +872,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. -`qiskit.circuit.classical.types.Ordering(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.Ordering(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -884,7 +884,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis -`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \le \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -915,7 +915,7 @@ False -`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \ge \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -946,7 +946,7 @@ False -`qiskit.circuit.classical.types.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classical/types/ordering.py "view source code") Get the greater of the two types, assuming that there is an ordering relation between them. Technically, this is a slightly restricted version of the concept of the ‘meet’ of the two types in that the return value must be one of the inputs. In practice in the type system there is no concept of a ‘sum’ type, so the ‘meet’ exists if and only if there is an ordering between the two types, and is equal to the greater of the two types. diff --git a/docs/api/qiskit/0.46/circuit_library.md b/docs/api/qiskit/0.46/circuit_library.md index 463777ab094..77509e47ee3 100644 --- a/docs/api/qiskit/0.46/circuit_library.md +++ b/docs/api/qiskit/0.46/circuit_library.md @@ -328,7 +328,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib -`qiskit.circuit.library.templates.nct.template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** @@ -342,7 +342,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** @@ -356,7 +356,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** @@ -370,7 +370,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** @@ -384,7 +384,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** @@ -398,7 +398,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** @@ -412,7 +412,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** @@ -426,7 +426,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** @@ -440,7 +440,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** @@ -454,7 +454,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** @@ -468,7 +468,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** @@ -482,7 +482,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** @@ -496,7 +496,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** @@ -510,7 +510,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** @@ -524,7 +524,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** @@ -538,7 +538,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** @@ -552,7 +552,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** @@ -566,7 +566,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** @@ -580,7 +580,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** @@ -594,7 +594,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** @@ -608,7 +608,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** @@ -622,7 +622,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** @@ -636,7 +636,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** @@ -650,7 +650,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** @@ -664,7 +664,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** @@ -678,7 +678,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** @@ -692,7 +692,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** @@ -706,7 +706,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** @@ -720,7 +720,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** @@ -734,7 +734,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** @@ -748,7 +748,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** @@ -762,7 +762,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** @@ -776,7 +776,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** @@ -790,7 +790,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** @@ -804,7 +804,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** @@ -818,7 +818,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** @@ -832,7 +832,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** @@ -846,7 +846,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** @@ -860,7 +860,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** @@ -874,7 +874,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** @@ -888,7 +888,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** @@ -902,7 +902,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** @@ -916,7 +916,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** @@ -930,7 +930,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** @@ -944,7 +944,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** @@ -958,7 +958,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** @@ -972,7 +972,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** @@ -990,7 +990,7 @@ Template circuits over Clifford gates. -`qiskit.circuit.library.clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`qiskit.circuit.library.clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** @@ -1004,7 +1004,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`qiskit.circuit.library.clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** @@ -1018,7 +1018,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`qiskit.circuit.library.clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** @@ -1032,7 +1032,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`qiskit.circuit.library.clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** @@ -1046,7 +1046,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`qiskit.circuit.library.clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** @@ -1060,7 +1060,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`qiskit.circuit.library.clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** @@ -1074,7 +1074,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`qiskit.circuit.library.clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** @@ -1088,7 +1088,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`qiskit.circuit.library.clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** @@ -1102,7 +1102,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`qiskit.circuit.library.clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** @@ -1116,7 +1116,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`qiskit.circuit.library.clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** @@ -1130,7 +1130,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`qiskit.circuit.library.clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** @@ -1144,7 +1144,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`qiskit.circuit.library.clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** @@ -1158,7 +1158,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`qiskit.circuit.library.clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** @@ -1172,7 +1172,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`qiskit.circuit.library.clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** @@ -1186,7 +1186,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`qiskit.circuit.library.clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** @@ -1200,7 +1200,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`qiskit.circuit.library.clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** @@ -1214,7 +1214,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`qiskit.circuit.library.clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** @@ -1228,7 +1228,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`qiskit.circuit.library.clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** @@ -1246,7 +1246,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui -`qiskit.circuit.library.rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`qiskit.circuit.library.rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. @@ -1254,7 +1254,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`qiskit.circuit.library.rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. @@ -1262,7 +1262,7 @@ Template for CX - RXGate - CX. -`qiskit.circuit.library.rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`qiskit.circuit.library.rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. @@ -1270,7 +1270,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`qiskit.circuit.library.rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. @@ -1278,7 +1278,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`qiskit.circuit.library.rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. @@ -1286,7 +1286,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`qiskit.circuit.library.rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.46/circuit_singleton.md b/docs/api/qiskit/0.46/circuit_singleton.md index cd7dceddb72..647f6475c34 100644 --- a/docs/api/qiskit/0.46/circuit_singleton.md +++ b/docs/api/qiskit/0.46/circuit_singleton.md @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir -`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/singleton.py "view source code") A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. @@ -56,7 +56,7 @@ The exception to be aware of with this class though are the [`Instruction`](qisk -`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/singleton.py "view source code") A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. @@ -64,7 +64,7 @@ This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton -`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/singleton.py "view source code") A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances diff --git a/docs/api/qiskit/0.46/compiler.md b/docs/api/qiskit/0.46/compiler.md index d4b64eb6edd..834326a43fc 100644 --- a/docs/api/qiskit/0.46/compiler.md +++ b/docs/api/qiskit/0.46/compiler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.compiler -`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/assembler.py "view source code") +`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. @@ -107,7 +107,7 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will -`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/scheduler.py "view source code") +`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`. @@ -136,7 +136,7 @@ A pulse `Schedule` that implements the input circuit -`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/transpiler.py "view source code") +`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. @@ -284,7 +284,7 @@ The transpiled circuit(s). -`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/sequencer.py "view source code") +`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.46/converters.md b/docs/api/qiskit/0.46/converters.md index bf6bd7e0ff7..3c286a5e595 100644 --- a/docs/api/qiskit/0.46/converters.md +++ b/docs/api/qiskit/0.46/converters.md @@ -22,7 +22,7 @@ python_api_name: qiskit.converters -`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_dag.py "view source code") +`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_dag.py "view source code") Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -66,7 +66,7 @@ dag = circuit_to_dag(circ) -`qiskit.converters.dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dag_to_circuit.py "view source code") +`qiskit.converters.dag_to_circuit(dag, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. @@ -110,7 +110,7 @@ circuit.draw('mpl') -`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_instruction.py "view source code") +`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -155,7 +155,7 @@ circuit_to_instruction(circ) -`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_gate.py "view source code") +`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -184,7 +184,7 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g -`qiskit.converters.ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/ast_to_dag.py "view source code") +`qiskit.converters.ast_to_dag(ast)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. @@ -230,7 +230,7 @@ dag = ast_to_dag(ast) -`qiskit.converters.dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dagdependency_to_circuit.py "view source code") +`qiskit.converters.dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. @@ -250,7 +250,7 @@ the circuit representing the input dag dependency. -`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_dagdependency.py "view source code") +`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -271,7 +271,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dag_to_dagdependency.py "view source code") +`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. @@ -292,7 +292,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dagdependency_to_dag.py "view source code") +`qiskit.converters.dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.46/dagcircuit.md b/docs/api/qiskit/0.46/dagcircuit.md index 1df38534736..295c770e074 100644 --- a/docs/api/qiskit/0.46/dagcircuit.md +++ b/docs/api/qiskit/0.46/dagcircuit.md @@ -36,7 +36,7 @@ python_api_name: qiskit.dagcircuit -`qiskit.dagcircuit.DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. @@ -46,7 +46,7 @@ Set the error message. -`qiskit.dagcircuit.DAGDependencyError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGDependencyError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGDependency object. diff --git a/docs/api/qiskit/0.46/exceptions.md b/docs/api/qiskit/0.46/exceptions.md index 983b3da06c8..0391bcfdf79 100644 --- a/docs/api/qiskit/0.46/exceptions.md +++ b/docs/api/qiskit/0.46/exceptions.md @@ -24,7 +24,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: -`qiskit.exceptions.QiskitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") Base class for errors raised by Qiskit. @@ -42,7 +42,7 @@ Qiskit has several optional features that depend on other packages that are not -`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") +`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") Raised when an optional library is missing. @@ -54,7 +54,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, -`qiskit.exceptions.QiskitUserConfigError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitUserConfigError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") Raised when an error is encountered reading a user config file. @@ -64,7 +64,7 @@ Set the error message. -`qiskit.exceptions.InvalidFileError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") +`qiskit.exceptions.InvalidFileError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/exceptions.py "view source code") Raised when the file provided is not valid for the specific task. diff --git a/docs/api/qiskit/0.46/execute.md b/docs/api/qiskit/0.46/execute.md index 963a49fe490..0ca6c3d66da 100644 --- a/docs/api/qiskit/0.46/execute.md +++ b/docs/api/qiskit/0.46/execute.md @@ -22,7 +22,7 @@ python_api_name: qiskit.execute_function -`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/execute_function.py "view source code") +`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.46/extensions.md b/docs/api/qiskit/0.46/extensions.md index edc82a15983..fef5f460eb7 100644 --- a/docs/api/qiskit/0.46/extensions.md +++ b/docs/api/qiskit/0.46/extensions.md @@ -38,7 +38,7 @@ The additional gates in this module will tend to raise a custom exception when t -`qiskit.extensions.ExtensionError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/extensions/exceptions.py "view source code") +`qiskit.extensions.ExtensionError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/extensions/exceptions.py "view source code") Base class for errors raised by extensions module. diff --git a/docs/api/qiskit/0.46/opflow.md b/docs/api/qiskit/0.46/opflow.md index b4f9e0a0651..ad751b1df83 100644 --- a/docs/api/qiskit/0.46/opflow.md +++ b/docs/api/qiskit/0.46/opflow.md @@ -99,7 +99,7 @@ The Converter submodules include objects which manipulate Operators, usually rec -`qiskit.opflow.commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/utils.py "view source code") Deprecated: Compute commutator of op\_a and op\_b. @@ -128,7 +128,7 @@ the commutator -`qiskit.opflow.anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.anti_commutator(op_a, op_b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/utils.py "view source code") Deprecated: Compute anti-commutator of op\_a and op\_b. @@ -157,7 +157,7 @@ the anti-commutator -`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/utils.py "view source code") Deprecated: Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) @@ -202,7 +202,7 @@ the double commutator -`qiskit.opflow.OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/exceptions.py "view source code") +`qiskit.opflow.OpflowError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/exceptions.py "view source code") Deprecated: For Opflow specific errors. diff --git a/docs/api/qiskit/0.46/passmanager.md b/docs/api/qiskit/0.46/passmanager.md index d50b5df0a65..18422a7f884 100644 --- a/docs/api/qiskit/0.46/passmanager.md +++ b/docs/api/qiskit/0.46/passmanager.md @@ -165,7 +165,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza -`qiskit.passmanager.PassManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/exceptions.py "view source code") +`qiskit.passmanager.PassManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/exceptions.py "view source code") Pass manager error. diff --git a/docs/api/qiskit/0.46/providers.md b/docs/api/qiskit/0.46/providers.md index eeee0fc05fb..ccc3cbff0a4 100644 --- a/docs/api/qiskit/0.46/providers.md +++ b/docs/api/qiskit/0.46/providers.md @@ -79,7 +79,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p -`qiskit.providers.QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. @@ -89,7 +89,7 @@ Set the error message. -`qiskit.providers.BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. @@ -99,7 +99,7 @@ Set the error message. -`qiskit.providers.JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. @@ -109,7 +109,7 @@ Set the error message. -`qiskit.providers.JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. @@ -119,7 +119,7 @@ Set the error message. -`qiskit.providers.BackendConfigurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendConfigurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/exceptions.py "view source code") Base class for errors raised by the BackendConfiguration. diff --git a/docs/api/qiskit/0.46/providers_fake_provider.md b/docs/api/qiskit/0.46/providers_fake_provider.md index e03e312b370..50457043d03 100644 --- a/docs/api/qiskit/0.46/providers_fake_provider.md +++ b/docs/api/qiskit/0.46/providers_fake_provider.md @@ -212,7 +212,7 @@ The fake backends based on IBM hardware are based on a set of base classes: -`qiskit.providers.fake_provider.fake_backend.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.fake_backend.FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend.py "view source code") A fake backend class for testing and noisy simulation using real backend snapshots. @@ -226,7 +226,7 @@ FakeBackendV2 initializer. -`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend.py "view source code") This is a dummy backend just for testing purposes. @@ -239,7 +239,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakeQasmBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") +`qiskit.providers.fake_provider.FakeQasmBackend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") A fake OpenQASM backend. @@ -252,7 +252,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakePulseBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") +`qiskit.providers.fake_provider.FakePulseBackend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") A fake pulse backend. diff --git a/docs/api/qiskit/0.46/pulse.md b/docs/api/qiskit/0.46/pulse.md index 5ffda402d4f..8a2c2a52851 100644 --- a/docs/api/qiskit/0.46/pulse.md +++ b/docs/api/qiskit/0.46/pulse.md @@ -73,7 +73,7 @@ These are all instances of the same base class: -`qiskit.pulse.instructions.Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/instruction.py "view source code") +`qiskit.pulse.instructions.Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -118,7 +118,7 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -`qiskit.pulse.library.constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.constant(duration, amp, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -146,7 +146,7 @@ $$ -`qiskit.pulse.library.zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.zero(duration, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -173,7 +173,7 @@ $$ -`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -205,7 +205,7 @@ with the convention $\text{sign}(0) = 1$. -`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -254,7 +254,7 @@ plt.show() -`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -303,7 +303,7 @@ plt.show() -`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -333,7 +333,7 @@ $$ -`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -363,7 +363,7 @@ $$ -`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -405,7 +405,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -437,7 +437,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -477,7 +477,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -510,7 +510,7 @@ i.e. the derivative of $\text{sech}$. -`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -554,7 +554,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/discrete.py "view source code") Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -646,7 +646,7 @@ All channels are children of the same abstract base class: -`qiskit.pulse.channels.Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.Channel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -701,7 +701,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`qiskit.pulse.transforms.AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -717,7 +717,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -742,7 +742,7 @@ A `Schedule` with the additional acquisition instructions. -`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. @@ -811,7 +811,7 @@ The input list of schedules transformed to have their measurements aligned. -`qiskit.pulse.transforms.block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. @@ -840,7 +840,7 @@ Scheduled pulse program. -`qiskit.pulse.transforms.compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. @@ -860,7 +860,7 @@ Compressed schedules. -`qiskit.pulse.transforms.flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. @@ -884,7 +884,7 @@ Flatten pulse program. -`qiskit.pulse.transforms.inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. @@ -910,7 +910,7 @@ A schedule without subroutine. -`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. @@ -938,7 +938,7 @@ The padded schedule. -`qiskit.pulse.transforms.remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. @@ -958,7 +958,7 @@ A schedule without directives. -`qiskit.pulse.transforms.remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. @@ -984,7 +984,7 @@ The DAG transforms create DAG representation of input program. This can be used -`qiskit.pulse.transforms.block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/dag.py "view source code") +`qiskit.pulse.transforms.block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. @@ -1044,7 +1044,7 @@ A sequence of transformations to generate a target code. -`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/base_transforms.py "view source code") +`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. @@ -1265,7 +1265,7 @@ The above is just a small taste of what is possible with the builder. See the re -`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. @@ -1337,7 +1337,7 @@ DriveChannel(0) -`qiskit.pulse.builder.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. @@ -1365,7 +1365,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. @@ -1402,7 +1402,7 @@ List of control channels associated with the supplied ordered list of qubits. -`qiskit.pulse.builder.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. @@ -1430,7 +1430,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. @@ -1491,7 +1491,7 @@ drive_sched.draw() -`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1530,7 +1530,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. @@ -1599,7 +1599,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1778,7 +1778,7 @@ Currently, the backend calibrated gates are provided in the form of [`Schedule`] -`qiskit.pulse.builder.delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. @@ -1803,7 +1803,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. @@ -1828,7 +1828,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. @@ -1855,7 +1855,7 @@ main_prog.assign_references(subroutine_dict={("x_gate", "q0"): subroutine}) -`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. @@ -1880,7 +1880,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. @@ -1907,7 +1907,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. @@ -1932,7 +1932,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. @@ -1959,7 +1959,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Simulator snapshot. @@ -2003,7 +2003,7 @@ pulse_prog.draw() -`qiskit.pulse.builder.align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. @@ -2051,7 +2051,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. @@ -2105,7 +2105,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. @@ -2142,7 +2142,7 @@ None -`qiskit.pulse.builder.align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. @@ -2179,7 +2179,7 @@ None -`qiskit.pulse.builder.align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. @@ -2216,7 +2216,7 @@ None -`qiskit.pulse.builder.circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.circuit_scheduler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. @@ -2251,7 +2251,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. @@ -2297,7 +2297,7 @@ None -`qiskit.pulse.builder.phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. @@ -2334,7 +2334,7 @@ None -`qiskit.pulse.builder.transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.transpiler_settings(**settings)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. @@ -2388,7 +2388,7 @@ MemorySlot(0) -`qiskit.pulse.builder.measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. @@ -2445,7 +2445,7 @@ The `register` the qubit measurement result will be stored in. -`qiskit.pulse.builder.measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. @@ -2480,7 +2480,7 @@ The `register`s the qubit measurement results will be stored in. -`qiskit.pulse.builder.delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -2539,7 +2539,7 @@ There are 1e-06 seconds in 4500 samples. -`qiskit.pulse.builder.active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. @@ -2561,7 +2561,7 @@ builder context. -`qiskit.pulse.builder.active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_transpiler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. @@ -2596,7 +2596,7 @@ with pulse.build(backend, -`qiskit.pulse.builder.active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_circuit_scheduler_settings()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. @@ -2632,7 +2632,7 @@ with pulse.build( -`qiskit.pulse.builder.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. @@ -2664,7 +2664,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. @@ -2700,7 +2700,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2720,7 +2720,7 @@ The time that elapses in `samples`. -`qiskit.pulse.builder.seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. @@ -2750,7 +2750,7 @@ The number of samples for the time to elapse -`qiskit.pulse.PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. @@ -2760,7 +2760,7 @@ Set the error message. -`qiskit.pulse.BackendNotSet(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.BackendNotSet(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") Raised if the builder context does not have a backend. @@ -2770,7 +2770,7 @@ Set the error message. -`qiskit.pulse.NoActiveBuilder(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.NoActiveBuilder(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") Raised if no builder context is active. @@ -2780,7 +2780,7 @@ Set the error message. -`qiskit.pulse.UnassignedDurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedDurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") Raised if instruction duration is unassigned. @@ -2790,7 +2790,7 @@ Set the error message. -`qiskit.pulse.UnassignedReferenceError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedReferenceError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/exceptions.py "view source code") Raised if subroutine is unassigned. diff --git a/docs/api/qiskit/0.46/qasm.md b/docs/api/qiskit/0.46/qasm.md index 43b68c777d1..4dca0edfa5f 100644 --- a/docs/api/qiskit/0.46/qasm.md +++ b/docs/api/qiskit/0.46/qasm.md @@ -26,7 +26,7 @@ python_api_name: qiskit.qasm -`qiskit.qasm.Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/qasm.py "view source code") +`qiskit.qasm.Qasm(filename=None, data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/qasm.py "view source code") OPENQASM circuit object. @@ -36,19 +36,19 @@ Create an OPENQASM circuit object. -`qiskit.qasm.OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.OpenQASMLexer(*args, **kwds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/pygments/lexer.py "view source code") A pygments lexer for OpenQasm. -`qiskit.qasm.QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmHTMLStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a HTML env (e.g. Jupyter widget). -`qiskit.qasm.QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmTerminalStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm/pygments/lexer.py "view source code") A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/0.46/qasm2.md b/docs/api/qiskit/0.46/qasm2.md index cb5c866feab..f6ae6f53538 100644 --- a/docs/api/qiskit/0.46/qasm2.md +++ b/docs/api/qiskit/0.46/qasm2.md @@ -34,7 +34,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -59,7 +59,7 @@ A circuit object representing the same OpenQASM 2 program. -`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -89,7 +89,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/parse.py "view source code") +`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/parse.py "view source code") Information about a custom instruction that should be defined during the parse. @@ -129,7 +129,7 @@ Similar to other serialisation modules in Python, this module offers two public -`qiskit.qasm2.dump(circuit, filename_or_stream, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dump(circuit, filename_or_stream, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/export.py "view source code") Dump a circuit as an OpenQASM 2 program to a file or stream. @@ -146,7 +146,7 @@ Dump a circuit as an OpenQASM 2 program to a file or stream. -`qiskit.qasm2.dumps(circuit, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dumps(circuit, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/export.py "view source code") Export a circuit to an OpenQASM 2 program in a string. @@ -174,7 +174,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep -`qiskit.qasm2.QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2Error(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/exceptions.py "view source code") A general error raised by the OpenQASM 2 interoperation layer. @@ -186,7 +186,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`qiskit.qasm2.QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to parse an OpenQASM 2 file. @@ -198,7 +198,7 @@ When the exporters fail to export a circuit, likely because it has structure tha -`qiskit.qasm2.QASM2ExportError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ExportError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. diff --git a/docs/api/qiskit/0.46/qasm3.md b/docs/api/qiskit/0.46/qasm3.md index dfedb2c5339..062ddd9f2a0 100644 --- a/docs/api/qiskit/0.46/qasm3.md +++ b/docs/api/qiskit/0.46/qasm3.md @@ -28,7 +28,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`qiskit.qasm3.dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. @@ -42,7 +42,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`qiskit.qasm3.dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. @@ -63,7 +63,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/exporter.py "view source code") +`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -117,7 +117,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`qiskit.qasm3.QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -129,7 +129,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`qiskit.qasm3.ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/experimental.py "view source code") +`qiskit.qasm3.ExperimentalFeatures(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/experimental.py "view source code") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -190,7 +190,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`qiskit.qasm3.load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -214,7 +214,7 @@ a circuit representation of the OpenQASM 3 program. -`qiskit.qasm3.loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -240,7 +240,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`qiskit.qasm3.QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.md index 1c28c725869..efb19829f8e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/algorithm_job.py "view source code") +`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/algorithm_job.py "view source code") Bases: `PrimitiveJob` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.md index 426a92036ac..3437cb70daa 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.md index 4b14d938e73..bfa292b16fe 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`qiskit.algorithms.AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`qiskit.algorithms.AmplitudeAmplifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.md index c844fb460d4..faba15a0054 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.md index 80b08e2a4dd..e26d8aba6c6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`qiskit.algorithms.AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.md index 821c503ac49..a52247100d4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`qiskit.algorithms.AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.md index 5a0c1c7ded8..c37760942e8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`qiskit.algorithms.AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimatorResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.md index ad57568cab0..ced879ff8e1 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`qiskit.algorithms.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.md index 03e7cb8b914..4f7e1c77511 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`qiskit.algorithms.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.md index aeac7da70d1..9005684cca4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.md index 64be4821117..1b17dff5624 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.md index 09ed5d3cd01..1fe4d2b84ff 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.md index f05209412d3..716c29ad107 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 4dbb1d7c8d1..4e1df421460 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`qiskit.algorithms.FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.46/qiskit.algorithms.Grover.md index b7db25ad874..8060c99a828 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.md index 2c282eeee73..efb386c1c1d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`qiskit.algorithms.GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.GroverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.md index 17276958a9c..6598cd9b9b0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index 5b81fe777f5..4d9607c2692 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.md index 27922a3abc0..ef415be06da 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`qiskit.algorithms.ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`qiskit.algorithms.ImaginaryEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.md index d69a3a74c68..b2631b610cc 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`qiskit.algorithms.ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`qiskit.algorithms.ImaginaryTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.md index 6469f0cf473..5d3c1da07f1 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index a15dbdf6a71..fe2c375c852 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`qiskit.algorithms.IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.md index 3095e76d3f6..6e5d6ba3105 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index a3678f12946..b97e7c7c814 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 88a16515f26..a9d5d76a0e3 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.md index 9dd4b03ecfd..fae6e0c6708 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`qiskit.algorithms.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.md index 361249940ab..715148a8eb0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`qiskit.algorithms.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.md index 10eac4810ba..43207d0230b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.md index 8ebc24d2b58..335ef98b52c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.md index f6e2ec0719e..93d647921a6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.md index 4bae482a186..d39a9a92774 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.md index e32c2a64cb6..0d7ebf8224f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.md index d500ae05dd7..d6afbffcc3e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `PhaseEstimatorResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.md index ecbf2957b8f..f0149b4a24a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`qiskit.algorithms.PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`qiskit.algorithms.PhaseEstimationScale(bound)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.md index 6f1fb3443bc..477c5766a64 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.md index 9f3765e6997..22171edeaad 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`qiskit.algorithms.RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`qiskit.algorithms.RealEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.md index 9ff195c72a6..9f5f2e73bf6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`qiskit.algorithms.RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`qiskit.algorithms.RealTimeEvolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.md index dc36939ecd0..fc69b3399a0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.md index 04b53286b88..b12c34c9e17 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`qiskit.algorithms.SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`qiskit.algorithms.SciPyRealEvolver(num_timesteps)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.md index f19ac2c85e2..75a1ccd82ec 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.md index 3000cb287b0..00f53ad1acd 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.md index 18315511224..aacf40b042b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.46/qiskit.algorithms.VQD.md index 1e31358f840..7178b2a5a1f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.md index d89e9745884..42c8faa2732 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`qiskit.algorithms.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.46/qiskit.algorithms.VQE.md index d021ddd4811..11805afe237 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.md index 811c71c96c2..8fb2f199728 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.md index 7f82404a884..691305a1aaf 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.md index d5b2ed3ab00..61a5bb55cb6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`qiskit.algorithms.eigensolvers.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.Eigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.md index c1264ba5c4d..ae39286b715 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`qiskit.algorithms.eigensolvers.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.EigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index f3b0e4a0977..f539e1ee2fa 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index 2a492983aa9..9990ccd9ed7 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`qiskit.algorithms.eigensolvers.NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.md index aa9f706b38c..803469b0652 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.md index 58c1ff70950..82dce531a98 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`qiskit.algorithms.eigensolvers.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQDResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 9e6baec477b..de225422f58 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.md index 8e24e88cd72..faa6c8a7041 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/base_qgt.py "view source code") +`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/base_qgt.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.md index ea964ae2633..c54c36a46b1 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.md index c9f73e02483..84056d8df01 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") +`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 6ce94f07798..365d9e8dea8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index 13d46349162..fe867e85867 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index ddb39859b71..0e17ee4d9fc 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.md index 1e928f2d2ff..b855648a38f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") +`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.md index 88d20cf0b3a..cf688e0b8a8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 8322b6fc9e6..8693a30ec10 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index b16ba99356d..f1cede241a2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.md index f2526b1b2ef..28518732c77 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`qiskit.algorithms.gradients.QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/qfi.py "view source code") +`qiskit.algorithms.gradients.QFI(qgt, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/qfi.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.md index 2508cc38001..d39b206b355 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/qfi_result.py "view source code") +`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.md index edae6cb653a..51da462507c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/qgt_result.py "view source code") +`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/qgt_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index de777e4f0c5..17791acce20 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") +`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.md index 9ed09abdbcb..509e99753f8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") +`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 267dce75047..b3582066a97 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.md index 4925431e787..b496d6e1b7f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.md index a1fceb270a5..e079061b30a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") +`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 2b818c6e3f7..28a36db0f65 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index df1b52a7773..3b425a14f1d 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 24547fd50b7..66ae1461976 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index f266555b086..d112856b953 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 241eb954e2b..e6f017a50b2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index f069d8c2da4..a1dd3363281 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.md index eaa30f6196f..3937beeb43e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 9e5c8a06871..6c2c64dc6ba 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 7151188f85a..5deea5af5c6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 111a7b339d0..0d671451bca 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index 7d26c4b94bd..7a68be4e477 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.md index cf602d09778..22677f12098 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 8a66a5b25c7..35979ce3e51 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`qiskit.algorithms.minimum_eigensolvers.VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQEResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.md index 29caff17444..347cc7a82ec 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.md index 65fa59ebbed..427b4374d2a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/aqgd.py "view source code") +`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.md index 4de4e0e5852..0458155fc11 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.md index b29803aece4..9ee6586b4e1 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.md index bf3d7b248dc..79b10a92472 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/cg.py "view source code") +`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.md index 5efae1d656e..d296832bce2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/cobyla.py "view source code") +`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.md index edefeb1c72a..71372d0fc9e 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`qiskit.algorithms.optimizers.CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`qiskit.algorithms.optimizers.CRS(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.md index 9a6af11a6dc..57fe7ecb35c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index c45a5f38af2..e1d975cffd2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.md index 2de46484a51..bdb6dd2879f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`qiskit.algorithms.optimizers.ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`qiskit.algorithms.optimizers.ESCH(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.md index 3b9f13d11e5..1073fcc75cf 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/gsls.py "view source code") +`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.md index e4cb77abde0..2cda02b4bc2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.md index 1a51659e5f3..99f918c1ed3 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.md index 5f76666454b..026e63925f8 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/imfil.py "view source code") +`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.md index 35d441762c2..bf3c0e127f2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`qiskit.algorithms.optimizers.ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`qiskit.algorithms.optimizers.ISRES(max_evals=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.md index cc4d6827eca..d59656c81ca 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.md index c3a47c88765..a7f01d86745 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.md index 8bf81017151..b41648b0bb5 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.md index ef9ae30b9c6..1fc7a2b2828 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nft.py "view source code") +`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.md index e07f5219c90..a9d2ddb922f 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`qiskit.algorithms.optimizers.Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Optimizer` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.md index 66a6e2e79a6..7f296b79205 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`qiskit.algorithms.optimizers.OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerResult` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.md index b36bf8e5e1f..294e2bb0053 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index ad2e1630865..779efd40725 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.md index 7a464de5968..002da5968d4 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/powell.py "view source code") +`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.md index 301ba90656a..bfafc9c2f28 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.P_BFGS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.md index 995b4054ddf..29c2eafa5d0 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.md index c88001815d6..62f47201435 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/slsqp.py "view source code") +`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.md index aa863c5332e..a14fb658fdb 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/snobfit.py "view source code") +`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.md index b54d9c6e73d..9603aae47fe 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/spsa.py "view source code") +`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.md index ee2ab0af1a6..676fb506e5b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.md index e121b675a63..8c5456685e2 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.md index 4d9718336d5..7d008b55820 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/tnc.py "view source code") +`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.md index 18be7da16fd..1d047bef72c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.md index 73efcb24dea..f3897857270 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/umda.py "view source code") +`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 911e13ad1b8..d8650216c4b 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index a3722fff2cd..681ab77086a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`qiskit.algorithms.state_fidelities.BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`qiskit.algorithms.state_fidelities.BaseStateFidelity` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.md index 7c8c07acfcf..0f6dce9670c 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.md index 3450e82de80..01f5737aca6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index a30f0e6fe83..41a36113213 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index 9d255fb58e7..64e6a8dbb58 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `OdeSolver` diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index f3460cb2fab..50e2c47dafe 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index a7c8270ca0a..b8a0f331f20 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index 0de5c9639eb..c09f2bddba6 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 28e79ff4d8b..33ef7841937 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 72959fe10f1..48a5847c07a 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.46/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.md index 798708002db..0040cb7460a 100644 --- a/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.46/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/run_config.py "view source code") +`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/assembler/run_config.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.md index 7ccf1c31b79..06fd71d2e11 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`qiskit.circuit.AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.md index 0fa6e148b76..64c3ba63dc9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.md b/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.md index 018298ea0b8..e16aec5b7c8 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.AnnotatedOperation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation -`qiskit.circuit.AnnotatedOperation(base_op, modifiers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.AnnotatedOperation(base_op, modifiers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Bit.md b/docs/api/qiskit/0.46/qiskit.circuit.Bit.md index 41f0b585135..cee1af82579 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`qiskit.circuit.Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/bit.py "view source code") +`qiskit.circuit.Bit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/bit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.md index 33dab1d1251..d5e196308bd 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/break_loop.py "view source code") +`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.md index e5140ee8a61..39138054928 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumcircuitdata.py "view source code") +`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.md index b0c1e06d474..9f083bf9387 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.46/qiskit.circuit.Clbit.md index ad65b20f0ba..3dd395f2546 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`qiskit.circuit.Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.md b/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.md index 427805ee99f..eb8a4aff095 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.CommutationChecker.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CommutationChecker -`qiskit.circuit.CommutationChecker`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/commutation_checker.py "view source code") +`qiskit.circuit.CommutationChecker` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/commutation_checker.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.md index 460051fc9da..3e4a6952f88 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/continue_loop.py "view source code") +`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.md index 91164e88d20..ec33b953f21 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/control_flow.py "view source code") +`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.md b/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.md index f63c8349a84..18ea8058926 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ControlModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlModifier -`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.md index 64cc909aad8..dc58daaf51d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlledgate.py "view source code") +`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlledgate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Delay.md b/docs/api/qiskit/0.46/qiskit.circuit.Delay.md index 462efb32895..23d0b56c3b4 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`qiskit.circuit.Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/delay.py "view source code") +`qiskit.circuit.Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/delay.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.md index 80500c5be3e..bea4ebd383f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`qiskit.circuit.EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/equivalence.py "view source code") +`qiskit.circuit.EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/equivalence.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.md index 6c2f2b3120e..50d10915243 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/for_loop.py "view source code") +`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Gate.md b/docs/api/qiskit/0.46/qiskit.circuit.Gate.md index 910d4f5d9b0..7dca956e761 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/gate.py "view source code") +`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/gate.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.md index 3df61193c64..aea8b2f5235 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/if_else.py "view source code") +`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.46/qiskit.circuit.Instruction.md index 84594a70898..355e6fa0cfd 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/instruction.py "view source code") +`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/instruction.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.md index 63441668f32..e51d89cb7e3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`qiskit.circuit.InstructionSet(*, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/instructionset.py "view source code") +`qiskit.circuit.InstructionSet(*, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/instructionset.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.md b/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.md index 49503610b12..e0af26fb490 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.InverseModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InverseModifier -`qiskit.circuit.InverseModifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.InverseModifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Operation.md b/docs/api/qiskit/0.46/qiskit.circuit.Operation.md index 5b691c8f996..742115d4cc6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`qiskit.circuit.Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/operation.py "view source code") +`qiskit.circuit.Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/operation.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.46/qiskit.circuit.Parameter.md index 16db09dd992..cb781a2aa99 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`qiskit.circuit.Parameter(name, *, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/parameter.py "view source code") +`qiskit.circuit.Parameter(name, *, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/parameter.py "view source code") Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.md index b151f6fa9c4..d8cd9bcb4d1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`qiskit.circuit.ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/parameterexpression.py "view source code") +`qiskit.circuit.ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/parameterexpression.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.md index 3ba494c36aa..66ea9b36a7e 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`qiskit.circuit.ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/parametervector.py "view source code") +`qiskit.circuit.ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/parametervector.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.md b/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.md index d05c37059a4..b68ad18e548 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.PowerModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.PowerModifier -`qiskit.circuit.PowerModifier(power)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.PowerModifier(power)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md index d1485cfbc8e..592462947a8 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumcircuit.py "view source code") +`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.md index 009b411b508..e531a2d1cf4 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.46/qiskit.circuit.Qubit.md index 4eec17a136b..91354066900 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`qiskit.circuit.Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/quantumregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.Register.md b/docs/api/qiskit/0.46/qiskit.circuit.Register.md index 6b95a843580..6b1f6ba2316 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.Register.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`qiskit.circuit.Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/register.py "view source code") +`qiskit.circuit.Register(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/register.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.md index 3d24cb66b1a..b18d02fb99a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/switch_case.py "view source code") +`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/switch_case.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.md index f850b0a6671..b683b4d7120 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`qiskit.circuit.WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/while_loop.py "view source code") +`qiskit.circuit.WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.md index 7cc37760ed2..ae2bb2a1fa0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.md index 44a8ab5b1a7..85af87f8d68 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 94b9c516a35..76703b4d5b3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index e9d783380b1..7ecb67bc6b9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.46/qiskit.circuit.library.AND.md index 612e6a9994f..b1165e019fe 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.md index dcc73097c35..0cabe95c4ad 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`qiskit.circuit.library.Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/barrier.py "view source code") +`qiskit.circuit.library.Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/barrier.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.md index 4afb068188b..6bf2a7f0729 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.md index b36568887b0..dbc17e34b6a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.md index 6df286171a5..88772efee5f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.md index 0c6169baeae..20f59328441 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.md index 53fd3661a21..e31af5fdc13 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.md index d21cd10c0f7..ae8dd09be68 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.md index 8093f61659f..b36af0a6ceb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.md index caa15cce20f..ad3e8203b90 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.md index b9ebc221b24..2a574872abc 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.md index 5e5413f5c56..0502b19e8c6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.md index 3ecf0b95ed1..50b081d5993 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.md index 0d73e333043..3eaa89eb593 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.md index 19647b1c8f3..20df29e1390 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.md index 839c7f3565e..a0c0e3765d9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.md index 344ad69c3f1..17ab2aa140f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.md index 589b7e5fe13..95cc7219176 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.md index 1e97d6be50e..30f34f437d9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.md index dc2e6b48a14..7a99f8d58a6 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.md index 9aac3159491..58fca321e4f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.md index 99228a9d25c..961100cd7fc 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.md index 01d2b7e0f3e..44c9c0023dc 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.md index c2e34acbfd6..346620c2e88 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.md index 2d0660b1c8b..e37d31ff2ab 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`qiskit.circuit.library.Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.md index 33fd6d7b987..193729472b1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.DiagonalGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate -`qiskit.circuit.library.DiagonalGate(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.DiagonalGate(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.md index 1075c4a53a2..6d20f87d340 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.md index 6338fdb1fe9..06e1c8503cf 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.md index a510dad5833..4da6c065b28 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.md index a689c6d8fe3..ef5b27567cd 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.md index f21867e703e..69fdc72c9ef 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.md index c753ee5bd58..3a296d5b057 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.md index 934e100e187..2d4ee00a67a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`qiskit.circuit.library.FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/fourier_checking.py "view source code") +`qiskit.circuit.library.FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.md index 1684121a616..b6a8d2ddb73 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.md index 5f3778d8236..5a98467d9f7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`qiskit.circuit.library.GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GR.md index 05a546b6989..e48e37a1a34 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`qiskit.circuit.library.GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.md index 97ceb86234e..9ba49722564 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`qiskit.circuit.library.GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.md index ebbf81c46f2..7f425e40313 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`qiskit.circuit.library.GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.md index b0e9595effa..48fc7d21165 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`qiskit.circuit.library.GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.md index b3e0d99bcf4..9c8de2aabba 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.md index 38157921792..8c0fb40d48c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`qiskit.circuit.library.GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/graph_state.py "view source code") +`qiskit.circuit.library.GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/graph_state.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.md index 90d206d52b4..447cc8979f7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/grover_operator.py "view source code") +`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.md index 5c77f0b5226..99bd0e62ac7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.md index c81fb1044d6..33b3d4f0c53 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.md index 238f01bb122..17a96289919 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate -`qiskit.circuit.library.HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/hamiltonian_gate.py "view source code") +`qiskit.circuit.library.HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/hamiltonian_gate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.md index fd6852f11f6..60f0304ac0e 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/hidden_linear_function.py "view source code") +`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.md index 8616cf72a7d..38b7c9dd5eb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/i.py "view source code") +`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.md index 7dc7738ae27..e955ba99b32 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`qiskit.circuit.library.IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/iqp.py "view source code") +`qiskit.circuit.library.IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/iqp.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.md index 61548344e8d..cf84ab4a4ea 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Initialize -`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/initializer.py "view source code") +`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/initializer.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.md index 19811da0aa3..e337ea0b37a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`qiskit.circuit.library.InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`qiskit.circuit.library.InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.md index adf614c8b63..425687fe10d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.md index 01f4b2657e9..5155d875783 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Isometry.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Isometry -`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/isometry.py "view source code") +`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/isometry.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.md index 62fa6a465d5..0bb812e0e24 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.md index 626008c96ca..e836ee223dd 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`qiskit.circuit.library.LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`qiskit.circuit.library.LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.md index 791c681ac04..65f9a99d584 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.md index 4b1d0dfad2b..fe97ff7c6f1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.md index 56c154d4f78..e1d43b82ec2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.md index 9b66055be80..40b9655bf2c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.md index e4b71c94a71..44178e0f434 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.md index 4e02d35a033..d526ebec375 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.md index f4aaa5c9e3f..ae895bba386 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.md index ad8646ee796..3d38d8e14c7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.md index 7da50cb3367..47d6f0a272a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.md index bc7e942ea5c..e487c2ecd25 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`qiskit.circuit.library.Measure(label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/measure.py "view source code") +`qiskit.circuit.library.Measure(label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/measure.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.md index fc3277f1b2f..dadf5d38a1c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/n_local.py "view source code") +`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.46/qiskit.circuit.library.OR.md index 1dd502a2a2f..45fc2b7ffc3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.md index 985bd6ab6ee..9c001dbfe7c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/pauli_evolution.py "view source code") +`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.md index 8ee9fc54600..c74ba9103b4 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.md index 81b9602d8bc..21799a2a82b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`qiskit.circuit.library.PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`qiskit.circuit.library.PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.md index 282be122251..b4c4e968add 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.md index 67683df9d9f..6b3f241229e 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.md index 469398a0091..a2b967d4d9b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`qiskit.circuit.library.PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.md index ee66766b1eb..66c9c850670 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/phase_estimation.py "view source code") +`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.md index 0d5ed6963c0..edf4ec03c6c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.md index 417bd3cacce..ceee4cad04a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/phase_oracle.py "view source code") +`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.md index 67e2a5ceb11..653318b88bb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 27872c7ab47..c406805b7ae 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 8899b5cde63..3581fd394af 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.md index 758cda3a6d2..dedc696462c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.md index d25abeacc79..69f5f191da2 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.md index d8e18d99d3c..a5599dc834d 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/basis_change/qft.py "view source code") +`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.md index 385b536442b..f7a00eb9383 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.md index 620a6ab7643..6c93fa863d1 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/quantum_volume.py "view source code") +`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.md index d4617ce80b3..8cc032a97f3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.md index 3c9d4e88933..db0abf00425 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.md index 831bf1e42b8..6c123f2fee5 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.md index d96f8b9f6fe..325077a68f9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/r.py "view source code") +`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.md index 15a56da24df..a1f2a746ebb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.md index 65b3ef7a476..f7a9ade98d7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.md index bcf4ffee144..51d6d66c240 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.md index 3ae272d4b0a..f6456344eae 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.md index 6fc935d7584..5e6884583b3 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.md index 715fbfb6b2f..8fb57074f50 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.md index 06caff0f53f..3f68da61a65 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.md index 793ed5c02b1..d8e535fd3ba 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.md index d30a05b728c..ed50decda00 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.md index e4a701a60dd..d36f8417002 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`qiskit.circuit.library.Reset(label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/reset.py "view source code") +`qiskit.circuit.library.Reset(label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/reset.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.md index e728a415e31..8f639a6b6c9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.md index 9dbd8e82f2e..4c383b184a9 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.md index 849043ed5d1..72770d4aea0 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.md index 1607bf2903c..a52b63c02ca 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.md index f5454e0cd7e..fbcad231a86 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.md index 79b2c2e8936..aa94b921155 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.md index 09bf8711113..b4b643a4903 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.md index 952b408560e..3da0c36014b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.md index 9b04820924e..fe3734d720c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/two_local.py "view source code") +`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.md index 5d7b438b452..1cfe2ba5eac 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.md index c0cd19dcdfc..8d2a3a83a2f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u2.py "view source code") +`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.md index e9f4b5fa741..c47c9a93c89 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.md index 7170576bad6..ae5a1342c10 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCGate -`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/uc.py "view source code") +`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/uc.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.md index f9961b5a124..2bf3985412a 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate -`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") +`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.md index 4ea350c9129..74018de808b 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRXGate -`qiskit.circuit.library.UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") +`qiskit.circuit.library.UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.md index 8a1b9e170dd..2e956a04838 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRYGate -`qiskit.circuit.library.UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/ucry.py "view source code") +`qiskit.circuit.library.UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/ucry.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.md index 68a6143098a..d5b171d6685 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRZGate -`qiskit.circuit.library.UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") +`qiskit.circuit.library.UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.md index 422fe3c621d..59091d67e21 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.md index 8b59d6c0cac..c03f12b747c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate -`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/unitary.py "view source code") +`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/generalized_gates/unitary.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.md b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.md index 4fcb29c8820..5d49b9901ef 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.UnitaryOverlap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap -`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/overlap.py "view source code") +`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/overlap.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.md index 95cb4888005..a12d4222e1f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.md index e9f59f146c8..6d13ac210fe 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.md index 525f90e33cb..b13a09d2da7 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.md index b562f42ad8f..5062454fdab 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.md index 2d02a88ff8a..dd2aa5b2a7f 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.md index 43752c4f975..55ed5b97366 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.md index cc275fc50c0..44f164352bb 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.md index c7ba5263343..7cf93325b92 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.md index fa9f5ea4899..005586b44ee 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.md index ab8b04d733d..0abcc39bf1c 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.md index 877beaf25b4..78b6d0d8220 100644 --- a/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.46/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.md index 19f6d1074ea..eb01b3eaa33 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`qiskit.dagcircuit.DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagcircuit.py "view source code") +`qiskit.dagcircuit.DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.md index de783da0179..15ceb974cd8 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagdepnode.py "view source code") +`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.md index dfa87146fa4..4ccfb1b7822 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`qiskit.dagcircuit.DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagdependency.py "view source code") +`qiskit.dagcircuit.DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagdependency.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.md index b8d32d60992..ee880f07886 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`qiskit.dagcircuit.DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.md index 5f8679d3a11..1aba7bff304 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`qiskit.dagcircuit.DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGNode(nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.md index bcef359289d..a7ef2b3e72b 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.md index e74b7d0f66a..06dd37a740c 100644 --- a/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.46/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`qiskit.dagcircuit.DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.md index 618f334a443..e4cc74ea008 100644 --- a/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.46/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/extensions/quantum_initializer/squ.py "view source code") +`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.md index 6aa4e04a085..2ec389a92db 100644 --- a/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.46/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/extensions/simulator/snapshot.py "view source code") +`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.md index 9cb5f188870..c1c478ddf81 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`qiskit.opflow.OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/operator_base.py "view source code") +`qiskit.opflow.OperatorBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/operator_base.py "view source code") Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.md index 2061204b164..7f30a2b6e4a 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`qiskit.opflow.converters.AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/abelian_grouper.py "view source code") +`qiskit.opflow.converters.AbelianGrouper(traverse=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.md index 0c2cdb7cccd..09fcfcc6efd 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/circuit_sampler.py "view source code") +`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.md index 018e0dd800f..1e59c8f90de 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`qiskit.opflow.converters.ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/converter_base.py "view source code") +`qiskit.opflow.converters.ConverterBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/converter_base.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.md index 2ee3d728f50..9ed01617ce8 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.md index be2c8656853..aec6ad06562 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.md index 4fb8b3aebfa..abfdaf39952 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`qiskit.opflow.converters.TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`qiskit.opflow.converters.TwoQubitReduction(num_particles)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.md index d1acbdd63fd..a37dd95e7e7 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`qiskit.opflow.evolutions.EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/evolution_base.py "view source code") +`qiskit.opflow.evolutions.EvolutionBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.md index 5893c606076..dfa7bd7be08 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`qiskit.opflow.evolutions.EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`qiskit.opflow.evolutions.EvolutionFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.md index 991107e42e4..ca916a7ac76 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/evolved_op.py "view source code") +`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.md index 2314e9f47a2..9d75e7ed41b 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`qiskit.opflow.evolutions.MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`qiskit.opflow.evolutions.MatrixEvolution` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 789f15d0a5e..0db7b414d0f 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.md index efb089f3120..c85713cd663 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`qiskit.opflow.evolutions.QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`qiskit.opflow.evolutions.QDrift(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.md index 4b73ffa457f..386a8189c22 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.md index 54c4cd95666..13d39d7fb96 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`qiskit.opflow.evolutions.Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`qiskit.opflow.evolutions.Trotter(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.md index df4299e6e1a..b17807940a0 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`qiskit.opflow.evolutions.TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`qiskit.opflow.evolutions.TrotterizationBase(reps=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.md index 34f6052a78b..1352e5c90b8 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`qiskit.opflow.evolutions.TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`qiskit.opflow.evolutions.TrotterizationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.md index c953da7ecdd..208079ed0df 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`qiskit.opflow.expectations.AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`qiskit.opflow.expectations.AerPauliExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.md index 5df1539ef46..ade862ac0be 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.md index d5ddd286108..3314a5f4af9 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`qiskit.opflow.expectations.ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/expectation_base.py "view source code") +`qiskit.opflow.expectations.ExpectationBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.md index 4f2df062d28..df0292fb608 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`qiskit.opflow.expectations.ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/expectation_factory.py "view source code") +`qiskit.opflow.expectations.ExpectationFactory` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.md index a2d9345e208..b4ecb044a33 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`qiskit.opflow.expectations.MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`qiskit.opflow.expectations.MatrixExpectation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.md index b1aee536e3b..fbaa914900f 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.md index 65d2d429cec..6014e723a22 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`qiskit.opflow.gradients.CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`qiskit.opflow.gradients.CircuitGradient` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.md index faf06323354..ee5bb72bd37 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`qiskit.opflow.gradients.CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`qiskit.opflow.gradients.CircuitQFI` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.md index b8d8c50415c..e29f8cf093f 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`qiskit.opflow.gradients.DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/derivative_base.py "view source code") +`qiskit.opflow.gradients.DerivativeBase` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.md index 885c06ef981..79514e2fd3b 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/gradient.py "view source code") +`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.md index ca5fac01841..645c8a4456e 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/gradient_base.py "view source code") +`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.md index 7ec267a1205..3d63f3985ff 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/hessian.py "view source code") +`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.md index 5b748e0e0fe..fa202cdf5be 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/hessian_base.py "view source code") +`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.md index d894df8caba..f938ce92552 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/natural_gradient.py "view source code") +`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.md index eab7417bdc2..89125f5e52d 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/qfi.py "view source code") +`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.md index 552b5165d0f..8214d750074 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/qfi_base.py "view source code") +`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.md index 19c3f912911..7dc5456e5df 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/composed_op.py "view source code") +`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.md index be84b38a21d..8e5efbb2019 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/list_op.py "view source code") +`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.md index 0fe3009f156..85f573859f1 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/summed_op.py "view source code") +`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.md index bea4f8dcec2..c2e43fbcb73 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/tensored_op.py "view source code") +`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.md index 749d22e0a5d..ca7bda9fa8e 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.md index 5d2829aa22b..0c7371e26c1 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.md index b199d43267a..d109aa45ed4 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.md index 20776cec8f6..7e6e94ab547 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.md index 65736076e39..d5bac78d989 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index ab1b0c6ac54..0b6af4de7ae 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.md index 6584875379a..9e7dc2cc328 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.md index cec5387bd2d..9ec483aa663 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.md index 79358a9611d..85679271b7e 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.md index b147143c283..bc6ae517937 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.md index 081f30b6006..e25ac4d0806 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.md index 66570accf44..5d744c0eb37 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.md index f16bc314acd..95dfd295f8c 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/state_fn.py "view source code") +`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.md index c34f2bce9be..fe06a366c5c 100644 --- a/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.46/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.md b/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.md index e7c19d26414..5f0f0e906ce 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.BaseController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BaseController -`qiskit.passmanager.BaseController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.BaseController(options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.md b/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.md index a5a9ca4523b..2b56708963c 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.BasePassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BasePassManager -`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/passmanager.py "view source code") +`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/passmanager.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.md b/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.md index d889dfc2896..904d0470939 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.ConditionalController -`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.md b/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.md index 20ce34f6c77..57439793ed3 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.DoWhileController -`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.md b/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.md index d8618608998..019ca5c0c9c 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowController -`qiskit.passmanager.FlowController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowController(options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.md b/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.md index 78c2403a6cc..3c9257dd640 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.FlowControllerLinear.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear -`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.md b/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.md index 20f324c196d..6194803cd44 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.GenericPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.GenericPass -`qiskit.passmanager.GenericPass`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.GenericPass` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.md b/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.md index 4d876b0c43d..0670f2858de 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.PassManagerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PassManagerState -`qiskit.passmanager.PassManagerState(workflow_status, property_set)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PassManagerState(workflow_status, property_set)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.md b/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.md index 735c0e8b0b3..40e739fb35f 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PropertySet -`qiskit.passmanager.PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/compilation_status.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.md b/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.md index 9b1711c7bc8..33023a7403b 100644 --- a/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.md +++ b/docs/api/qiskit/0.46/qiskit.passmanager.WorkflowStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus -`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.md index 698aae34ecd..86e849fd92d 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/backend_estimator.py "view source code") +`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/backend_estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.md index b10f1c3958e..3fa7e347b82 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/backend_sampler.py "view source code") +`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/backend_sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.md index e1a0f4cdf54..8df0bc660c5 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`qiskit.primitives.BaseEstimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/base_estimator.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.md index a2634c0d2c9..496615e589b 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`qiskit.primitives.BaseSampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/base_sampler.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/0.46/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.46/qiskit.primitives.Estimator.md index 997c9dcd96d..dbbeca70895 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`qiskit.primitives.Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/estimator.py "view source code") +`qiskit.primitives.Estimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/estimator.py "view source code") Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.md index 3ef9672c1ca..e7f42225aa6 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`qiskit.primitives.EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/estimator_result.py "view source code") +`qiskit.primitives.EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/estimator_result.py "view source code") Bases: `_BasePrimitiveResult` diff --git a/docs/api/qiskit/0.46/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.46/qiskit.primitives.Sampler.md index e37a1dde922..a0452e0959c 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`qiskit.primitives.Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/sampler.py "view source code") +`qiskit.primitives.Sampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/sampler.py "view source code") Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.md index 0cc0ee6acda..8d96ca11a06 100644 --- a/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.46/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`qiskit.primitives.SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/sampler_result.py "view source code") +`qiskit.primitives.SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/sampler_result.py "view source code") Bases: `_BasePrimitiveResult` diff --git a/docs/api/qiskit/0.46/qiskit.providers.Backend.md b/docs/api/qiskit/0.46/qiskit.providers.Backend.md index ccc88952e78..c56b805972d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.46/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`qiskit.providers.Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") +`qiskit.providers.Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.46/qiskit.providers.BackendV1.md index 535cb868e57..1d339a6423c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.46/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`qiskit.providers.BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.46/qiskit.providers.BackendV2.md index a7b0012d7b0..2e01ef29f75 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.md index 639851eb89f..ac30a5ef5a3 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.46/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend_compat.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.Job.md b/docs/api/qiskit/0.46/qiskit.providers.Job.md index 9942bfc73fd..767e41e7c09 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.46/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`qiskit.providers.Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/job.py "view source code") +`qiskit.providers.Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/job.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.46/qiskit.providers.JobStatus.md index 90d8f04f89c..a209cc338da 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.46/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`qiskit.providers.JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/jobstatus.py "view source code") +`qiskit.providers.JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/jobstatus.py "view source code") Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.JobV1.md b/docs/api/qiskit/0.46/qiskit.providers.JobV1.md index ae761dec4f1..49976b4ba15 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.46/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`qiskit.providers.JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/job.py "view source code") +`qiskit.providers.JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/job.py "view source code") Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.Options.md b/docs/api/qiskit/0.46/qiskit.providers.Options.md index a2e57a2bf0a..2c1cfdd6ac2 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.46/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`qiskit.providers.Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/options.py "view source code") +`qiskit.providers.Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/options.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.Provider.md b/docs/api/qiskit/0.46/qiskit.providers.Provider.md index 5fd5f851fa3..004a42381e0 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.46/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`qiskit.providers.Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/provider.py "view source code") +`qiskit.providers.Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/provider.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.md index fe8f1f180f4..9eee8f6b864 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.46/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`qiskit.providers.ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/provider.py "view source code") +`qiskit.providers.ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/provider.py "view source code") Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.md index 18e1359e16f..7ccc47b3f5f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.46/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") +`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.md b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.md index ca72ea48800..ba82014c944 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider -`qiskit.providers.basic_provider.BasicProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/basic_provider.py "view source code") +`qiskit.providers.basic_provider.BasicProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/basic_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.md b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.md index 46cc6dc012c..f5083b7ceb0 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError -`qiskit.providers.basic_provider.BasicProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/exceptions.py "view source code") +`qiskit.providers.basic_provider.BasicProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/exceptions.py "view source code") Base class for errors raised by the Basic Provider. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.md b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.md index 1a4b9701207..be6034a4059 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicProviderJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob -`qiskit.providers.basic_provider.BasicProviderJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/basic_provider_job.py "view source code") +`qiskit.providers.basic_provider.BasicProviderJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/basic_provider_job.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.md b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.md index 14de5eb5476..ae9d0f81d9d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basic_provider.BasicSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator -`qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/basic_simulator.py "view source code") +`qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basic_provider/basic_simulator.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.md index 0e74ac66148..252a25052f3 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`qiskit.providers.basicaer.BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/exceptions.py "view source code") +`qiskit.providers.basicaer.BasicAerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.md index f8372e79924..7cd6ec2308d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/basicaerjob.py "view source code") +`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.md index 1bdd93c0dd3..dc40281d239 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`qiskit.providers.basicaer.BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`qiskit.providers.basicaer.BasicAerProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.md index 8f0509d3e0f..dbaf0ffde5e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.md index e5d497bd128..20c286a1757 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.md index 4d5d7072197..03f6166ae92 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.46/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.46/qiskit.providers.convert_to_target.md index 4aa5d43ca88..88179cdcbce 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.46/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 2b03224f790..3f6ea51aa0f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.md index 9ef881f6829..3e01d7a7187 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`qiskit.providers.fake_provider.Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_1q.py "view source code") +`qiskit.providers.fake_provider.Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.md index 1385b9c5aab..6758b5c0697 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`qiskit.providers.fake_provider.FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.md index 17f74a5a3f1..907b89b2b0f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`qiskit.providers.fake_provider.FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.md index 70431733e45..1773569a47e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`qiskit.providers.fake_provider.FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonk` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.md index 1f44ae9d5d9..4b618774f15 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`qiskit.providers.fake_provider.FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.md index 59d36f40174..037ae36e97d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`qiskit.providers.fake_provider.FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthens` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.md index 964b921ba2f..32c4e7a6f73 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`qiskit.providers.fake_provider.FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.md index 1e13aa93a2b..d7a6f7900cc 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`qiskit.providers.fake_provider.FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`qiskit.providers.fake_provider.FakeAuckland` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.md index 93692e95f3d..ee3080d0288 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.md index 90dd892bc01..f703ab1aa45 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`qiskit.providers.fake_provider.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.md index 9e078dab5cd..e345c0188e8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`qiskit.providers.fake_provider.FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelem` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.md index 698ed317683..94b8a60ba53 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`qiskit.providers.fake_provider.FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.md index cc48009f431..6a56d6f0d0c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`qiskit.providers.fake_provider.FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.md index a48f4755d12..5ae46594aa1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`qiskit.providers.fake_provider.FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.md index 6ff305d3757..721a16b40af 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`qiskit.providers.fake_provider.FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogota` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.md index 4eac6b1bd8a..83b31af4847 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`qiskit.providers.fake_provider.FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.md index 2daad89ac54..883e7e4e90e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`qiskit.providers.fake_provider.FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.md index a1361bfdc70..7f4100e7d72 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`qiskit.providers.fake_provider.FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.md index c25f28d6cff..a44566bb56f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`qiskit.providers.fake_provider.FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.md index 0430794cfdf..51778ab3914 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`qiskit.providers.fake_provider.FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.md index bd142ad5068..618a4ae2729 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`qiskit.providers.fake_provider.FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.md index 36a4d8d5069..bc8446e3643 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`qiskit.providers.fake_provider.FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.md index 5640ec9a5f9..acbc23fa292 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`qiskit.providers.fake_provider.FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridge` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.md index c0ab5a7d81b..59ffb3439e1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`qiskit.providers.fake_provider.FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.md index d80410150a7..8c511b5636b 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`qiskit.providers.fake_provider.FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.md index 58025f7fd6e..2bbb001fdba 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`qiskit.providers.fake_provider.FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.md index 21fa2f931f9..fd49b360147 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`qiskit.providers.fake_provider.FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssex` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.md index a9438bad9a8..a3946247383 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`qiskit.providers.fake_provider.FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.md index 980ec95e6b4..8aec4b8d35c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`qiskit.providers.fake_provider.FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`qiskit.providers.fake_provider.FakeGeneva` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.md index 130768b8213..0d7d9345ead 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`qiskit.providers.fake_provider.FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.md index 33b4015eb5f..79105e4214e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`qiskit.providers.fake_provider.FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.md index 9d90f359eb3..39c06c7691b 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`qiskit.providers.fake_provider.FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.md index 539551b2173..265df9fd75d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`qiskit.providers.fake_provider.FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.md index 420185985bc..bdfa6d37bf4 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`qiskit.providers.fake_provider.FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakarta` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.md index 0729c1f5e2d..a33e8ce8adb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`qiskit.providers.fake_provider.FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.md index 7fb9dc3027a..ed23bd2f4eb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`qiskit.providers.fake_provider.FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.md index dc7d1d3b773..d9bd6aa8224 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`qiskit.providers.fake_provider.FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.md index f3e357bc796..9a249968247 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`qiskit.providers.fake_provider.FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkata` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.md index 42593e480b5..cecbfd9e69d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`qiskit.providers.fake_provider.FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.md index f729a96ed89..8108ce10e67 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`qiskit.providers.fake_provider.FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagos` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.md index bdb89acb1be..1cdefdc678b 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`qiskit.providers.fake_provider.FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.md index 8aa123e9440..84c2a3e1741 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`qiskit.providers.fake_provider.FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLima` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.md index eea49f07e50..5f51b6f961a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`qiskit.providers.fake_provider.FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.md index 60a91aedcb2..37009621ded 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`qiskit.providers.fake_provider.FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.md index fcfc6e7f841..c7e78d83005 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`qiskit.providers.fake_provider.FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.md index 9a32e0955b1..b4a0de6cf19 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`qiskit.providers.fake_provider.FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattan` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.md index 134433b9922..4232730bebc 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`qiskit.providers.fake_provider.FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.md index 06cb7ea89e5..6ab2614ad9d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`qiskit.providers.fake_provider.FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManila` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.md index 9e044312a50..6bb8dbf3462 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`qiskit.providers.fake_provider.FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.md index b4d052ae9f9..90fb48b481a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`qiskit.providers.fake_provider.FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.md index 11b800978cb..a4fac739293 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`qiskit.providers.fake_provider.FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.md index c9bdc9f6fea..37a8b67f7f2 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`qiskit.providers.fake_provider.FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontreal` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.md index bdcad22bb37..3fa428ccc8a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`qiskit.providers.fake_provider.FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.md index 81126024ae9..07be1889cf1 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`qiskit.providers.fake_provider.FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbai` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index cde6caefb53..a1febc09fbb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`qiskit.providers.fake_provider.FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiFractionalCX` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.md index ea0c4ac6fed..e2516549e4d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`qiskit.providers.fake_provider.FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.md index 86b26188dd9..28e2cff8ea9 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`qiskit.providers.fake_provider.FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobi` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.md index 03ae5c94179..5c45139c700 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`qiskit.providers.fake_provider.FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 6ab944e6a7d..14acc15a068 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`qiskit.providers.fake_provider.FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index bcc6a63fe3e..1b58307bd2c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`qiskit.providers.fake_provider.FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.md index df4b4cde628..f064fd20d13 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`qiskit.providers.fake_provider.FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`qiskit.providers.fake_provider.FakeOslo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.md index f535ff5aeb3..9f180df9a4e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`qiskit.providers.fake_provider.FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurense` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.md index 6730e7e50e4..ad7d062b156 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`qiskit.providers.fake_provider.FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.md index 20ccdcdc055..94648d56047 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`qiskit.providers.fake_provider.FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.md index 8b0eb62da97..45555a2d3ca 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`qiskit.providers.fake_provider.FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParisV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.md index ca06118ac85..788b8a9db61 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`qiskit.providers.fake_provider.FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`qiskit.providers.fake_provider.FakePerth` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.md index 91befe7582d..0a3dfa2f7b9 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`qiskit.providers.fake_provider.FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 779bf664d49..34b668a979a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`qiskit.providers.fake_provider.FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.md index 22450b68075..1765617dfdc 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`qiskit.providers.fake_provider.FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`qiskit.providers.fake_provider.FakePrague` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.md index 47b41df93e9..cb3016f3c63 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`qiskit.providers.fake_provider.FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index 1bbe6ba104b..73433d5a37a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`qiskit.providers.fake_provider.FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.md index 511d6fe0daf..ad25cac23af 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`qiskit.providers.fake_provider.FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`qiskit.providers.fake_provider.FakeQasmSimulator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.md index e953171ce47..781a0fe024c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`qiskit.providers.fake_provider.FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuito` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.md index 85ec0362f1d..c7dadcafda6 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`qiskit.providers.fake_provider.FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.md index 684a4621b06..e1cd0274d75 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`qiskit.providers.fake_provider.FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochester` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.md index 99310cceab1..6d4c2e334f5 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`qiskit.providers.fake_provider.FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.md index e5324286dc8..39811b9129c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`qiskit.providers.fake_provider.FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRome` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.md index 62569343ac7..4cf69e67e6c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`qiskit.providers.fake_provider.FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.md index 28d30da9586..383fc0bd587 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`qiskit.providers.fake_provider.FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`qiskit.providers.fake_provider.FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.md index f373872433c..244b231564e 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`qiskit.providers.fake_provider.FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiago` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.md index c08f0dd9a2d..8f281738165 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`qiskit.providers.fake_provider.FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.md index 901be28c8fa..c868559156a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`qiskit.providers.fake_provider.FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`qiskit.providers.fake_provider.FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.md index dfa5cd48049..ef9e9b24156 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`qiskit.providers.fake_provider.FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingapore` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.md index 4b4aad914fe..0041fe32670 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`qiskit.providers.fake_provider.FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.md index 2532377b573..414a63afbe0 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`qiskit.providers.fake_provider.FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydney` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.md index 0c828f8a2d7..0de1b7e28ef 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`qiskit.providers.fake_provider.FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.md index e025630f306..7248538b3bb 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`qiskit.providers.fake_provider.FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`qiskit.providers.fake_provider.FakeTenerife` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.md index ee77b3b6054..5b1f73111ae 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`qiskit.providers.fake_provider.FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`qiskit.providers.fake_provider.FakeTokyo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.md index ae7fdf5a175..88c87924e75 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`qiskit.providers.fake_provider.FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeToronto` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.md index 67871fc518c..aba84a574b7 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`qiskit.providers.fake_provider.FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.md index 9bf65823108..543603133db 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`qiskit.providers.fake_provider.FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValencia` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.md index 571138ae955..5634402598a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`qiskit.providers.fake_provider.FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.md index 08f64890972..0abcf40c065 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`qiskit.providers.fake_provider.FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigo` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.md index e19d42947ad..5be35e8db60 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`qiskit.providers.fake_provider.FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.md index 692a131d72b..901e2c8b9da 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`qiskit.providers.fake_provider.FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashington` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.md index bb1b48fc453..e9a461b2872 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`qiskit.providers.fake_provider.FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.md index 3806c7e9427..517d5a77921 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`qiskit.providers.fake_provider.FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktown` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.md index 631b917e9df..6f6c07cb33a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`qiskit.providers.fake_provider.FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.md b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.md index afa45f5f975..54975a77e0f 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.md +++ b/docs/api/qiskit/0.46/qiskit.providers.fake_provider.GenericBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 -`qiskit.providers.fake_provider.GenericBackendV2(num_qubits, basis_gates=None, *, coupling_map=None, control_flow=False, calibrate_instructions=None, dtm=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/generic_backend_v2.py "view source code") +`qiskit.providers.fake_provider.GenericBackendV2(num_qubits, basis_gates=None, *, coupling_map=None, control_flow=False, calibrate_instructions=None, dtm=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/generic_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.md index b63ab408201..1c5b8970961 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.md index b29342ef9bd..260266caf4d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.md index 7cbf0fa6907..e0639cd534d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendstatus.py "view source code") +`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.Command.md b/docs/api/qiskit/0.46/qiskit.providers.models.Command.md index 50a6ba8a580..33706dd6bba 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.md index 4ddad930d1d..982038acf1c 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.md b/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.md index 3fa85cb86c5..d82f7ba667a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.GateProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateProperties -`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.md index 55c464b936b..e5e3725ad60 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/jobstatus.py "view source code") +`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/jobstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.md b/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.md index 2465fedf57e..8e5f60d8ca8 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.Nduv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Nduv -`qiskit.providers.models.Nduv(date, name, unit, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.Nduv(date, name, unit, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.md index 545750b3068..663ce121eba 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.md index f17521e10fa..061fa7b5e7d 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.md index 83aa9a1c171..41ec1d40e98 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.md index a3cca3b3fd0..0dbfb7b176a 100644 --- a/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.46/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`qiskit.providers.models.UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.md index 3653fa35d41..edca4d35f2f 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`qiskit.pulse.InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instruction_schedule_map.py "view source code") +`qiskit.pulse.InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.46/qiskit.pulse.Schedule.md index f7282caf622..1c896d13b9b 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.md index 4308af5ceb9..98c91f81007 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.md index 7c91206e3ef..e27537b58df 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.md index ea7d084e183..4a1b236d38e 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`qiskit.pulse.channels.ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.ControlChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.md index 3fc44b1ae8a..87211b4cac4 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`qiskit.pulse.channels.DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.DriveChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.md index d8d8b51b3c4..baf087ff2ed 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.md index e2806667cbd..801c9fb5f91 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`qiskit.pulse.channels.MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MemorySlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.md index 9ad0c1f3ea9..2d841837924 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.md index 3f34458c12d..1df52df633a 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.md index ab5562f4621..0e195ff92a5 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/acquire.py "view source code") +`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.md index e0147d1868f..bf27ff114bf 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/call.py "view source code") +`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/call.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.md index 3b634347219..9a4de247ce4 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`qiskit.pulse.instructions.Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/delay.py "view source code") +`qiskit.pulse.instructions.Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/delay.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.md index 125e5646447..19447a94288 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`qiskit.pulse.instructions.Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/play.py "view source code") +`qiskit.pulse.instructions.Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/play.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.md index d39cef2d915..f31c21d1a42 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`qiskit.pulse.instructions.Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/reference.py "view source code") +`qiskit.pulse.instructions.Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/reference.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.md index 23ef2e0c82b..facb12531df 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.md index 771d723084f..3fb2ee13049 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.md index 20ee6dfade3..87fa46d994d 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.md index 9e0ca23a4fb..d5e89495d97 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.md index e6da3a67285..469538d76be 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.md index 5ba7515d7e3..9b803776eac 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/snapshot.py "view source code") +`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.md index f98c6b69bc4..555caed27eb 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.md index c6ca45c4016..0801ca65593 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Cos_class.rst.md index 9dcb8eb5e53..0d7fbd23ef2 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") A cosine pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.md index 7e576b79092..bf07a0e40bc 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianDeriv.md b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianDeriv.md index 445dabbda96..af45d1635b9 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianDeriv.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv -`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized Gaussian derivative pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.md index 2f56de68217..a0d1844d25c 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquareDrag.md index 54c55a57c26..2f4ac0f9f8d 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.md index 1af4a6bbbec..89aedf2bb82 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.md index 37043893531..34512932392 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/parametric_pulses.py "view source code") +`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Sawtooth_class.rst.md index f3c3f650ea7..3aef0750adf 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") A sawtooth pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.SechDeriv.md b/docs/api/qiskit/0.46/qiskit.pulse.library.SechDeriv.md index 7a8151f033f..c35cd194cd7 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.SechDeriv.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.SechDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.SechDeriv -`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech derivative pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Sech_fun.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Sech_fun.rst.md index 7ad40da19a5..66321ef9998 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Sech_fun.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Sech_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sech -`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Sin_class.rst.md index 770520300bf..be8637fdbb2 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") A sinusoidal pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Square_fun.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Square_fun.rst.md index 3910c9f65d4..734886e4d2a 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Square_fun.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Square_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Square -`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") A square wave pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.md index 14388e5870c..1f21516130f 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Triangle_class.rst.md index e2ee9f33ae5..85d96f30cc3 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") A triangle wave pulse. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.md index f2b8f6b35f2..9bf2a127d9b 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/waveform.py "view source code") +`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/waveform.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/0.46/qiskit.pulse.library.gaussian_square_echo.md b/docs/api/qiskit/0.46/qiskit.pulse.library.gaussian_square_echo.md index 80c17b389ff..775874c7095 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.library.gaussian_square_echo.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.library.gaussian_square_echo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo -`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py "view source code") An echoed Gaussian square pulse with an active tone overlaid on it. diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.md index 5c220683540..900f1d94181 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`qiskit.pulse.transforms.AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.md index 9f1a159ff4b..d4e241a2df5 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`qiskit.pulse.transforms.AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.md index 913fff433db..5813fe02088 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`qiskit.pulse.transforms.AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.md index 63beef9db7b..ae1bab06390 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`qiskit.pulse.transforms.AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.md index 30e2864a2d6..3f9b78474a0 100644 --- a/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.46/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`qiskit.pulse.transforms.AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.md index 7d83034a566..5feb58ae854 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`qiskit.qobj.GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.md index 3d607960751..1d9c5a7367e 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`qiskit.qobj.PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.md index decbaddfd3a..f1318617e38 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.md index f0d15776ff7..8311bf3d234 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.md index bf4b7534b2a..63e3d2b80c6 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.md index 6233282afa2..0aad5aadd65 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.md index a10e26aa2e6..eef491a6d60 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.md index a1bfe465e57..fa99786bd56 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`qiskit.qobj.QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.md index fa3039bb4eb..d96fbe97671 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.md index 85d12ad1dd5..36e1745389b 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.md index 2f88fa0a5fa..9d0722f6ba3 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.md index 1f0b1641370..e1069e9505d 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.md index 2bbca305490..c3425d1c0b5 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.md index 4d39794d8fe..001ead0bb0b 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`qiskit.qobj.QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/common.py "view source code") Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.md index f079518f430..27b7eb15d85 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`qiskit.qobj.QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/common.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.md index 63deedcf568..7b8136e007f 100644 --- a/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.46/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`qiskit.qobj.QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.md index bfbb10a5c39..40dba6d78d4 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.md index 3a4e4f6885c..2611ccdf370 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/chi.py "view source code") +`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.md index 4d23ae851bf..3d358163c95 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/choi.py "view source code") +`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.md index 352b6a551b9..bf6af8449b9 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`qiskit.quantum_info.Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`qiskit.quantum_info.Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.md index 7803a2dea97..777e53bacc9 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`qiskit.quantum_info.DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/densitymatrix.py "view source code") +`qiskit.quantum_info.DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.md index 3d9a6349de7..500220b672d 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.md index fe2ac5fcdff..275f97ee28a 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/operator.py "view source code") +`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/operator.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.md index 4731d769bb8..c6bbb776fe5 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.md index 7200a492d18..8339a46a8ed 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`qiskit.quantum_info.Pauli(data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`qiskit.quantum_info.Pauli(data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `BasePauli` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.md index 7c5519e0e3f..584b0a4cc02 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`qiskit.quantum_info.PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`qiskit.quantum_info.PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `BasePauli`, `LinearMixin`, `GroupMixin` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.md index 2612186176d..b2aed33b528 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`qiskit.quantum_info.Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/quaternion.py "view source code") +`qiskit.quantum_info.Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/quaternion.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.md index a6cd5c7fc66..5b9e757628a 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/scalar_op.py "view source code") +`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.md index 951973fa0e1..30309555a7f 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.md index 1acb7f476c0..10908987ee1 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`qiskit.quantum_info.StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`qiskit.quantum_info.StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `QuantumState` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.md index d2fbdbb6bc8..06eaa309870 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`qiskit.quantum_info.Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/statevector.py "view source code") +`qiskit.quantum_info.Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/statevector.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.md index b4f3bdcff37..2a70f0f0b0e 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.md index f52c92569a8..8d1dedabb51 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/superop.py "view source code") +`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.md index c409ad4063e..afe84a0b112 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.46/qiskit.quantum_info.pauli_basis.md index 7f4330f3aea..35cb33ba9f7 100644 --- a/docs/api/qiskit/0.46/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.46/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.md index e10e4871916..c5893733f2e 100644 --- a/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.46/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`qiskit.result.BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`qiskit.result.BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.md index 9f9c36d2f35..21e4fa870c8 100644 --- a/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.46/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/0.46/qiskit.result.Counts.md b/docs/api/qiskit/0.46/qiskit.result.Counts.md index 2463622a5b4..2b802f20fea 100644 --- a/docs/api/qiskit/0.46/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.46/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/counts.py "view source code") +`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/counts.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.md index 8889015fe0e..66d49f1f854 100644 --- a/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.46/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.md index 6147752712f..90c5dad80be 100644 --- a/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.46/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`qiskit.result.ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/distributions/probability.py "view source code") +`qiskit.result.ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/distributions/probability.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.md index 8dfd0625c64..48cb16f33d2 100644 --- a/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.46/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/distributions/quasi.py "view source code") +`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/distributions/quasi.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.result.Result.md b/docs/api/qiskit/0.46/qiskit.result.Result.md index 4f6ea159e19..55f40e6832a 100644 --- a/docs/api/qiskit/0.46/qiskit.result.Result.md +++ b/docs/api/qiskit/0.46/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/result.py "view source code") +`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.result.ResultError.md b/docs/api/qiskit/0.46/qiskit.result.ResultError.md index 0b85c4263fa..6ae4815eb09 100644 --- a/docs/api/qiskit/0.46/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.46/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`qiskit.result.ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/exceptions.py "view source code") +`qiskit.result.ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.md index 38f188708e5..a115a6b6c3b 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`qiskit.synthesis.EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`qiskit.synthesis.EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.md index c2a67d99289..2c5cd1054bd 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.md index 176cc0dc69c..75b11e6bd16 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`qiskit.synthesis.MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`qiskit.synthesis.MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.md index 60fcee0838a..df70ad8efa3 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer -`qiskit.synthesis.OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/one_qubit/one_qubit_decompose.py "view source code") +`qiskit.synthesis.OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/one_qubit/one_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.md index 6f394b17856..dd06d1a7497 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/product_formula.py "view source code") +`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.md index 4d721a710ec..a5df5fe6950 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/qdrift.py "view source code") +`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.md index 1fd4a0c057e..464c6301fad 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.md index 46fc16e05ae..aeedde8fdc3 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.md index d1ee81b4345..3ed3b71f352 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer -`qiskit.synthesis.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") +`qiskit.synthesis.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.md b/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.md index 1e5bfa6e0f8..4d9131e6999 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.XXDecomposer -`qiskit.synthesis.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/two_qubit/xx_decompose/decomposer.py "view source code") +`qiskit.synthesis.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/two_qubit/xx_decompose/decomposer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.md index bb201f84f14..74b425a0f30 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC -`qiskit.synthesis.unitary.aqc.AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/aqc.py "view source code") +`qiskit.synthesis.unitary.aqc.AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/aqc.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md index 926e2370bfe..a235e15fd3b 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit -`qiskit.synthesis.unitary.aqc.ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/approximate.py "view source code") +`qiskit.synthesis.unitary.aqc.ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/approximate.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md index 6fb56ec00a0..b8627a0d7b2 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective -`qiskit.synthesis.unitary.aqc.ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/approximate.py "view source code") +`qiskit.synthesis.unitary.aqc.ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/approximate.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md index 86133578291..67dc779175b 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit -`qiskit.synthesis.unitary.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py "view source code") +`qiskit.synthesis.unitary.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py "view source code") Bases: [`ApproximateCircuit`](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.approximate.ApproximateCircuit") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md index c9aa658137f..e94fbf464e2 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitObjective -`qiskit.synthesis.unitary.aqc.CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") +`qiskit.synthesis.unitary.aqc.CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md index 6065f3509f5..747423d8f5d 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective -`qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") +`qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md index 54c624849c8..4b63f190f7e 100644 --- a/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.46/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective -`qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py "view source code") +`qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.md index 326e3ef21ed..9f11bc71325 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`qiskit.transpiler.AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.md index b17f0563e20..b4d7e327963 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/coupling.py "view source code") +`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/coupling.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.md index bc4cff65e23..5a79bc4a30c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.md index d83dd5e8f66..fb69161454c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`qiskit.transpiler.FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedPropertySet(property_set_instance)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/fencedobjs.py "view source code") Bases: `FencedObject` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.md index e97bb79a815..30cf5510acb 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/instruction_durations.py "view source code") +`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/instruction_durations.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.md index cc076285d7e..b6bac192cb9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/target.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.46/qiskit.transpiler.Layout.md index 964fb521c22..116f482f32e 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`qiskit.transpiler.Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.md index e9f1ca16c72..cfa79693cc8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passmanager.py "view source code") Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.md index 92dc8eebf0a..354d215f9b4 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passmanager_config.py "view source code") +`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passmanager_config.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.md index c6a63c10f79..d1b7e89603b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passmanager.py "view source code") Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.Target.md b/docs/api/qiskit/0.46/qiskit.transpiler.Target.md index 445a2c3af39..19265a0200b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/target.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.md index 82de6e3781b..4a68b0cf213 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`qiskit.transpiler.TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.md index 0415799654a..431f0f4aa79 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.md index dea752a400c..e4b83f33b76 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index d743b2093d3..a3db1997d38 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.md index f3e4b6e696a..46b42eb344b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AQCSynthesisPlugin -`qiskit.transpiler.passes.AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/aqc_plugin.py "view source code") +`qiskit.transpiler.passes.AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/aqc_plugin.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.md index 803befb9bba..b470738b71a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index e18b8a604d8..953072324d3 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.md index 3087553a531..24298fdc153 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.md index 2b9c0b75e3e..7ce905d812b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index c9f0f84a8f6..7ef70d9822a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.md index 52229033d68..fd43bd5e1c7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.md index 6177675f1f6..3f6f23667be 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.md index 1d90d862ef5..cb98d662648 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.md index 4e20f47fe1e..5e4fc8f4bae 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.md index 725054bb616..68aff2d6d11 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.md index a119b90de02..1856c1279b4 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`qiskit.transpiler.passes.CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/check_map.py "view source code") +`qiskit.transpiler.passes.CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.md index 6d0e5dda78b..9ddc275d09d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.md index 8f4f6f698b9..2bf51078f04 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.md index 776560a4f0e..5d5d3c014cf 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.md index e1cd3282961..2f8bd5a2c9b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.md index 19d1ff2c242..3950970da98 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.md index 9eec3185624..c2fd4bb373c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.md index c1fec588a1e..619a8aa085b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 5531da9815b..71ce280d329 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.md index f8ae6d582e5..35677aeca8d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.md index 39886219d29..985353765ee 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.md index 5e6a0cf3181..17228543b2c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.md index c5a830ac52b..456c33e8a44 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 4ba3d869898..94b774ea7f6 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.md index 54e27a4304a..b1a856b2904 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`qiskit.transpiler.passes.CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`qiskit.transpiler.passes.CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.md index b304a4a53bb..315e26bf127 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index cfa0a9505d4..0b49d404539 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.md index 12c18cf9320..6e65aac6f78 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.md index 1328258ffe0..a65adcc60a4 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.md index 30426cc1e85..2cbc5f0bbbf 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`qiskit.transpiler.passes.Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/decompose.py "view source code") +`qiskit.transpiler.passes.Decompose(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.md index 14e6b58238f..d9489b140a8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.md index 70fd1d5d825..36f1bf44007 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`qiskit.transpiler.passes.Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/depth.py "view source code") +`qiskit.transpiler.passes.Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.md index 2b3be281520..8654d0bcbaa 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index c6b75b9e147..b952f71f4c9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.md index 45ee5cfc614..5f0bd15a198 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.md index 782f1854b39..85a151ef385 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.md index 03ad511ef7a..a2298f1187f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.md index 429eb001421..e392ff8d6ba 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`qiskit.transpiler.passes.GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`qiskit.transpiler.passes.GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.md index 7010627786c..c50a39dbb14 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.md index 7fa71572ee4..61908e863d8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.md index 82995d4f8ac..4ec5a1d5bd6 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.md index 3c2e3f6023d..d30a61ec78b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.md index d0cbeb09d2d..a53fc200383 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.md index 5880eb4f043..d3e3dfaa421 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index 6d2fe0f55ab..2b966e13817 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 70d12e8ae93..2b1829f3dd8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.md index 609a0ef0a70..66eadd96af8 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.md index c48fac3fce6..309a7eac789 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.md index d7ca0f3f6fc..b54b3156d7c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 5fcde96fdca..d5cc54e82c7 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.md index e895cfae9d2..6b6e5b80e13 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NormalizeRXAngle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle -`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") +`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.md index ea2d6c817a0..59fa7377e1c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.md index b961c97c5d1..c273291c378 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 82534b0eef4..7bf4b91036b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 90dd55fbec6..818d3ad2171 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.md index 5adada50bae..7737b20590b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.md index 8367f23d71a..b0f950f5d5a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`qiskit.transpiler.passes.PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`qiskit.transpiler.passes.PadDelay(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 43f549986c8..9419f7993ec 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.md index 4ca7833a085..f218656b099 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`qiskit.transpiler.passes.PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`qiskit.transpiler.passes.PulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.md index 6f724095bd2..05eae96fddd 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder -`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") +`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 6077af8f5fc..b979cfd326f 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index fe8213e1c4e..825eeafe987 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.md index a4249a78175..5165930b6ee 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index dbff6dac4d6..d8d1c83bfde 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 1290c6effa1..1adb7b337a2 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.md index bc6e9e5e98d..438d0ec26a9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 97c2ebc6fe9..8133c7962ab 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.md index eae67a11425..30b72880149 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.md index 9bd5a6555b6..6e0055e4c4c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabrePreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout -`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") +`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.md index 5ae0a1a749d..f0645491d17 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.md index e72663345e8..754d19bc4b5 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.md index 424bc58d081..581db2b801b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`qiskit.transpiler.passes.SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`qiskit.transpiler.passes.SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.md index 7af39522547..5f8e2eb09b6 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`qiskit.transpiler.passes.Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/size.py "view source code") +`qiskit.transpiler.passes.Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.md index 41956f4a5a2..3c024ba0330 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index 662da059c88..9e012d0ce58 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`qiskit.transpiler.passes.SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.md index ae71492710b..52d4e8525c0 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.md index df83c02c1b3..4b3ec9cdeed 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.md index c8fb808f87e..e207579b44d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.md index 222de73e818..58cf6851772 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.md index c6410fbf812..7adafc3b9d9 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.md index 22a53c908bc..7a7fca46c42 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.md index fe75b978b50..254f274be8d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 9f47bb9716d..7273631441a 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.md index ac595f65867..b1efb08d0a5 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.md index dd930f08405..3263a932aa6 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`qiskit.transpiler.passes.Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/unroller.py "view source code") +`qiskit.transpiler.passes.Unroller(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.md index c73c716b2ae..24baed931bb 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.md index 6258e33d590..13bf9142268 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md index 833e8066158..d7fdbf2c77b 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.md index e135edc3229..df49963a084 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`qiskit.transpiler.passes.Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/width.py "view source code") +`qiskit.transpiler.passes.Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 09997127db7..ca5acc3f214 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index d9428503746..cb9bfd9e237 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 23e00b3647c..bbaea8771cb 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 08ab5da53cd..5df9c90a07c 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index e271476482c..ccf960d78f4 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index f8f64d28ba1..6877eda4d7d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index 3f9d49eb406..4e0eac4866d 100644 --- a/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.46/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.md index d57cf46fdc7..fa2ebd8a2a8 100644 --- a/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.46/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/quantum_instance.py "view source code") +`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/quantum_instance.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.md index 7a71cec3797..2f77d02cf3f 100644 --- a/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.46/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/mitigation/fitters.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.md index 0c48b247637..33801d9070a 100644 --- a/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.46/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/mitigation/fitters.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.46/qiskit.visualization.array_to_latex.md index 6846804a895..6fbf358511c 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/array.py "view source code") +`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.md index 646f7fcbc40..3822f82c9eb 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.circuit.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.circuit.qcstyle.DefaultStyle -`qiskit.visualization.circuit.qcstyle.DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/circuit/qcstyle.py "view source code") +`qiskit.visualization.circuit.qcstyle.DefaultStyle` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.46/qiskit.visualization.circuit_drawer.md index 5a089c3f88b..f362338f9ba 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.46/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.46/qiskit.visualization.dag_drawer.md index e715833e0f2..e9fc4b7da36 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/dag_visualization.py "view source code") +`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.46/qiskit.visualization.pass_manager_drawer.md index 068c6b20607..be3ba3149ca 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pass_manager_visualization.py "view source code") +`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_multivector.md index 9163bb4f15b..c131e41fa44 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_vector.md index 7de41a589f2..775bcdbc39d 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_circuit_layout.md index e9135816645..a4bec4ede2a 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_coupling_map.md index c8aaf26be62..e5d2c5c7776 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_distribution.md index 0a1031aeba0..488cc8b1474 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_error_map.md index 0ed2f68688a..91c3e5f816b 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_gate_map.md index 7ed7fe14ce5..4871f906e02 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_histogram.md index f33a5e5687a..8027f019cfc 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_city.md index 13598298d07..ff536d9ddfb 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_hinton.md index 27e62eea163..0cfdaa3d562 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_paulivec.md index 0ae95376352..8be706b5a6f 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") Plot the Pauli-vector representation of a quantum state as bar graph. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_qsphere.md index 8e2d662146c..e2a78b837bb 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.md index 2928b54b7f0..ac9c7295e30 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`qiskit.visualization.pulse.IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXDebugging(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.md index 8d15cb026c5..bd7799b0ed9 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`qiskit.visualization.pulse.IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXSimple(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.md index 23d0b0883bf..97285844033 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`qiskit.visualization.pulse.IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXStandard(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/0.46/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.46/qiskit.visualization.visualize_transition.md index c3746ef468d..f8408a23608 100644 --- a/docs/api/qiskit/0.46/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.46/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/transition_visualization.py "view source code") +`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.46/qpy.md b/docs/api/qiskit/0.46/qpy.md index 5dd53f5952e..32f9c9fb869 100644 --- a/docs/api/qiskit/0.46/qpy.md +++ b/docs/api/qiskit/0.46/qpy.md @@ -59,7 +59,7 @@ and then loading that file will return a list with all the circuits -`qiskit.qpy.load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qpy/interface.py "view source code") Load a QPY binary file @@ -106,7 +106,7 @@ The list of Qiskit programs contained in the QPY data. A list is always returned -`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file @@ -160,7 +160,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski -`qiskit.qpy.QpyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QpyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/qpy/exceptions.py "view source code") Errors raised by the qpy module. diff --git a/docs/api/qiskit/0.46/quantum_info.md b/docs/api/qiskit/0.46/quantum_info.md index c7f298768fa..33c4e247ed1 100644 --- a/docs/api/qiskit/0.46/quantum_info.md +++ b/docs/api/qiskit/0.46/quantum_info.md @@ -60,7 +60,7 @@ python_api_name: qiskit.quantum_info -`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. @@ -102,7 +102,7 @@ The average gate fidelity $F_{\text{ave}}$. -`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. @@ -151,7 +151,7 @@ The process fidelity $F_{\text{pro}}$. -`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. @@ -188,7 +188,7 @@ The average gate error $E$. -`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. @@ -228,7 +228,7 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar -`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. @@ -264,7 +264,7 @@ The state fidelity $F(\rho_1, \rho_2)$. -`qiskit.quantum_info.purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. @@ -295,7 +295,7 @@ the purity $Tr[\rho^2]$. -`qiskit.quantum_info.concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. @@ -337,7 +337,7 @@ The concurrence. -`qiskit.quantum_info.entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. @@ -368,7 +368,7 @@ The von-Neumann entropy S(rho). -`qiskit.quantum_info.entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. @@ -396,7 +396,7 @@ The entanglement of formation. -`qiskit.quantum_info.mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. @@ -436,7 +436,7 @@ The mutual information $I(\rho_{AB})$. -`qiskit.quantum_info.partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. @@ -463,7 +463,7 @@ The reduced density matrix. -`qiskit.quantum_info.schmidt_decomposition(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.schmidt_decomposition(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/utils.py "view source code") Return the Schmidt Decomposition of a pure quantum state. @@ -513,7 +513,7 @@ list of tuples `(s, u, v)`, where `s` (float) are the Schmidt coefficients $\lam -`qiskit.quantum_info.shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. @@ -542,7 +542,7 @@ The Shannon entropy H(pvec). -`qiskit.quantum_info.commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`qiskit.quantum_info.commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/utils/commutator.py "view source code") Compute commutator of a and b. @@ -567,7 +567,7 @@ The commutator -`qiskit.quantum_info.anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`qiskit.quantum_info.anti_commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") Compute anti-commutator of a and b. @@ -592,7 +592,7 @@ The anti-commutator -`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") Compute symmetric double commutator of a, b and c. @@ -641,7 +641,7 @@ Methods of Molecular Quantum Mechanics. 2nd Edition, Academic Press, 1992. ISBN -`qiskit.quantum_info.random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. @@ -668,7 +668,7 @@ K. Zyczkowski and H. Sommers (2001), “Induced measures in the space of mixed q -`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. @@ -695,7 +695,7 @@ the random density matrix. -`qiskit.quantum_info.random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. @@ -718,7 +718,7 @@ a unitary operator. -`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. @@ -742,7 +742,7 @@ a Hermitian operator. -`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. @@ -764,7 +764,7 @@ a random Pauli -`qiskit.quantum_info.random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. @@ -791,7 +791,7 @@ a random Clifford operator. -`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. @@ -820,7 +820,7 @@ a quantum channel operator. -`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. @@ -841,7 +841,7 @@ a random CNOTDihedral element. -`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. @@ -866,7 +866,7 @@ a random PauliList. -`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. @@ -891,7 +891,7 @@ Distance -`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.46/result.md b/docs/api/qiskit/0.46/result.md index 3d0e674bce6..469af7e7130 100644 --- a/docs/api/qiskit/0.46/result.md +++ b/docs/api/qiskit/0.46/result.md @@ -28,7 +28,7 @@ python_api_name: qiskit.result -`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -58,7 +58,7 @@ the observed counts, marginalized to only account for frequency of observations -`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -87,7 +87,7 @@ A marginalized dictionary -`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/utils.py "view source code") Marginalize shot memory @@ -127,7 +127,7 @@ marginal\_memory -`qiskit.result.sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/sampled_expval.py "view source code") +`qiskit.result.sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.46/scheduler.md b/docs/api/qiskit/0.46/scheduler.md index eb0d6427858..669e2e0142b 100644 --- a/docs/api/qiskit/0.46/scheduler.md +++ b/docs/api/qiskit/0.46/scheduler.md @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. -`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/config.py "view source code") +`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. @@ -38,7 +38,7 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched -`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/schedule_circuit.py "view source code") +`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. @@ -74,7 +74,7 @@ Pulse scheduling methods. -`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -98,7 +98,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. diff --git a/docs/api/qiskit/0.46/synthesis.md b/docs/api/qiskit/0.46/synthesis.md index bb841c6ed7c..71ea61d23f5 100644 --- a/docs/api/qiskit/0.46/synthesis.md +++ b/docs/api/qiskit/0.46/synthesis.md @@ -37,7 +37,7 @@ python_api_name: qiskit.synthesis -`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear/cnot_synth.py "view source code") +`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear/cnot_synth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. @@ -68,7 +68,7 @@ a CX-only circuit implementing the linear transformation. -`qiskit.synthesis.synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. @@ -100,7 +100,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cz_depth_line_mr(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. @@ -126,7 +126,7 @@ a circuit implementation of the CZ circuit of depth 2\*n+2 for LNN connectivity. -`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") Joint synthesis of a -CZ-CX- circuit for linear nearest neighbour (LNN) connectivity, with 2-qubit depth at most 5n, based on Maslov and Yang. This method computes the CZ circuit inside the CX circuit via phase gate insertions. @@ -152,7 +152,7 @@ a circuit implementation of a CX circuit following a CZ circuit, denoted as a -C -`qiskit.synthesis.synth_cnot_phase_aam(cnots, angles, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear_phase/cnot_phase_synth.py "view source code") +`qiskit.synthesis.synth_cnot_phase_aam(cnots, angles, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/linear_phase/cnot_phase_synth.py "view source code") This function is an implementation of the GraySynth algorithm of Amy, Azimadeh and Mosca. @@ -207,7 +207,7 @@ the decomposed quantum circuit. -`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. @@ -229,7 +229,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. @@ -251,7 +251,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. @@ -277,7 +277,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`qiskit.synthesis.synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. @@ -306,7 +306,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`qiskit.synthesis.synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. @@ -330,7 +330,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`qiskit.synthesis.synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. @@ -358,7 +358,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`qiskit.synthesis.synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. @@ -388,7 +388,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov. @@ -435,7 +435,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_depth_lnn(cliff)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers for linear-nearest neighbour connectivity. @@ -465,7 +465,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. @@ -490,7 +490,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. @@ -518,7 +518,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. @@ -550,7 +550,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of a stabilizer state into layers. @@ -599,7 +599,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth 2\*n+2 and two distinct CX layers, using CX and phase gates (S, Sdg or Z). @@ -630,7 +630,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. @@ -660,7 +660,7 @@ Decomposition of general $2^n \times 2^n$ unitary matrices for any number of qub -`qiskit.synthesis.qs_decomposition(mat, opt_a1=True, opt_a2=True, decomposer_1q=None, decomposer_2q=None, *, _depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/qsd.py "view source code") +`qiskit.synthesis.qs_decomposition(mat, opt_a1=True, opt_a2=True, decomposer_1q=None, decomposer_2q=None, *, _depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/qsd.py "view source code") Decomposes a unitary matrix into one and two qubit gates using Quantum Shannon Decomposition, diff --git a/docs/api/qiskit/0.46/synthesis_aqc.md b/docs/api/qiskit/0.46/synthesis_aqc.md index 821bc5dc1f9..c2b4600a112 100644 --- a/docs/api/qiskit/0.46/synthesis_aqc.md +++ b/docs/api/qiskit/0.46/synthesis_aqc.md @@ -129,7 +129,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.synthesis.unitary.aqc -`qiskit.synthesis.unitary.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_structures.py "view source code") +`qiskit.synthesis.unitary.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/synthesis/unitary/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.46/tools.md b/docs/api/qiskit/0.46/tools.md index 185c0534fc5..d5c149038fc 100644 --- a/docs/api/qiskit/0.46/tools.md +++ b/docs/api/qiskit/0.46/tools.md @@ -24,7 +24,7 @@ A helper module to get IBM backend information and submitted job status. -`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/monitor/job_monitor.py "view source code") +`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. @@ -58,7 +58,7 @@ job_monitor(job_sim) -`qiskit.tools.backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_monitor(backend)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. @@ -79,7 +79,7 @@ Examples: .. code-block:: python -`qiskit.tools.backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_overview()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. @@ -102,7 +102,7 @@ A helper component for publishing and subscribing to events. -`qiskit.tools.events.TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/events/progressbar.py "view source code") +`qiskit.tools.events.TextProgressBar(output_handler=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/tools/events/progressbar.py "view source code") A simple text-based progress bar. diff --git a/docs/api/qiskit/0.46/transpiler.md b/docs/api/qiskit/0.46/transpiler.md index 508bcf5e9a3..bc2a40dabba 100644 --- a/docs/api/qiskit/0.46/transpiler.md +++ b/docs/api/qiskit/0.46/transpiler.md @@ -942,7 +942,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor -`qiskit.transpiler.TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. @@ -952,7 +952,7 @@ Set the error message. -`qiskit.transpiler.TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. @@ -962,7 +962,7 @@ Set the error message. -`qiskit.transpiler.CouplingError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CouplingError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") Base class for errors raised by the coupling graph object. @@ -972,7 +972,7 @@ Set the error message. -`qiskit.transpiler.LayoutError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.LayoutError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/exceptions.py "view source code") Errors raised by the layout object. diff --git a/docs/api/qiskit/0.46/transpiler_plugins.md b/docs/api/qiskit/0.46/transpiler_plugins.md index 8a999a278ca..a9fd5518f20 100644 --- a/docs/api/qiskit/0.46/transpiler_plugins.md +++ b/docs/api/qiskit/0.46/transpiler_plugins.md @@ -101,7 +101,7 @@ Note that the entry point `name = path` is a single string not a Python expressi -`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. @@ -125,7 +125,7 @@ plugins -`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/0.46/transpiler_preset.md b/docs/api/qiskit/0.46/transpiler_preset.md index 06e2c6b6741..47e7d52af70 100644 --- a/docs/api/qiskit/0.46/transpiler_preset.md +++ b/docs/api/qiskit/0.46/transpiler_preset.md @@ -28,7 +28,7 @@ This module contains functions for generating the preset pass managers for the t -`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -101,7 +101,7 @@ The preset pass manager for the given options -`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -129,7 +129,7 @@ a level 0 pass manager. -`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -155,7 +155,7 @@ a level 1 pass manager. -`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. @@ -183,7 +183,7 @@ a level 2 pass manager. -`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. @@ -215,7 +215,7 @@ a level 3 pass manager. -`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. @@ -231,7 +231,7 @@ a pass manager that populates the `contains_x` properties for each of the contro -`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. @@ -239,7 +239,7 @@ Get a pass manager that always raises an error if control flow is present in a g -`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -264,7 +264,7 @@ The unroll 3q or more pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -288,7 +288,7 @@ set has been set in earlier stages -`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -316,7 +316,7 @@ The routing pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -340,7 +340,7 @@ The pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -372,7 +372,7 @@ The basis translation pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.46/utils.md b/docs/api/qiskit/0.46/utils.md index 1591eb8d60f..d3ede6ba170 100644 --- a/docs/api/qiskit/0.46/utils.md +++ b/docs/api/qiskit/0.46/utils.md @@ -22,7 +22,7 @@ python_api_name: qiskit.utils -`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") Dynamically insert the deprecation message into `func`’s docstring. @@ -37,7 +37,7 @@ Dynamically insert the deprecation message into `func`’s docstring. -`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") Decorator to indicate an argument has been deprecated in some way. @@ -67,7 +67,7 @@ Callable -`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_arg. @@ -89,7 +89,7 @@ Callable -`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") Decorator to indicate a function has been deprecated. @@ -118,7 +118,7 @@ Callable -`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_func. @@ -141,7 +141,7 @@ Callable -`qiskit.utils.local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. @@ -159,7 +159,7 @@ The hardware information. -`qiskit.utils.is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one @@ -167,7 +167,7 @@ Checks whether the current process is the main one -`qiskit.utils.apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/units.py "view source code") +`qiskit.utils.apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. @@ -200,7 +200,7 @@ Converted value. -`qiskit.utils.detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/units.py "view source code") +`qiskit.utils.detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. @@ -244,7 +244,7 @@ A tuple of scaled value and prefix. -`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/classtools.py "view source code") +`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. @@ -269,7 +269,7 @@ If either `before` or `after` are given, they should be callables with a compati -`qiskit.utils.summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/circuit_utils.py "view source code") +`qiskit.utils.summarize_circuits(circuits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/circuit_utils.py "view source code") **Summarize circuits based on QuantumCircuit, and five metrics are summarized.** @@ -301,7 +301,7 @@ a formatted string records the summary -`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. @@ -331,7 +331,7 @@ A map of qubit index to an array of indexes to which this should be entangled -`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. @@ -363,7 +363,7 @@ Validated/converted map -`qiskit.utils.has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_ibmq()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed. @@ -375,7 +375,7 @@ Check if IBMQ is installed. -`qiskit.utils.has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_aer()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/backend_utils.py "view source code") Check if Aer is installed. @@ -387,7 +387,7 @@ Check if Aer is installed. -`qiskit.utils.name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/name_unnamed_args.py "view source code") +`qiskit.utils.name_args(mapping, skip=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. @@ -435,7 +435,7 @@ A helper function for calling a custom function with python `ProcessPoolExecutor -`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/parallel.py "view source code") +`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -555,7 +555,7 @@ from qiskit.utils import LazyImportTester -`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -676,7 +676,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -690,7 +690,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. diff --git a/docs/api/qiskit/0.46/visualization.md b/docs/api/qiskit/0.46/visualization.md index 02e5fd0ca03..b7e3843ce48 100644 --- a/docs/api/qiskit/0.46/visualization.md +++ b/docs/api/qiskit/0.46/visualization.md @@ -237,7 +237,7 @@ You can find code examples for each visualization functions on the individual fu -`qiskit.visualization.VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/exceptions.py "view source code") +`qiskit.visualization.VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. From e800b79f9f2ab4a2409c8232ea6b2704f6cce263 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:03:35 +0100 Subject: [PATCH 27/41] Regenerate qiskit 1.0.1 --- docs/api/qiskit/assembler.md | 6 +- docs/api/qiskit/circuit.md | 4 +- docs/api/qiskit/circuit_classical.md | 70 ++++----- docs/api/qiskit/circuit_library.md | 142 +++++++++--------- docs/api/qiskit/circuit_singleton.md | 6 +- docs/api/qiskit/compiler.md | 8 +- docs/api/qiskit/converters.md | 16 +- docs/api/qiskit/dagcircuit.md | 4 +- docs/api/qiskit/exceptions.md | 14 +- docs/api/qiskit/passmanager.md | 2 +- docs/api/qiskit/providers.md | 10 +- docs/api/qiskit/providers_fake_provider.md | 6 +- docs/api/qiskit/pulse.md | 100 ++++++------ docs/api/qiskit/qasm2.md | 16 +- docs/api/qiskit/qasm3.md | 16 +- docs/api/qiskit/qiskit.assembler.RunConfig.md | 2 +- .../api/qiskit/qiskit.circuit.AncillaQubit.md | 2 +- .../qiskit/qiskit.circuit.AncillaRegister.md | 2 +- .../qiskit.circuit.AnnotatedOperation.md | 2 +- docs/api/qiskit/qiskit.circuit.Bit.md | 2 +- docs/api/qiskit/qiskit.circuit.BreakLoopOp.md | 2 +- .../qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/qiskit.circuit.Clbit.md | 2 +- .../qiskit.circuit.CommutationChecker.md | 2 +- .../qiskit/qiskit.circuit.ContinueLoopOp.md | 2 +- .../qiskit/qiskit.circuit.ControlFlowOp.md | 2 +- .../qiskit/qiskit.circuit.ControlModifier.md | 2 +- .../qiskit/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/qiskit.circuit.Delay.md | 2 +- .../qiskit.circuit.EquivalenceLibrary.md | 2 +- docs/api/qiskit/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/qiskit.circuit.Gate.md | 2 +- docs/api/qiskit/qiskit.circuit.IfElseOp.md | 2 +- docs/api/qiskit/qiskit.circuit.Instruction.md | 2 +- .../qiskit/qiskit.circuit.InstructionSet.md | 2 +- .../qiskit/qiskit.circuit.InverseModifier.md | 2 +- docs/api/qiskit/qiskit.circuit.Operation.md | 2 +- docs/api/qiskit/qiskit.circuit.Parameter.md | 2 +- .../qiskit.circuit.ParameterExpression.md | 2 +- .../qiskit/qiskit.circuit.ParameterVector.md | 2 +- .../qiskit/qiskit.circuit.PowerModifier.md | 2 +- .../qiskit/qiskit.circuit.QuantumCircuit.md | 2 +- .../qiskit/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/qiskit.circuit.Qubit.md | 2 +- docs/api/qiskit/qiskit.circuit.Register.md | 2 +- .../api/qiskit/qiskit.circuit.SwitchCaseOp.md | 2 +- docs/api/qiskit/qiskit.circuit.WhileLoopOp.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- docs/api/qiskit/qiskit.circuit.library.AND.md | 2 +- .../qiskit/qiskit.circuit.library.Barrier.md | 2 +- .../qiskit/qiskit.circuit.library.C3SXGate.md | 2 +- .../qiskit/qiskit.circuit.library.C3XGate.md | 2 +- .../qiskit/qiskit.circuit.library.C4XGate.md | 2 +- .../qiskit/qiskit.circuit.library.CCXGate.md | 2 +- .../qiskit/qiskit.circuit.library.CCZGate.md | 2 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../qiskit/qiskit.circuit.library.CHGate.md | 2 +- .../qiskit.circuit.library.CPhaseGate.md | 2 +- .../qiskit/qiskit.circuit.library.CRXGate.md | 2 +- .../qiskit/qiskit.circuit.library.CRYGate.md | 2 +- .../qiskit/qiskit.circuit.library.CRZGate.md | 2 +- .../qiskit/qiskit.circuit.library.CSGate.md | 2 +- .../qiskit/qiskit.circuit.library.CSXGate.md | 2 +- .../qiskit/qiskit.circuit.library.CSdgGate.md | 2 +- .../qiskit.circuit.library.CSwapGate.md | 2 +- .../qiskit/qiskit.circuit.library.CU1Gate.md | 2 +- .../qiskit/qiskit.circuit.library.CU3Gate.md | 2 +- .../qiskit/qiskit.circuit.library.CUGate.md | 2 +- .../qiskit/qiskit.circuit.library.CXGate.md | 2 +- .../qiskit/qiskit.circuit.library.CYGate.md | 2 +- .../qiskit/qiskit.circuit.library.CZGate.md | 2 +- .../qiskit/qiskit.circuit.library.DCXGate.md | 2 +- .../qiskit/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DiagonalGate.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../qiskit/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- docs/api/qiskit/qiskit.circuit.library.GMS.md | 2 +- docs/api/qiskit/qiskit.circuit.library.GR.md | 2 +- docs/api/qiskit/qiskit.circuit.library.GRX.md | 2 +- docs/api/qiskit/qiskit.circuit.library.GRY.md | 2 +- docs/api/qiskit/qiskit.circuit.library.GRZ.md | 2 +- .../qiskit.circuit.library.GlobalPhaseGate.md | 2 +- .../qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../qiskit/qiskit.circuit.library.HGate.md | 2 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- .../qiskit.circuit.library.HamiltonianGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../qiskit/qiskit.circuit.library.IGate.md | 2 +- docs/api/qiskit/qiskit.circuit.library.IQP.md | 2 +- .../qiskit.circuit.library.Initialize.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- .../qiskit/qiskit.circuit.library.Isometry.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- .../qiskit.circuit.library.LinearFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../api/qiskit/qiskit.circuit.library.MCMT.md | 2 +- .../qiskit.circuit.library.MCMTVChain.md | 2 +- .../qiskit.circuit.library.MCPhaseGate.md | 2 +- .../qiskit/qiskit.circuit.library.MCXGate.md | 2 +- .../qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../qiskit.circuit.library.MCXVChain.md | 2 +- .../qiskit/qiskit.circuit.library.MSGate.md | 2 +- .../qiskit/qiskit.circuit.library.Measure.md | 2 +- .../qiskit/qiskit.circuit.library.NLocal.md | 2 +- docs/api/qiskit/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../qiskit.circuit.library.PauliGate.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../qiskit.circuit.library.PhaseGate.md | 2 +- .../qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../qiskit.circuit.library.QAOAAnsatz.md | 2 +- docs/api/qiskit/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../qiskit/qiskit.circuit.library.RC3XGate.md | 2 +- .../qiskit/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../qiskit/qiskit.circuit.library.RGate.md | 2 +- .../qiskit/qiskit.circuit.library.RVGate.md | 2 +- .../qiskit/qiskit.circuit.library.RXGate.md | 2 +- .../qiskit/qiskit.circuit.library.RXXGate.md | 2 +- .../qiskit/qiskit.circuit.library.RYGate.md | 2 +- .../qiskit/qiskit.circuit.library.RYYGate.md | 2 +- .../qiskit/qiskit.circuit.library.RZGate.md | 2 +- .../qiskit/qiskit.circuit.library.RZXGate.md | 2 +- .../qiskit/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../qiskit/qiskit.circuit.library.Reset.md | 2 +- .../qiskit/qiskit.circuit.library.SGate.md | 2 +- .../qiskit/qiskit.circuit.library.SXGate.md | 2 +- .../qiskit/qiskit.circuit.library.SXdgGate.md | 2 +- .../qiskit/qiskit.circuit.library.SdgGate.md | 2 +- ...qiskit.circuit.library.StatePreparation.md | 2 +- .../qiskit/qiskit.circuit.library.SwapGate.md | 2 +- .../qiskit/qiskit.circuit.library.TGate.md | 2 +- .../qiskit/qiskit.circuit.library.TdgGate.md | 2 +- .../qiskit/qiskit.circuit.library.TwoLocal.md | 2 +- .../qiskit/qiskit.circuit.library.U1Gate.md | 2 +- .../qiskit/qiskit.circuit.library.U2Gate.md | 2 +- .../qiskit/qiskit.circuit.library.U3Gate.md | 2 +- .../qiskit/qiskit.circuit.library.UCGate.md | 2 +- .../qiskit.circuit.library.UCPauliRotGate.md | 2 +- .../qiskit/qiskit.circuit.library.UCRXGate.md | 2 +- .../qiskit/qiskit.circuit.library.UCRYGate.md | 2 +- .../qiskit/qiskit.circuit.library.UCRZGate.md | 2 +- .../qiskit/qiskit.circuit.library.UGate.md | 2 +- .../qiskit.circuit.library.UnitaryGate.md | 2 +- .../qiskit.circuit.library.UnitaryOverlap.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../qiskit/qiskit.circuit.library.XGate.md | 2 +- docs/api/qiskit/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 2 +- .../qiskit.circuit.library.XXPlusYYGate.md | 2 +- .../qiskit/qiskit.circuit.library.YGate.md | 2 +- .../qiskit.circuit.library.ZFeatureMap.md | 2 +- .../qiskit/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../qiskit.circuit.library.iSwapGate.md | 2 +- .../qiskit/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../qiskit/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../qiskit/qiskit.dagcircuit.DAGDependency.md | 2 +- .../api/qiskit/qiskit.dagcircuit.DAGInNode.md | 2 +- docs/api/qiskit/qiskit.dagcircuit.DAGNode.md | 2 +- .../api/qiskit/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../qiskit/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../qiskit.passmanager.BaseController.md | 2 +- .../qiskit.passmanager.BasePassManager.md | 2 +- ...iskit.passmanager.ConditionalController.md | 2 +- .../qiskit.passmanager.DoWhileController.md | 2 +- ...qiskit.passmanager.FlowControllerLinear.md | 2 +- .../qiskit/qiskit.passmanager.GenericPass.md | 2 +- .../qiskit.passmanager.PassManagerState.md | 2 +- .../qiskit/qiskit.passmanager.PropertySet.md | 2 +- .../qiskit.passmanager.WorkflowStatus.md | 2 +- .../qiskit.primitives.BackendEstimator.md | 2 +- .../qiskit.primitives.BackendSampler.md | 2 +- .../qiskit.primitives.BaseEstimatorV1.md | 2 +- .../qiskit.primitives.BaseEstimatorV2.md | 2 +- .../qiskit.primitives.BasePrimitiveJob.md | 2 +- .../qiskit/qiskit.primitives.BaseSamplerV1.md | 2 +- .../qiskit/qiskit.primitives.BaseSamplerV2.md | 2 +- docs/api/qiskit/qiskit.primitives.BitArray.md | 2 +- docs/api/qiskit/qiskit.primitives.DataBin.md | 2 +- .../api/qiskit/qiskit.primitives.Estimator.md | 2 +- .../qiskit.primitives.EstimatorResult.md | 2 +- .../qiskit/qiskit.primitives.PrimitiveJob.md | 2 +- .../qiskit.primitives.PrimitiveResult.md | 2 +- .../api/qiskit/qiskit.primitives.PubResult.md | 2 +- docs/api/qiskit/qiskit.primitives.Sampler.md | 2 +- .../qiskit/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit.primitives.StatevectorEstimator.md | 2 +- .../qiskit.primitives.StatevectorSampler.md | 2 +- docs/api/qiskit/qiskit.providers.Backend.md | 2 +- docs/api/qiskit/qiskit.providers.BackendV1.md | 2 +- docs/api/qiskit/qiskit.providers.BackendV2.md | 2 +- .../qiskit.providers.BackendV2Converter.md | 2 +- docs/api/qiskit/qiskit.providers.Job.md | 2 +- docs/api/qiskit/qiskit.providers.JobStatus.md | 2 +- docs/api/qiskit/qiskit.providers.JobV1.md | 2 +- docs/api/qiskit/qiskit.providers.Options.md | 2 +- docs/api/qiskit/qiskit.providers.Provider.md | 2 +- .../api/qiskit/qiskit.providers.ProviderV1.md | 2 +- .../qiskit.providers.QubitProperties.md | 2 +- ....providers.basic_provider.BasicProvider.md | 2 +- ...iders.basic_provider.BasicProviderError.md | 2 +- ...oviders.basic_provider.BasicProviderJob.md | 2 +- ...providers.basic_provider.BasicSimulator.md | 2 +- .../qiskit.providers.convert_to_target.md | 2 +- ...providers.fake_provider.Fake127QPulseV1.md | 2 +- .../qiskit.providers.fake_provider.Fake1Q.md | 2 +- ...iskit.providers.fake_provider.Fake20QV1.md | 2 +- ....providers.fake_provider.Fake27QPulseV1.md | 2 +- ...qiskit.providers.fake_provider.Fake5QV1.md | 2 +- ...t.providers.fake_provider.Fake7QPulseV1.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 2 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 2 +- ...roviders.fake_provider.GenericBackendV2.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../qiskit/qiskit.providers.models.Command.md | 2 +- .../qiskit.providers.models.GateConfig.md | 2 +- .../qiskit.providers.models.GateProperties.md | 2 +- .../qiskit.providers.models.JobStatus.md | 2 +- .../qiskit/qiskit.providers.models.Nduv.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../qiskit.providers.models.UchannelLO.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- docs/api/qiskit/qiskit.pulse.Schedule.md | 2 +- docs/api/qiskit/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../qiskit.pulse.channels.MemorySlot.md | 2 +- .../qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../qiskit.pulse.instructions.Acquire.md | 2 +- .../qiskit/qiskit.pulse.instructions.Delay.md | 2 +- .../qiskit/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../qiskit.pulse.instructions.Snapshot.md | 2 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- ...qiskit.pulse.library.Constant_class.rst.md | 2 +- .../qiskit.pulse.library.Cos_class.rst.md | 2 +- .../qiskit.pulse.library.Drag_class.rst.md | 2 +- .../qiskit.pulse.library.GaussianDeriv.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- ...qiskit.pulse.library.Gaussian_class.rst.md | 2 +- ...qiskit.pulse.library.Sawtooth_class.rst.md | 2 +- .../qiskit/qiskit.pulse.library.SechDeriv.md | 2 +- .../qiskit.pulse.library.Sech_fun.rst.md | 2 +- .../qiskit.pulse.library.Sin_class.rst.md | 2 +- .../qiskit.pulse.library.Square_fun.rst.md | 2 +- .../qiskit.pulse.library.SymbolicPulse.md | 2 +- ...qiskit.pulse.library.Triangle_class.rst.md | 2 +- .../qiskit/qiskit.pulse.library.Waveform.md | 2 +- ...skit.pulse.library.gaussian_square_echo.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 2 +- .../qiskit.pulse.transforms.AlignFunc.md | 2 +- .../qiskit.pulse.transforms.AlignLeft.md | 2 +- .../qiskit.pulse.transforms.AlignRight.md | 2 +- ...qiskit.pulse.transforms.AlignSequential.md | 2 +- .../api/qiskit/qiskit.qobj.GateCalibration.md | 2 +- .../qiskit/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/qiskit.qobj.PulseQobj.md | 2 +- .../api/qiskit/qiskit.qobj.PulseQobjConfig.md | 2 +- .../qiskit/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/qiskit.qobj.QasmQobj.md | 2 +- docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md | 2 +- .../qiskit/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../qiskit/qiskit.qobj.QasmQobjInstruction.md | 2 +- .../qiskit.qobj.QobjExperimentHeader.md | 2 +- docs/api/qiskit/qiskit.qobj.QobjHeader.md | 2 +- .../qiskit.qobj.QobjMeasurementOption.md | 2 +- .../qiskit.quantum_info.CNOTDihedral.md | 2 +- docs/api/qiskit/qiskit.quantum_info.Chi.md | 2 +- docs/api/qiskit/qiskit.quantum_info.Choi.md | 2 +- .../qiskit/qiskit.quantum_info.Clifford.md | 2 +- .../qiskit.quantum_info.DensityMatrix.md | 2 +- docs/api/qiskit/qiskit.quantum_info.Kraus.md | 2 +- .../qiskit/qiskit.quantum_info.Operator.md | 2 +- docs/api/qiskit/qiskit.quantum_info.PTM.md | 2 +- docs/api/qiskit/qiskit.quantum_info.Pauli.md | 2 +- .../qiskit/qiskit.quantum_info.PauliList.md | 2 +- .../qiskit/qiskit.quantum_info.Quaternion.md | 2 +- .../qiskit/qiskit.quantum_info.ScalarOp.md | 2 +- .../qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerState.md | 2 +- .../qiskit/qiskit.quantum_info.Statevector.md | 2 +- .../qiskit/qiskit.quantum_info.Stinespring.md | 2 +- .../api/qiskit/qiskit.quantum_info.SuperOp.md | 2 +- .../qiskit.quantum_info.Z2Symmetries.md | 2 +- .../qiskit/qiskit.quantum_info.pauli_basis.md | 2 +- .../qiskit.result.BaseReadoutMitigator.md | 2 +- ...iskit.result.CorrelatedReadoutMitigator.md | 2 +- docs/api/qiskit/qiskit.result.Counts.md | 2 +- .../qiskit.result.LocalReadoutMitigator.md | 2 +- .../qiskit/qiskit.result.ProbDistribution.md | 2 +- .../qiskit/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/qiskit.result.Result.md | 2 +- docs/api/qiskit/qiskit.result.ResultError.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 2 +- .../api/qiskit/qiskit.synthesis.LieTrotter.md | 2 +- .../qiskit.synthesis.MatrixExponential.md | 2 +- ...iskit.synthesis.OneQubitEulerDecomposer.md | 2 +- .../qiskit/qiskit.synthesis.ProductFormula.md | 2 +- docs/api/qiskit/qiskit.synthesis.QDrift.md | 2 +- ...it.synthesis.SolovayKitaevDecomposition.md | 2 +- .../qiskit/qiskit.synthesis.SuzukiTrotter.md | 2 +- ...iskit.synthesis.TwoQubitBasisDecomposer.md | 2 +- ...kit.synthesis.TwoQubitWeylDecomposition.md | 2 +- .../qiskit/qiskit.synthesis.XXDecomposer.md | 2 +- .../qiskit.synthesis.unitary.aqc.AQC.md | 2 +- ...ynthesis.unitary.aqc.ApproximateCircuit.md | 2 +- ...esis.unitary.aqc.ApproximatingObjective.md | 2 +- ...t.synthesis.unitary.aqc.CNOTUnitCircuit.md | 2 +- ...synthesis.unitary.aqc.CNOTUnitObjective.md | 2 +- ...is.unitary.aqc.DefaultCNOTUnitObjective.md | 2 +- ...hesis.unitary.aqc.FastCNOTUnitObjective.md | 2 +- .../qiskit/qiskit.synthesis.unitary.aqc.md | 2 +- .../qiskit/qiskit.transpiler.AnalysisPass.md | 2 +- .../qiskit/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- docs/api/qiskit/qiskit.transpiler.Layout.md | 2 +- .../qiskit/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 2 +- docs/api/qiskit/qiskit.transpiler.Target.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- .../qiskit.transpiler.TranspileLayout.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.AlignMeasures.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../qiskit.transpiler.passes.CheckMap.md | 2 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...r.passes.CommutativeInverseCancellation.md | 2 +- ...transpiler.passes.Commuting2qGateRouter.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- ...transpiler.passes.ConstrainedReschedule.md | 2 +- ...t.transpiler.passes.ContainsInstruction.md | 2 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 2 +- .../qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../qiskit/qiskit.transpiler.passes.Depth.md | 2 +- ...t.transpiler.passes.DynamicalDecoupling.md | 2 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FilterOpNodes.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- .../qiskit.transpiler.passes.GatesInBasis.md | 2 +- .../qiskit.transpiler.passes.HLSConfig.md | 2 +- ...it.transpiler.passes.HighLevelSynthesis.md | 2 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 2 +- ...nspiler.passes.InstructionDurationCheck.md | 2 +- ...t.transpiler.passes.InverseCancellation.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- .../qiskit.transpiler.passes.MinimumPoint.md | 2 +- ...skit.transpiler.passes.NormalizeRXAngle.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...passes.Optimize1qGatesSimpleCommutation.md | 2 +- ...kit.transpiler.passes.OptimizeAnnotated.md | 2 +- ...kit.transpiler.passes.OptimizeCliffords.md | 2 +- .../qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 2 +- ....transpiler.passes.RXCalibrationBuilder.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 2 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- ....passes.ResetAfterMeasureSimplification.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- ...qiskit.transpiler.passes.SabrePreLayout.md | 2 +- .../qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetIOLatency.md | 2 +- .../qiskit.transpiler.passes.SetLayout.md | 2 +- .../qiskit/qiskit.transpiler.passes.Size.md | 2 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- ...it.transpiler.passes.TimeUnitConversion.md | 2 +- ...iler.passes.TranslateParameterizedGates.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- ...qiskit.transpiler.passes.UnrollForLoops.md | 2 +- .../qiskit.transpiler.passes.VF2Layout.md | 2 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 2 +- ...it.transpiler.passes.ValidatePulseGates.md | 2 +- .../qiskit/qiskit.transpiler.passes.Width.md | 2 +- ...synthesis.aqc_plugin.AQCSynthesisPlugin.md | 2 +- ...level_synthesis.ACGSynthesisPermutation.md | 2 +- ...igh_level_synthesis.AGSynthesisClifford.md | 2 +- ...igh_level_synthesis.BMSynthesisClifford.md | 2 +- ...vel_synthesis.BasicSynthesisPermutation.md | 2 +- ...evel_synthesis.DefaultSynthesisClifford.md | 2 +- ...ynthesis.DefaultSynthesisLinearFunction.md | 2 +- ...level_synthesis.GreedySynthesisClifford.md | 2 +- ...el_synthesis.KMSSynthesisLinearFunction.md | 2 +- ...level_synthesis.KMSSynthesisPermutation.md | 2 +- ...vel_synthesis.LayerLnnSynthesisClifford.md | 2 +- ..._level_synthesis.LayerSynthesisClifford.md | 2 +- ...el_synthesis.PMHSynthesisLinearFunction.md | 2 +- ...thesis.TokenSwapperSynthesisPermutation.md | 2 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 2 +- ....plugin.HighLevelSynthesisPluginManager.md | 2 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 2 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...lugin.high_level_synthesis_plugin_names.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...kitaev_synthesis.SolovayKitaevSynthesis.md | 2 +- ...itary_synthesis.DefaultUnitarySynthesis.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 2 +- ...rs.plugin.PassManagerStagePluginManager.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../qiskit/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/qpy.md | 8 +- docs/api/qiskit/quantum_info.md | 54 +++---- docs/api/qiskit/result.md | 8 +- docs/api/qiskit/scheduler.md | 8 +- docs/api/qiskit/synthesis.md | 46 +++--- docs/api/qiskit/transpiler.md | 12 +- docs/api/qiskit/transpiler_passes.md | 2 +- docs/api/qiskit/transpiler_plugins.md | 4 +- docs/api/qiskit/transpiler_preset.md | 26 ++-- docs/api/qiskit/utils.md | 28 ++-- docs/api/qiskit/visualization.md | 2 +- 506 files changed, 789 insertions(+), 789 deletions(-) diff --git a/docs/api/qiskit/assembler.md b/docs/api/qiskit/assembler.md index c6add8870b5..7c1a9ca9177 100644 --- a/docs/api/qiskit/assembler.md +++ b/docs/api/qiskit/assembler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.assembler -`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_circuits.py "view source code") +`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. @@ -69,7 +69,7 @@ qobj = assemble_circuits(circuits=[qc], -`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_schedules.py "view source code") +`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. @@ -135,7 +135,7 @@ pulseQobj = assemble_schedules(schedules=[schedule], -`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/disassemble.py "view source code") +`qiskit.assembler.disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/circuit.md b/docs/api/qiskit/circuit.md index c75cf92b6c0..ca3f85b0b08 100644 --- a/docs/api/qiskit/circuit.md +++ b/docs/api/qiskit/circuit.md @@ -304,7 +304,7 @@ with qc.switch(cr) as case: -`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/random/utils.py "view source code") +`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. @@ -349,7 +349,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c -`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/exceptions.py "view source code") +`qiskit.circuit.CircuitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/exceptions.py "view source code") Base class for errors raised while processing a circuit. diff --git a/docs/api/qiskit/circuit_classical.md b/docs/api/qiskit/circuit_classical.md index 5df109fdab1..bda7353d1cd 100644 --- a/docs/api/qiskit/circuit_classical.md +++ b/docs/api/qiskit/circuit_classical.md @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are -`qiskit.circuit.classical.expr.Expr`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") +`qiskit.circuit.classical.expr.Expr` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap -`final class qiskit.circuit.classical.expr.Var(var, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Var(var, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") A classical variable. @@ -74,7 +74,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` -`final class qiskit.circuit.classical.expr.Value(value, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Value(value, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") A single scalar value. @@ -82,7 +82,7 @@ The operations traditionally associated with pre-, post- or infix operators in p -`final class qiskit.circuit.classical.expr.Unary(op, operand, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Unary(op, operand, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") A unary expression. @@ -120,7 +120,7 @@ Logical negation. `!operand`. -`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") A binary expression. @@ -237,7 +237,7 @@ Expressions in this system are defined to act only on certain sets of types. How -`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py "view source code") A cast from one type to another, implied by the use of an expression in a different context. @@ -253,7 +253,7 @@ The functions and methods described in this section are a more user-friendly way -`qiskit.circuit.classical.expr.lift(value, /, type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift(value, /, type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Lift the given Python `value` to a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value") or [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var"). @@ -293,7 +293,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo -`qiskit.circuit.classical.expr.cast(operand, type, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.cast(operand, type, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create an explicit cast from the given value to the given type. @@ -318,7 +318,7 @@ There are helper constructor functions for each of the unary operations. -`qiskit.circuit.classical.expr.bit_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -341,7 +341,7 @@ Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) -`qiskit.circuit.classical.expr.logic_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -366,7 +366,7 @@ Similarly, the binary operations and relations have helper functions defined. -`qiskit.circuit.classical.expr.bit_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -389,7 +389,7 @@ Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint -`qiskit.circuit.classical.expr.bit_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -412,7 +412,7 @@ Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint( -`qiskit.circuit.classical.expr.bit_xor(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_xor(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘exclusive or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -435,7 +435,7 @@ Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.logic_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -458,7 +458,7 @@ Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool -`qiskit.circuit.classical.expr.logic_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -481,7 +481,7 @@ Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool( -`qiskit.circuit.classical.expr.equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create an ‘equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -504,7 +504,7 @@ Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3 -`qiskit.circuit.classical.expr.not_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.not_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘not equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -527,7 +527,7 @@ Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Ui -`qiskit.circuit.classical.expr.less(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -550,7 +550,7 @@ Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3) -`qiskit.circuit.classical.expr.less_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -573,7 +573,7 @@ Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(Classi -`qiskit.circuit.classical.expr.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -596,7 +596,7 @@ Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.greater_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -621,7 +621,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition -`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py "view source code") Lift a legacy two-tuple equality condition into a new-style [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"). @@ -650,7 +650,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. @@ -722,7 +722,7 @@ For the convenience of simple visitors that only need to inspect the variables i -`qiskit.circuit.classical.expr.iter_vars(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.iter_vars(node)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") Get an iterator over the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") nodes referenced at any level in the given [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr"). @@ -752,7 +752,7 @@ Two expressions can be compared for direct structural equality by using the buil -`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") Do these two expressions have exactly the same tree structure, up to some key function for the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") objects? @@ -815,7 +815,7 @@ All types inherit from an abstract base class: -`qiskit.circuit.classical.types.Type`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py "view source code") +`qiskit.circuit.classical.types.Type` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py "view source code") Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -827,13 +827,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q -`final class qiskit.circuit.classical.types.Bool`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Bool` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py "view source code") The Boolean type. This has exactly two values: `True` and `False`. -`final class qiskit.circuit.classical.types.Uint(width)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Uint(width)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py "view source code") An unsigned integer of fixed bit width. @@ -853,7 +853,7 @@ The low-level interface to querying the subtyping relationship is the [`order()` -`qiskit.circuit.classical.types.order(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.order(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") Get the ordering relationship between the two types as an enumeration value. @@ -882,7 +882,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. -`qiskit.circuit.classical.types.Ordering(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.Ordering(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -894,7 +894,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis -`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \le \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -925,7 +925,7 @@ False -`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \ge \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -956,7 +956,7 @@ False -`qiskit.circuit.classical.types.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") Get the greater of the two types, assuming that there is an ordering relation between them. Technically, this is a slightly restricted version of the concept of the ‘meet’ of the two types in that the return value must be one of the inputs. In practice in the type system there is no concept of a ‘sum’ type, so the ‘meet’ exists if and only if there is an ordering between the two types, and is equal to the greater of the two types. @@ -990,7 +990,7 @@ It is common to need to cast values of one type to another type. The casting rul -`qiskit.circuit.classical.types.cast_kind(from_, to_, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.cast_kind(from_, to_, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") Determine the sort of cast that is required to move from the left type to the right type. @@ -1016,7 +1016,7 @@ The return values from this function are an enumeration explaining the types of -`qiskit.circuit.classical.types.CastKind(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.CastKind(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py "view source code") A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/circuit_library.md b/docs/api/qiskit/circuit_library.md index cc528a9bfbe..7cd1dd11fc2 100644 --- a/docs/api/qiskit/circuit_library.md +++ b/docs/api/qiskit/circuit_library.md @@ -328,7 +328,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib -`qiskit.circuit.library.templates.nct.template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** @@ -342,7 +342,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** @@ -356,7 +356,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** @@ -370,7 +370,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** @@ -384,7 +384,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** @@ -398,7 +398,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** @@ -412,7 +412,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** @@ -426,7 +426,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** @@ -440,7 +440,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** @@ -454,7 +454,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** @@ -468,7 +468,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** @@ -482,7 +482,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** @@ -496,7 +496,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** @@ -510,7 +510,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** @@ -524,7 +524,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** @@ -538,7 +538,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** @@ -552,7 +552,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** @@ -566,7 +566,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** @@ -580,7 +580,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** @@ -594,7 +594,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** @@ -608,7 +608,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** @@ -622,7 +622,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** @@ -636,7 +636,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** @@ -650,7 +650,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** @@ -664,7 +664,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** @@ -678,7 +678,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** @@ -692,7 +692,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** @@ -706,7 +706,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** @@ -720,7 +720,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** @@ -734,7 +734,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** @@ -748,7 +748,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** @@ -762,7 +762,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** @@ -776,7 +776,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** @@ -790,7 +790,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** @@ -804,7 +804,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** @@ -818,7 +818,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** @@ -832,7 +832,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** @@ -846,7 +846,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** @@ -860,7 +860,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** @@ -874,7 +874,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** @@ -888,7 +888,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** @@ -902,7 +902,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** @@ -916,7 +916,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** @@ -930,7 +930,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** @@ -944,7 +944,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** @@ -958,7 +958,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** @@ -972,7 +972,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** @@ -990,7 +990,7 @@ Template circuits over Clifford gates. -`qiskit.circuit.library.clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`qiskit.circuit.library.clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** @@ -1004,7 +1004,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`qiskit.circuit.library.clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** @@ -1018,7 +1018,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`qiskit.circuit.library.clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** @@ -1032,7 +1032,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`qiskit.circuit.library.clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** @@ -1046,7 +1046,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`qiskit.circuit.library.clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** @@ -1060,7 +1060,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`qiskit.circuit.library.clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** @@ -1074,7 +1074,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`qiskit.circuit.library.clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** @@ -1088,7 +1088,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`qiskit.circuit.library.clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** @@ -1102,7 +1102,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`qiskit.circuit.library.clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** @@ -1116,7 +1116,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`qiskit.circuit.library.clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** @@ -1130,7 +1130,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`qiskit.circuit.library.clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** @@ -1144,7 +1144,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`qiskit.circuit.library.clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** @@ -1158,7 +1158,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`qiskit.circuit.library.clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** @@ -1172,7 +1172,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`qiskit.circuit.library.clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** @@ -1186,7 +1186,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`qiskit.circuit.library.clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** @@ -1200,7 +1200,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`qiskit.circuit.library.clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** @@ -1214,7 +1214,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`qiskit.circuit.library.clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** @@ -1228,7 +1228,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`qiskit.circuit.library.clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** @@ -1246,7 +1246,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui -`qiskit.circuit.library.rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`qiskit.circuit.library.rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. @@ -1254,7 +1254,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`qiskit.circuit.library.rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. @@ -1262,7 +1262,7 @@ Template for CX - RXGate - CX. -`qiskit.circuit.library.rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`qiskit.circuit.library.rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. @@ -1270,7 +1270,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`qiskit.circuit.library.rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. @@ -1278,7 +1278,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`qiskit.circuit.library.rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. @@ -1286,7 +1286,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`qiskit.circuit.library.rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/circuit_singleton.md b/docs/api/qiskit/circuit_singleton.md index 1af4a9086dc..cf882cf7d3a 100644 --- a/docs/api/qiskit/circuit_singleton.md +++ b/docs/api/qiskit/circuit_singleton.md @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir -`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py "view source code") A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. @@ -56,7 +56,7 @@ The exception to be aware of with this class though are the [`Instruction`](qisk -`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py "view source code") A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. @@ -64,7 +64,7 @@ This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton -`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py "view source code") A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances diff --git a/docs/api/qiskit/compiler.md b/docs/api/qiskit/compiler.md index 998f51e0fca..a333f26d24b 100644 --- a/docs/api/qiskit/compiler.md +++ b/docs/api/qiskit/compiler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.compiler -`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/assembler.py "view source code") +`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. @@ -107,7 +107,7 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will -`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/scheduler.py "view source code") +`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`. @@ -136,7 +136,7 @@ A pulse `Schedule` that implements the input circuit -`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/transpiler.py "view source code") +`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. @@ -286,7 +286,7 @@ The transpiled circuit(s). -`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/sequencer.py "view source code") +`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/converters.md b/docs/api/qiskit/converters.md index bf8a6eacae1..be764c83285 100644 --- a/docs/api/qiskit/converters.md +++ b/docs/api/qiskit/converters.md @@ -22,7 +22,7 @@ python_api_name: qiskit.converters -`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dag.py "view source code") +`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dag.py "view source code") Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -66,7 +66,7 @@ dag = circuit_to_dag(circ) -`qiskit.converters.dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_circuit.py "view source code") +`qiskit.converters.dag_to_circuit(dag, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. @@ -110,7 +110,7 @@ circuit.draw('mpl') -`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_instruction.py "view source code") +`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -155,7 +155,7 @@ circuit_to_instruction(circ) -`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_gate.py "view source code") +`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -184,7 +184,7 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g -`qiskit.converters.dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_circuit.py "view source code") +`qiskit.converters.dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. @@ -204,7 +204,7 @@ the circuit representing the input dag dependency. -`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dagdependency.py "view source code") +`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -225,7 +225,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_dagdependency.py "view source code") +`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. @@ -246,7 +246,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_dag.py "view source code") +`qiskit.converters.dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/dagcircuit.md b/docs/api/qiskit/dagcircuit.md index 61717db6db0..d9a0831539c 100644 --- a/docs/api/qiskit/dagcircuit.md +++ b/docs/api/qiskit/dagcircuit.md @@ -36,7 +36,7 @@ python_api_name: qiskit.dagcircuit -`qiskit.dagcircuit.DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. @@ -46,7 +46,7 @@ Set the error message. -`qiskit.dagcircuit.DAGDependencyError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGDependencyError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGDependency object. diff --git a/docs/api/qiskit/exceptions.md b/docs/api/qiskit/exceptions.md index 4f69d2fd4d5..122cac77fbe 100644 --- a/docs/api/qiskit/exceptions.md +++ b/docs/api/qiskit/exceptions.md @@ -26,7 +26,7 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base: -`qiskit.exceptions.QiskitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Base class for errors raised by Qiskit. @@ -44,7 +44,7 @@ Qiskit has several optional features that depend on other packages that are not -`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Raised when an optional library is missing. @@ -56,7 +56,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, -`qiskit.exceptions.QiskitUserConfigError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitUserConfigError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Raised when an error is encountered reading a user config file. @@ -66,7 +66,7 @@ Set the error message. -`qiskit.exceptions.InvalidFileError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.InvalidFileError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Raised when the file provided is not valid for the specific task. @@ -80,7 +80,7 @@ Some particular features of Qiskit may raise custom warnings. In general, Qiskit -`qiskit.exceptions.QiskitWarning`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitWarning` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Common subclass of warnings for Qiskit-specific warnings being raised. @@ -90,7 +90,7 @@ Related to [`MissingOptionalLibraryError`](#qiskit.exceptions.MissingOptionalLib -`qiskit.exceptions.OptionalDependencyImportWarning`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.OptionalDependencyImportWarning` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Raised when an optional library raises errors during its import. @@ -104,7 +104,7 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni -`qiskit.exceptions.ExperimentalWarning`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") +`qiskit.exceptions.ExperimentalWarning` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py "view source code") Raised when an experimental feature is being used. diff --git a/docs/api/qiskit/passmanager.md b/docs/api/qiskit/passmanager.md index 90864163298..691c8c338af 100644 --- a/docs/api/qiskit/passmanager.md +++ b/docs/api/qiskit/passmanager.md @@ -164,7 +164,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza -`qiskit.passmanager.PassManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/exceptions.py "view source code") +`qiskit.passmanager.PassManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/exceptions.py "view source code") Pass manager error. diff --git a/docs/api/qiskit/providers.md b/docs/api/qiskit/providers.md index 3dac2d0727b..3ca72a8498f 100644 --- a/docs/api/qiskit/providers.md +++ b/docs/api/qiskit/providers.md @@ -79,7 +79,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p -`qiskit.providers.QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. @@ -89,7 +89,7 @@ Set the error message. -`qiskit.providers.BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. @@ -99,7 +99,7 @@ Set the error message. -`qiskit.providers.JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. @@ -109,7 +109,7 @@ Set the error message. -`qiskit.providers.JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. @@ -119,7 +119,7 @@ Set the error message. -`qiskit.providers.BackendConfigurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendConfigurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py "view source code") Base class for errors raised by the BackendConfiguration. diff --git a/docs/api/qiskit/providers_fake_provider.md b/docs/api/qiskit/providers_fake_provider.md index 59a0c3a0909..1d843974763 100644 --- a/docs/api/qiskit/providers_fake_provider.md +++ b/docs/api/qiskit/providers_fake_provider.md @@ -83,7 +83,7 @@ The V1 fake backends are based on a set of base classes: -`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_backend.py "view source code") This is a dummy backend just for testing purposes. @@ -96,7 +96,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakeQasmBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") +`qiskit.providers.fake_provider.FakeQasmBackend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") A fake OpenQASM backend. @@ -109,7 +109,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakePulseBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") +`qiskit.providers.fake_provider.FakePulseBackend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") A fake pulse backend. diff --git a/docs/api/qiskit/pulse.md b/docs/api/qiskit/pulse.md index c474b71a04c..aa73b99477d 100644 --- a/docs/api/qiskit/pulse.md +++ b/docs/api/qiskit/pulse.md @@ -72,7 +72,7 @@ These are all instances of the same base class: -`qiskit.pulse.instructions.Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py "view source code") +`qiskit.pulse.instructions.Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -165,7 +165,7 @@ All channels are children of the same abstract base class: -`qiskit.pulse.channels.Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.Channel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -220,7 +220,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`qiskit.pulse.transforms.AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -236,7 +236,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -261,7 +261,7 @@ A `Schedule` with the additional acquisition instructions. -`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. @@ -330,7 +330,7 @@ The input list of schedules transformed to have their measurements aligned. -`qiskit.pulse.transforms.block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. @@ -359,7 +359,7 @@ Scheduled pulse program. -`qiskit.pulse.transforms.compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. @@ -379,7 +379,7 @@ Compressed schedules. -`qiskit.pulse.transforms.flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. @@ -403,7 +403,7 @@ Flatten pulse program. -`qiskit.pulse.transforms.inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. @@ -429,7 +429,7 @@ A schedule without subroutine. -`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. @@ -457,7 +457,7 @@ The padded schedule. -`qiskit.pulse.transforms.remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. @@ -477,7 +477,7 @@ A schedule without directives. -`qiskit.pulse.transforms.remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. @@ -503,7 +503,7 @@ The DAG transforms create DAG representation of input program. This can be used -`qiskit.pulse.transforms.block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/dag.py "view source code") +`qiskit.pulse.transforms.block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. @@ -563,7 +563,7 @@ A sequence of transformations to generate a target code. -`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/base_transforms.py "view source code") +`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. @@ -782,7 +782,7 @@ The above is just a small taste of what is possible with the builder. See the re -`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. @@ -844,7 +844,7 @@ DriveChannel(0) -`qiskit.pulse.builder.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. @@ -872,7 +872,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. @@ -909,7 +909,7 @@ List of control channels associated with the supplied ordered list of qubits. -`qiskit.pulse.builder.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. @@ -937,7 +937,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. @@ -998,7 +998,7 @@ drive_sched.draw() -`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1037,7 +1037,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. @@ -1106,7 +1106,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1277,7 +1277,7 @@ Currently, the backend calibrated gates are provided in the form of [`Schedule`] -`qiskit.pulse.builder.delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. @@ -1302,7 +1302,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. @@ -1327,7 +1327,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. @@ -1354,7 +1354,7 @@ main_prog.assign_references(subroutine_dict={("x_gate", "q0"): subroutine}) -`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. @@ -1379,7 +1379,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. @@ -1406,7 +1406,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. @@ -1431,7 +1431,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. @@ -1458,7 +1458,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Simulator snapshot. @@ -1502,7 +1502,7 @@ pulse_prog.draw() -`qiskit.pulse.builder.align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. @@ -1550,7 +1550,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. @@ -1604,7 +1604,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. @@ -1641,7 +1641,7 @@ None -`qiskit.pulse.builder.align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. @@ -1678,7 +1678,7 @@ None -`qiskit.pulse.builder.align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. @@ -1715,7 +1715,7 @@ None -`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. @@ -1761,7 +1761,7 @@ None -`qiskit.pulse.builder.phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. @@ -1817,7 +1817,7 @@ MemorySlot(0) -`qiskit.pulse.builder.measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. @@ -1874,7 +1874,7 @@ The `register` the qubit measurement result will be stored in. -`qiskit.pulse.builder.measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. @@ -1909,7 +1909,7 @@ The `register`s the qubit measurement results will be stored in. -`qiskit.pulse.builder.delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Insert delays on all the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -1968,7 +1968,7 @@ There are 1e-06 seconds in 4500 samples. -`qiskit.pulse.builder.active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. @@ -1990,7 +1990,7 @@ builder context. -`qiskit.pulse.builder.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. @@ -2022,7 +2022,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. @@ -2058,7 +2058,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2078,7 +2078,7 @@ The time that elapses in `samples`. -`qiskit.pulse.builder.seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. @@ -2108,7 +2108,7 @@ The number of samples for the time to elapse -`qiskit.pulse.PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. @@ -2118,7 +2118,7 @@ Set the error message. -`qiskit.pulse.BackendNotSet(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.BackendNotSet(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") Raised if the builder context does not have a backend. @@ -2128,7 +2128,7 @@ Set the error message. -`qiskit.pulse.NoActiveBuilder(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.NoActiveBuilder(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") Raised if no builder context is active. @@ -2138,7 +2138,7 @@ Set the error message. -`qiskit.pulse.UnassignedDurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedDurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") Raised if instruction duration is unassigned. @@ -2148,7 +2148,7 @@ Set the error message. -`qiskit.pulse.UnassignedReferenceError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedReferenceError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py "view source code") Raised if subroutine is unassigned. diff --git a/docs/api/qiskit/qasm2.md b/docs/api/qiskit/qasm2.md index 253b4bc8bbb..45fc67119c7 100644 --- a/docs/api/qiskit/qasm2.md +++ b/docs/api/qiskit/qasm2.md @@ -34,7 +34,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -59,7 +59,7 @@ A circuit object representing the same OpenQASM 2 program. -`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -89,7 +89,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/parse.py "view source code") +`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/parse.py "view source code") Information about a custom instruction that should be defined during the parse. @@ -129,7 +129,7 @@ Similar to other serialisation modules in Python, this module offers two public -`qiskit.qasm2.dump(circuit, filename_or_stream, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dump(circuit, filename_or_stream, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py "view source code") Dump a circuit as an OpenQASM 2 program to a file or stream. @@ -146,7 +146,7 @@ Dump a circuit as an OpenQASM 2 program to a file or stream. -`qiskit.qasm2.dumps(circuit, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dumps(circuit, /)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py "view source code") Export a circuit to an OpenQASM 2 program in a string. @@ -174,7 +174,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep -`qiskit.qasm2.QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2Error(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py "view source code") A general error raised by the OpenQASM 2 interoperation layer. @@ -186,7 +186,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`qiskit.qasm2.QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to parse an OpenQASM 2 file. @@ -198,7 +198,7 @@ When the exporters fail to export a circuit, likely because it has structure tha -`qiskit.qasm2.QASM2ExportError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ExportError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. diff --git a/docs/api/qiskit/qasm3.md b/docs/api/qiskit/qasm3.md index c7526c1e775..b52350adbe9 100644 --- a/docs/api/qiskit/qasm3.md +++ b/docs/api/qiskit/qasm3.md @@ -28,7 +28,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`qiskit.qasm3.dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. @@ -42,7 +42,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`qiskit.qasm3.dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. @@ -63,7 +63,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exporter.py "view source code") +`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -117,7 +117,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`qiskit.qasm3.QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -129,7 +129,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`qiskit.qasm3.ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/experimental.py "view source code") +`qiskit.qasm3.ExperimentalFeatures(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/experimental.py "view source code") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -227,7 +227,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`qiskit.qasm3.load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -251,7 +251,7 @@ a circuit representation of the OpenQASM 3 program. -`qiskit.qasm3.loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -277,7 +277,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`qiskit.qasm3.QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/qiskit.assembler.RunConfig.md b/docs/api/qiskit/qiskit.assembler.RunConfig.md index 4d61183c719..64c2b4bcb84 100644 --- a/docs/api/qiskit/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/run_config.py "view source code") +`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/run_config.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/qiskit.circuit.AncillaQubit.md index a670243043f..59225058b69 100644 --- a/docs/api/qiskit/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`qiskit.circuit.AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/qiskit.circuit.AncillaRegister.md index 76fbd880f62..565596d0343 100644 --- a/docs/api/qiskit/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md index 33be2444540..5f439a3cc28 100644 --- a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md +++ b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation -`qiskit.circuit.AnnotatedOperation(base_op, modifiers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.AnnotatedOperation(base_op, modifiers)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/qiskit.circuit.Bit.md b/docs/api/qiskit/qiskit.circuit.Bit.md index 89b8f8a56d9..3fd4783fd2b 100644 --- a/docs/api/qiskit/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`qiskit.circuit.Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/bit.py "view source code") +`qiskit.circuit.Bit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/bit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md index da8b7552bf7..5881e27b053 100644 --- a/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/break_loop.py "view source code") +`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md index bc3587c450d..7e7d3e855eb 100644 --- a/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/qiskit.circuit.Clbit.md b/docs/api/qiskit/qiskit.circuit.Clbit.md index cb4e06042bb..d9c579680ef 100644 --- a/docs/api/qiskit/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`qiskit.circuit.Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/qiskit.circuit.CommutationChecker.md b/docs/api/qiskit/qiskit.circuit.CommutationChecker.md index d8a0f92b599..daab7fc5126 100644 --- a/docs/api/qiskit/qiskit.circuit.CommutationChecker.md +++ b/docs/api/qiskit/qiskit.circuit.CommutationChecker.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CommutationChecker -`qiskit.circuit.CommutationChecker(standard_gate_commutations=None, cache_max_entries=1000000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py "view source code") +`qiskit.circuit.CommutationChecker(standard_gate_commutations=None, cache_max_entries=1000000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md index b7743be5d92..2003761068e 100644 --- a/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/continue_loop.py "view source code") +`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md index b39636b8ea4..cfdcfbae2fb 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py "view source code") +`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ControlModifier.md b/docs/api/qiskit/qiskit.circuit.ControlModifier.md index 6fd1eb92d2b..bbed1d088b3 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlModifier.md +++ b/docs/api/qiskit/qiskit.circuit.ControlModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlModifier -`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/qiskit.circuit.ControlledGate.md index e821e21930a..38706959afb 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlledgate.py "view source code") +`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlledgate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.Delay.md b/docs/api/qiskit/qiskit.circuit.Delay.md index b79674f7f21..ce13abaeb6c 100644 --- a/docs/api/qiskit/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`qiskit.circuit.Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py "view source code") +`qiskit.circuit.Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md index 7ab81e5942c..414058e2b84 100644 --- a/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`qiskit.circuit.EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py "view source code") +`qiskit.circuit.EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/qiskit.circuit.ForLoopOp.md index 4629d8836b8..a47ff92fc90 100644 --- a/docs/api/qiskit/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/for_loop.py "view source code") +`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.Gate.md b/docs/api/qiskit/qiskit.circuit.Gate.md index 6cde4720e3f..5e92f7a118f 100644 --- a/docs/api/qiskit/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py "view source code") +`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/qiskit.circuit.IfElseOp.md index 395712f039d..8a8e78d79bf 100644 --- a/docs/api/qiskit/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/if_else.py "view source code") +`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.Instruction.md b/docs/api/qiskit/qiskit.circuit.Instruction.md index 10b7514728b..2785f002a4d 100644 --- a/docs/api/qiskit/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py "view source code") +`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/qiskit.circuit.InstructionSet.md index 5bff1caddb9..b183615339b 100644 --- a/docs/api/qiskit/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`qiskit.circuit.InstructionSet(*, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py "view source code") +`qiskit.circuit.InstructionSet(*, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.InverseModifier.md b/docs/api/qiskit/qiskit.circuit.InverseModifier.md index 895d45463c4..096b7fe9714 100644 --- a/docs/api/qiskit/qiskit.circuit.InverseModifier.md +++ b/docs/api/qiskit/qiskit.circuit.InverseModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InverseModifier -`qiskit.circuit.InverseModifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.InverseModifier` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/qiskit.circuit.Operation.md b/docs/api/qiskit/qiskit.circuit.Operation.md index bb19a79bbeb..8aeb3214c8c 100644 --- a/docs/api/qiskit/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`qiskit.circuit.Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/operation.py "view source code") +`qiskit.circuit.Operation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/operation.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.Parameter.md b/docs/api/qiskit/qiskit.circuit.Parameter.md index c5b0703c929..10aa8270722 100644 --- a/docs/api/qiskit/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`qiskit.circuit.Parameter(name, *, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameter.py "view source code") +`qiskit.circuit.Parameter(name, *, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameter.py "view source code") Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") diff --git a/docs/api/qiskit/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/qiskit.circuit.ParameterExpression.md index 1b1682d3536..87016f82414 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`qiskit.circuit.ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py "view source code") +`qiskit.circuit.ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/qiskit.circuit.ParameterVector.md index 99f3a724a0b..49ef986f5be 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`qiskit.circuit.ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parametervector.py "view source code") +`qiskit.circuit.ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parametervector.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.PowerModifier.md b/docs/api/qiskit/qiskit.circuit.PowerModifier.md index bdf643c314d..e03bfcf110b 100644 --- a/docs/api/qiskit/qiskit.circuit.PowerModifier.md +++ b/docs/api/qiskit/qiskit.circuit.PowerModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.PowerModifier -`qiskit.circuit.PowerModifier(power)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.PowerModifier(power)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py "view source code") Bases: `Modifier` diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md index f8e54ee3f7b..e14150dd907 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py "view source code") +`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/qiskit.circuit.QuantumRegister.md index f1503bca0b1..941bbd43517 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/qiskit.circuit.Qubit.md b/docs/api/qiskit/qiskit.circuit.Qubit.md index 678c3edbe78..566bdf2d599 100644 --- a/docs/api/qiskit/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`qiskit.circuit.Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/qiskit.circuit.Register.md b/docs/api/qiskit/qiskit.circuit.Register.md index c09b13f38d3..4a081f42722 100644 --- a/docs/api/qiskit/qiskit.circuit.Register.md +++ b/docs/api/qiskit/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`qiskit.circuit.Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py "view source code") +`qiskit.circuit.Register(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md index 77df78632d6..59e621f42fd 100644 --- a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py "view source code") +`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md index 547aaf6c1bf..c2d5797236f 100644 --- a/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`qiskit.circuit.WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/while_loop.py "view source code") +`qiskit.circuit.WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md index 423005e8c35..d0a4fa5054a 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md index 584ecb51023..33f8dc7b912 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 9facb533df0..49a4dca956e 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 8c917a0605a..efb968e4dae 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/qiskit.circuit.library.AND.md b/docs/api/qiskit/qiskit.circuit.library.AND.md index 22879999e17..714bbfc87e5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/qiskit.circuit.library.Barrier.md index d401d9e66e3..af1a3e7ad4c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`qiskit.circuit.library.Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/barrier.py "view source code") +`qiskit.circuit.library.Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/barrier.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md index d9bb3c068b9..76d3154a6c2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/qiskit.circuit.library.C3XGate.md index 0d845c50689..323801cfc2d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/qiskit.circuit.library.C4XGate.md index 895df9ee0e7..79d568cde18 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/qiskit.circuit.library.CCXGate.md index 5a2a919553c..6ed78f4418d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/qiskit.circuit.library.CCZGate.md index 741f3760853..39ff5cab0b8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md index a854cb6a95a..4e7f0067ef6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/qiskit.circuit.library.CHGate.md index 7ca416b41de..ad7ed4ec692 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md index 5887e20884f..24274565184 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/qiskit.circuit.library.CRXGate.md index 079960b7763..c7a0edb291b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/qiskit.circuit.library.CRYGate.md index 92e1db28781..e4f20efbdd6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/qiskit.circuit.library.CRZGate.md index 71ee2afad4c..7b239470d5e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/qiskit.circuit.library.CSGate.md index d62ffedf295..2fb2a687987 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/qiskit.circuit.library.CSXGate.md index 0ab6f4c0829..cba4b9f3302 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md index d45f7dfac7e..a99467113f2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md index a80497ca282..2a1770f5a8b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md index d2723449e11..94fdc56a1eb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md index f0ba6da2262..095a5da0030 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/qiskit.circuit.library.CUGate.md index 3721c985b1d..42c9e9ab5e3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/qiskit.circuit.library.CXGate.md index 8a0118f7055..a3699cc6a67 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/qiskit.circuit.library.CYGate.md index f2796403ef2..7f4c4fd28ee 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/qiskit.circuit.library.CZGate.md index d97e5ec10f4..65c6b47d305 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/qiskit.circuit.library.DCXGate.md index 487afafa327..9e4dc19536a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/qiskit.circuit.library.Diagonal.md index 715831d8ee6..4cb0f853025 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`qiskit.circuit.library.Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md index 9c662ca5e1f..72df0ea6df1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate -`qiskit.circuit.library.DiagonalGate(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.DiagonalGate(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md index f37d4f013f5..7bae6be22c9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/qiskit.circuit.library.ECRGate.md index 5cac0394ff0..f1320df7808 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md index d9a67b17eac..ddb1e56c42c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 3c61474370b..f68fd01cef9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/evolved_operator_ansatz.py "view source code") +`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/evolved_operator_ansatz.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md index 3838e94c73b..d3c1380f61d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md index 110a3910ff2..77f99733eef 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md index 4d3f2426698..9b9148282c5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`qiskit.circuit.library.FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/fourier_checking.py "view source code") +`qiskit.circuit.library.FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md index 854c1beb1a8..df220493a4d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.library.GMS.md b/docs/api/qiskit/qiskit.circuit.library.GMS.md index 5e6c2333940..375df3d2da3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`qiskit.circuit.library.GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.GR.md b/docs/api/qiskit/qiskit.circuit.library.GR.md index 705f4d7196a..15b011717c7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`qiskit.circuit.library.GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.GRX.md b/docs/api/qiskit/qiskit.circuit.library.GRX.md index a40b20c9acb..e3ad1094c0f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`qiskit.circuit.library.GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/qiskit.circuit.library.GRY.md b/docs/api/qiskit/qiskit.circuit.library.GRY.md index efbb9a58bd7..36af11ed045 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`qiskit.circuit.library.GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/qiskit.circuit.library.GRZ.md index bb388406cc5..7384bb4330b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`qiskit.circuit.library.GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md index 61360673b5c..200a39a08a6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/qiskit.circuit.library.GraphState.md index cd82dacf44b..085115e812b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`qiskit.circuit.library.GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/graph_state.py "view source code") +`qiskit.circuit.library.GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/graph_state.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md index b76c6f62b2c..732bca8e142 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/grover_operator.py "view source code") +`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.HGate.md b/docs/api/qiskit/qiskit.circuit.library.HGate.md index 03e9ffc5a6a..4a03222a829 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md index be45ebdbeeb..4a07becb885 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md index fcc5f9c828c..50d06ea4571 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate -`qiskit.circuit.library.HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py "view source code") +`qiskit.circuit.library.HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md index c84a5c07703..2c01ad8710e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hidden_linear_function.py "view source code") +`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.IGate.md b/docs/api/qiskit/qiskit.circuit.library.IGate.md index 68ecbaaa40e..983cecf4797 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/i.py "view source code") +`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.IQP.md b/docs/api/qiskit/qiskit.circuit.library.IQP.md index 5cab1fbaf43..faec0fb05db 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`qiskit.circuit.library.IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/iqp.py "view source code") +`qiskit.circuit.library.IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/iqp.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.Initialize.md b/docs/api/qiskit/qiskit.circuit.library.Initialize.md index 184fbed76f5..4d5c37f8eee 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Initialize.md +++ b/docs/api/qiskit/qiskit.circuit.library.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Initialize -`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/initializer.py "view source code") +`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/initializer.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md index f845e1216ad..bea05a4b878 100644 --- a/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`qiskit.circuit.library.InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`qiskit.circuit.library.InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md index afd25e5e930..2e792b95315 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/qiskit.circuit.library.Isometry.md b/docs/api/qiskit/qiskit.circuit.library.Isometry.md index 4ee49c08e59..e8e86f830e3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Isometry.md +++ b/docs/api/qiskit/qiskit.circuit.library.Isometry.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Isometry -`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/isometry.py "view source code") +`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/isometry.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md index 623ff843dbe..6d50997b818 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md index fe0eec242f3..dd02ce1b30a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`qiskit.circuit.library.LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`qiskit.circuit.library.LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md index 07e74b26b27..f05f31df38e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/qiskit.circuit.library.MCMT.md index c43f3992e6c..e8685b1b90e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md index 3f7bf1f8173..1ca8f1f245b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md index b5098153962..8e86ee2e49b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/qiskit.circuit.library.MCXGate.md index ac76a3e8d8c..c5731e2584b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md index 91c1cb1c9b0..927999dc556 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md index 0e62f6d811e..e516d09e99a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md index b2e3a4a6d72..b59cfd52436 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/qiskit.circuit.library.MSGate.md index e6da4fcbe0b..38544c8692e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.Measure.md b/docs/api/qiskit/qiskit.circuit.library.Measure.md index 76e098eba57..de444e65b83 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`qiskit.circuit.library.Measure(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/measure.py "view source code") +`qiskit.circuit.library.Measure(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/measure.py "view source code") Bases: [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/qiskit.circuit.library.NLocal.md index 4ab4898a637..77db436dd03 100644 --- a/docs/api/qiskit/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/n_local.py "view source code") +`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/qiskit.circuit.library.OR.md b/docs/api/qiskit/qiskit.circuit.library.OR.md index 7f102da208e..6fa3f843bae 100644 --- a/docs/api/qiskit/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md index 8d62a8886b0..523ea88bd30 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/pauli_evolution.py "view source code") +`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md index a97331baf43..2bfb36227f0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/qiskit.circuit.library.PauliGate.md index 2114f3b42d8..97176b82e44 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`qiskit.circuit.library.PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`qiskit.circuit.library.PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md index ab36dd481b9..523ee3ab176 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/qiskit.circuit.library.Permutation.md index d2fb97006ef..acac9aad194 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md index 6704cfb5307..99d84c62eab 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`qiskit.circuit.library.PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md index a49ea693316..f314f35978a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/phase_estimation.py "view source code") +`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md index 645db370d17..f94f850bbd3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md index 4299a437da5..8690450686b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/phase_oracle.py "view source code") +`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md index c982fd1be22..f418a2dce17 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 4a98ea94584..03470a010e2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 63bbf523ab1..a05e3fa3524 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md index 6b3da0f47a2..2ef36695f3a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md index 618dc5f2da2..29c14463328 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.n_local.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/qiskit.circuit.library.QFT.md b/docs/api/qiskit/qiskit.circuit.library.QFT.md index 3a462bdc0e6..db4b3ffe77f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/basis_change/qft.py "view source code") +`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md index 6edc9835be0..c7619763117 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md index 9428c8c1f60..20d85745380 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/quantum_volume.py "view source code") +`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md index 8b110ae2538..0d15d00d58e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md index 9ed0e6b739d..ff87603115a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md index 05702198fc0..71029b6726f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/qiskit.circuit.library.RGate.md b/docs/api/qiskit/qiskit.circuit.library.RGate.md index 07f36f3f365..104ab74d9d5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/r.py "view source code") +`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/qiskit.circuit.library.RVGate.md index ec7f8bd825a..fcee22ec8a0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/qiskit.circuit.library.RXGate.md index d1dc03301eb..aa1caeaa825 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/qiskit.circuit.library.RXXGate.md index cb491819c59..c16a2a9df77 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/qiskit.circuit.library.RYGate.md index ca3460120cf..cc41d94d3b6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/qiskit.circuit.library.RYYGate.md index 4c39f9e2790..bf987fcd089 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/qiskit.circuit.library.RZGate.md index 06f24e78e38..a206871ae88 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/qiskit.circuit.library.RZXGate.md index a3aabf44784..e3cbdf1aa1e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/qiskit.circuit.library.RZZGate.md index cff0869354a..e71794f9905 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md index dbac0aff013..0ed3882c898 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.Reset.md b/docs/api/qiskit/qiskit.circuit.library.Reset.md index bc1c5ecbf72..7c3d8070328 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`qiskit.circuit.library.Reset(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/reset.py "view source code") +`qiskit.circuit.library.Reset(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/reset.py "view source code") Bases: [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.SGate.md b/docs/api/qiskit/qiskit.circuit.library.SGate.md index 3328f18acba..7c224a1eab6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/qiskit.circuit.library.SXGate.md index da844e4d8f5..200ffc9b4a4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md index 65c666cc7c1..6482d77c98c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/qiskit.circuit.library.SdgGate.md index 751920bb436..e2e36ba1293 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md index cf93ce2ed58..dfa340affed 100644 --- a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/qiskit.circuit.library.SwapGate.md index 129eee8f2f7..4cad0f28b90 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.TGate.md b/docs/api/qiskit/qiskit.circuit.library.TGate.md index 5efca41fa1e..8c8495448d5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/qiskit.circuit.library.TdgGate.md index f201802d37c..9460a94ed0f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md index 3c696f8ee5e..433e538ea79 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/two_local.py "view source code") +`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/qiskit.circuit.library.U1Gate.md index e6fb3fb064a..cece783b514 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/qiskit.circuit.library.U2Gate.md index 2c295697f25..d2ee74af042 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u2.py "view source code") +`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/qiskit.circuit.library.U3Gate.md index 8040a93b836..b5231c56e29 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCGate.md b/docs/api/qiskit/qiskit.circuit.library.UCGate.md index 296430f0551..cfb75f9e2ab 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCGate -`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/uc.py "view source code") +`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/uc.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md b/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md index 19c24dec039..4543fc10b43 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate -`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") +`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md b/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md index 18007c4cd46..2d4b7a6328b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRXGate -`qiskit.circuit.library.UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") +`qiskit.circuit.library.UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md b/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md index 70fdd7b3dbf..42aa5f0d527 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRYGate -`qiskit.circuit.library.UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/ucry.py "view source code") +`qiskit.circuit.library.UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/ucry.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md b/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md index 61ce9e46fc8..0a1d5c6bb12 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRZGate -`qiskit.circuit.library.UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") +`qiskit.circuit.library.UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UGate.md b/docs/api/qiskit/qiskit.circuit.library.UGate.md index 030cd17a194..c50e47b606d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md index 111b3367dc5..2ea6d0c8a88 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate -`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/unitary.py "view source code") +`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/unitary.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md b/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md index 9af5f9e57f6..04f2f36bf46 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap -`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/overlap.py "view source code") +`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/overlap.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md index bdad31175c9..156b3d7a234 100644 --- a/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md index 206d945ef93..eccb97f895e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/qiskit.circuit.library.XGate.md b/docs/api/qiskit/qiskit.circuit.library.XGate.md index e7b6331ea28..a45438ce302 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.XOR.md b/docs/api/qiskit/qiskit.circuit.library.XOR.md index 861b68cd101..9cada19ba04 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md index 67f4f9b6528..c2420440c02 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md index bcb697e34bc..959b0a5d3fb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.YGate.md b/docs/api/qiskit/qiskit.circuit.library.YGate.md index cf831d19fa8..79c252c3ea7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md index 175ab98b4d4..0191aba5b26 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/qiskit.circuit.library.ZGate.md index 4d8d0cf942d..28eddf6a718 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md index 63294273c2e..33e21e148ef 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md index 958589def39..d1811edae1f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md index 6f3fcd16097..da81cba53ae 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`qiskit.dagcircuit.DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagcircuit.py "view source code") +`qiskit.dagcircuit.DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md index 426f406b330..2a4c641e4bc 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagdepnode.py "view source code") +`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md index 279164a403a..7ba52369f1f 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`qiskit.dagcircuit.DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagdependency.py "view source code") +`qiskit.dagcircuit.DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagdependency.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md index 31b273d8438..d1d32b69172 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`qiskit.dagcircuit.DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md index 78e1893d6b7..b56f1e06c15 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`qiskit.dagcircuit.DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGNode(nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md index 22e6e07e98b..09cb4940a39 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md index 8df9c26838b..3f45db3188d 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`qiskit.dagcircuit.DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/qiskit.passmanager.BaseController.md b/docs/api/qiskit/qiskit.passmanager.BaseController.md index 8f6f3a1dd24..e6101e57b48 100644 --- a/docs/api/qiskit/qiskit.passmanager.BaseController.md +++ b/docs/api/qiskit/qiskit.passmanager.BaseController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BaseController -`qiskit.passmanager.BaseController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.BaseController(options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.BasePassManager.md b/docs/api/qiskit/qiskit.passmanager.BasePassManager.md index 8a60389e62e..f3d6258a486 100644 --- a/docs/api/qiskit/qiskit.passmanager.BasePassManager.md +++ b/docs/api/qiskit/qiskit.passmanager.BasePassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BasePassManager -`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/passmanager.py "view source code") +`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/passmanager.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.ConditionalController.md b/docs/api/qiskit/qiskit.passmanager.ConditionalController.md index e1fd1b7a2e5..dc38101c2f0 100644 --- a/docs/api/qiskit/qiskit.passmanager.ConditionalController.md +++ b/docs/api/qiskit/qiskit.passmanager.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.ConditionalController -`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.DoWhileController.md b/docs/api/qiskit/qiskit.passmanager.DoWhileController.md index cae471ec512..63ea0c34be9 100644 --- a/docs/api/qiskit/qiskit.passmanager.DoWhileController.md +++ b/docs/api/qiskit/qiskit.passmanager.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.DoWhileController -`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md index c7580928927..153dfda625b 100644 --- a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md +++ b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear -`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.GenericPass.md b/docs/api/qiskit/qiskit.passmanager.GenericPass.md index b268b18ad26..1073bd641a1 100644 --- a/docs/api/qiskit/qiskit.passmanager.GenericPass.md +++ b/docs/api/qiskit/qiskit.passmanager.GenericPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.GenericPass -`qiskit.passmanager.GenericPass`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.GenericPass` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.PassManagerState.md b/docs/api/qiskit/qiskit.passmanager.PassManagerState.md index c8816bf37e3..199334d08ef 100644 --- a/docs/api/qiskit/qiskit.passmanager.PassManagerState.md +++ b/docs/api/qiskit/qiskit.passmanager.PassManagerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PassManagerState -`qiskit.passmanager.PassManagerState(workflow_status, property_set)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PassManagerState(workflow_status, property_set)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.PropertySet.md b/docs/api/qiskit/qiskit.passmanager.PropertySet.md index 54af3ff4e2c..a6624387cbf 100644 --- a/docs/api/qiskit/qiskit.passmanager.PropertySet.md +++ b/docs/api/qiskit/qiskit.passmanager.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PropertySet -`qiskit.passmanager.PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/compilation_status.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md index de38212c4aa..199e30ac2f6 100644 --- a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md +++ b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus -`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/qiskit.primitives.BackendEstimator.md index 0848e50c677..ddcb65b7ade 100644 --- a/docs/api/qiskit/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/backend_estimator.py "view source code") +`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/backend_estimator.py "view source code") Bases: [`BaseEstimatorV1`](qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.base.base_estimator.BaseEstimatorV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/qiskit.primitives.BackendSampler.md index 407e1cdbbe6..30efb66b088 100644 --- a/docs/api/qiskit/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/backend_sampler.py "view source code") +`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/backend_sampler.py "view source code") Bases: [`BaseSamplerV1`](qiskit.primitives.BaseSamplerV1 "qiskit.primitives.base.base_sampler.BaseSamplerV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.md b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.md index 9594982a935..bccbf579525 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.md +++ b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV1 -`qiskit.primitives.BaseEstimatorV1(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimatorV1(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_estimator.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.md b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.md index a763a682c3c..37c73956b5b 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.md +++ b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 -`qiskit.primitives.BaseEstimatorV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimatorV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_estimator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.md b/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.md index 8934d902e63..9f445074e21 100644 --- a/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.md +++ b/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob -`qiskit.primitives.BasePrimitiveJob(job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_primitive_job.py "view source code") +`qiskit.primitives.BasePrimitiveJob(job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_primitive_job.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)"), [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`ResultT`, `StatusT`] diff --git a/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.md b/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.md index 8755374ce0f..af56a395522 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.md +++ b/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 -`qiskit.primitives.BaseSamplerV1(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSamplerV1(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_sampler.py "view source code") Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.md b/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.md index 8c0f5497251..a268cf8071d 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.md +++ b/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 -`qiskit.primitives.BaseSamplerV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSamplerV2` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_sampler.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.primitives.BitArray.md b/docs/api/qiskit/qiskit.primitives.BitArray.md index e6ebc544cb3..06fdae961ae 100644 --- a/docs/api/qiskit/qiskit.primitives.BitArray.md +++ b/docs/api/qiskit/qiskit.primitives.BitArray.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BitArray -`qiskit.primitives.BitArray(array, num_bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/bit_array.py "view source code") +`qiskit.primitives.BitArray(array, num_bits)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/bit_array.py "view source code") Bases: `ShapedMixin` diff --git a/docs/api/qiskit/qiskit.primitives.DataBin.md b/docs/api/qiskit/qiskit.primitives.DataBin.md index dd38c7b10df..4a02c72abc9 100644 --- a/docs/api/qiskit/qiskit.primitives.DataBin.md +++ b/docs/api/qiskit/qiskit.primitives.DataBin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.DataBin -`qiskit.primitives.DataBin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/data_bin.py "view source code") +`qiskit.primitives.DataBin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/data_bin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.primitives.Estimator.md b/docs/api/qiskit/qiskit.primitives.Estimator.md index 6f1a183a9fc..445228981e8 100644 --- a/docs/api/qiskit/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`qiskit.primitives.Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/estimator.py "view source code") +`qiskit.primitives.Estimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/estimator.py "view source code") Bases: [`BaseEstimatorV1`](qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.base.base_estimator.BaseEstimatorV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/qiskit.primitives.EstimatorResult.md index 0fe28511a1e..a1395bc0a30 100644 --- a/docs/api/qiskit/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`qiskit.primitives.EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/estimator_result.py "view source code") +`qiskit.primitives.EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/estimator_result.py "view source code") Bases: `_BasePrimitiveResult` diff --git a/docs/api/qiskit/qiskit.primitives.PrimitiveJob.md b/docs/api/qiskit/qiskit.primitives.PrimitiveJob.md index 75d0bc0fe15..5a1bb386b67 100644 --- a/docs/api/qiskit/qiskit.primitives.PrimitiveJob.md +++ b/docs/api/qiskit/qiskit.primitives.PrimitiveJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.PrimitiveJob -`qiskit.primitives.PrimitiveJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/primitive_job.py "view source code") +`qiskit.primitives.PrimitiveJob(function, *args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/primitive_job.py "view source code") Bases: [`BasePrimitiveJob`](qiskit.primitives.BasePrimitiveJob "qiskit.primitives.base.base_primitive_job.BasePrimitiveJob")\[`ResultT`, [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.jobstatus.JobStatus")] diff --git a/docs/api/qiskit/qiskit.primitives.PrimitiveResult.md b/docs/api/qiskit/qiskit.primitives.PrimitiveResult.md index 4379f0fa39e..d27afc1c2cb 100644 --- a/docs/api/qiskit/qiskit.primitives.PrimitiveResult.md +++ b/docs/api/qiskit/qiskit.primitives.PrimitiveResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.PrimitiveResult -`qiskit.primitives.PrimitiveResult(pub_results, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/primitive_result.py "view source code") +`qiskit.primitives.PrimitiveResult(pub_results, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/primitive_result.py "view source code") Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/qiskit.primitives.PubResult.md b/docs/api/qiskit/qiskit.primitives.PubResult.md index 534e4630974..5dac4aacfc5 100644 --- a/docs/api/qiskit/qiskit.primitives.PubResult.md +++ b/docs/api/qiskit/qiskit.primitives.PubResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.PubResult -`qiskit.primitives.PubResult(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/pub_result.py "view source code") +`qiskit.primitives.PubResult(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/containers/pub_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.primitives.Sampler.md b/docs/api/qiskit/qiskit.primitives.Sampler.md index 47e2bf890ae..dbb4efe6ad2 100644 --- a/docs/api/qiskit/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`qiskit.primitives.Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/sampler.py "view source code") +`qiskit.primitives.Sampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/sampler.py "view source code") Bases: [`BaseSamplerV1`](qiskit.primitives.BaseSamplerV1 "qiskit.primitives.base.base_sampler.BaseSamplerV1")\[[`PrimitiveJob`](qiskit.primitives.PrimitiveJob "qiskit.primitives.primitive_job.PrimitiveJob")\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/qiskit.primitives.SamplerResult.md index 5374a2b1c63..678b8dd4f5a 100644 --- a/docs/api/qiskit/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`qiskit.primitives.SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/sampler_result.py "view source code") +`qiskit.primitives.SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/sampler_result.py "view source code") Bases: `_BasePrimitiveResult` diff --git a/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.md b/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.md index 6ab2a7a7dde..6d5285f32ef 100644 --- a/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.md +++ b/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.StatevectorEstimator -`qiskit.primitives.StatevectorEstimator(*, default_precision=0.0, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/statevector_estimator.py "view source code") +`qiskit.primitives.StatevectorEstimator(*, default_precision=0.0, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/statevector_estimator.py "view source code") Bases: [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.base.base_estimator.BaseEstimatorV2") diff --git a/docs/api/qiskit/qiskit.primitives.StatevectorSampler.md b/docs/api/qiskit/qiskit.primitives.StatevectorSampler.md index 0e53f8683fe..0742016bd3c 100644 --- a/docs/api/qiskit/qiskit.primitives.StatevectorSampler.md +++ b/docs/api/qiskit/qiskit.primitives.StatevectorSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.StatevectorSampler -`qiskit.primitives.StatevectorSampler(*, default_shots=1024, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/statevector_sampler.py "view source code") +`qiskit.primitives.StatevectorSampler(*, default_shots=1024, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/statevector_sampler.py "view source code") Bases: [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.base.base_sampler.BaseSamplerV2") diff --git a/docs/api/qiskit/qiskit.providers.Backend.md b/docs/api/qiskit/qiskit.providers.Backend.md index 7d2d594433b..c286dace493 100644 --- a/docs/api/qiskit/qiskit.providers.Backend.md +++ b/docs/api/qiskit/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`qiskit.providers.Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") +`qiskit.providers.Backend` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.BackendV1.md b/docs/api/qiskit/qiskit.providers.BackendV1.md index d2defaa57c1..9d82507474a 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`qiskit.providers.BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.BackendV2.md b/docs/api/qiskit/qiskit.providers.BackendV2.md index cce9d45ce57..20aa06cbb92 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/qiskit.providers.BackendV2Converter.md index ec4c6c3be22..dc63409ad46 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=True, filter_faulty=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=True, filter_faulty=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend_compat.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.Job.md b/docs/api/qiskit/qiskit.providers.Job.md index 2ab509e4709..c6398c1e4bc 100644 --- a/docs/api/qiskit/qiskit.providers.Job.md +++ b/docs/api/qiskit/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`qiskit.providers.Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/job.py "view source code") +`qiskit.providers.Job` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/job.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.JobStatus.md b/docs/api/qiskit/qiskit.providers.JobStatus.md index 32343d91933..9747244c5bb 100644 --- a/docs/api/qiskit/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`qiskit.providers.JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/jobstatus.py "view source code") +`qiskit.providers.JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/jobstatus.py "view source code") Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.JobV1.md b/docs/api/qiskit/qiskit.providers.JobV1.md index bf0e70297ec..bb18ac950b8 100644 --- a/docs/api/qiskit/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`qiskit.providers.JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/job.py "view source code") +`qiskit.providers.JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/job.py "view source code") Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.Options.md b/docs/api/qiskit/qiskit.providers.Options.md index d2a953db282..d68cd3d0da2 100644 --- a/docs/api/qiskit/qiskit.providers.Options.md +++ b/docs/api/qiskit/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`qiskit.providers.Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/options.py "view source code") +`qiskit.providers.Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/options.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.Provider.md b/docs/api/qiskit/qiskit.providers.Provider.md index c0d30d2319a..9f6d59705b0 100644 --- a/docs/api/qiskit/qiskit.providers.Provider.md +++ b/docs/api/qiskit/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`qiskit.providers.Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/provider.py "view source code") +`qiskit.providers.Provider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/provider.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.ProviderV1.md b/docs/api/qiskit/qiskit.providers.ProviderV1.md index a9f930d9ac4..e41e43af0fe 100644 --- a/docs/api/qiskit/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`qiskit.providers.ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/provider.py "view source code") +`qiskit.providers.ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/provider.py "view source code") Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.QubitProperties.md b/docs/api/qiskit/qiskit.providers.QubitProperties.md index f57eb83fb05..0cfa542d478 100644 --- a/docs/api/qiskit/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") +`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.md b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.md index 00921081ff7..ef881cfff76 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.md +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider -`qiskit.providers.basic_provider.BasicProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/basic_provider.py "view source code") +`qiskit.providers.basic_provider.BasicProvider` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/basic_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.md b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.md index 45cc7f0d2f5..71dde3d2a9a 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.md +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError -`qiskit.providers.basic_provider.BasicProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/exceptions.py "view source code") +`qiskit.providers.basic_provider.BasicProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/exceptions.py "view source code") Base class for errors raised by the Basic Provider. diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.md b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.md index dfaf1a1966a..fb04179cfab 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.md +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob -`qiskit.providers.basic_provider.BasicProviderJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/basic_provider_job.py "view source code") +`qiskit.providers.basic_provider.BasicProviderJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/basic_provider_job.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.md b/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.md index 26135176907..825f774cc27 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.md +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator -`qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/basic_simulator.py "view source code") +`qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/basic_provider/basic_simulator.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.convert_to_target.md b/docs/api/qiskit/qiskit.providers.convert_to_target.md index ea4a5a015b6..94fbd0ea566 100644 --- a/docs/api/qiskit/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=True, filter_faulty=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=True, filter_faulty=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/backend_compat.py "view source code") Decode transpiler target from backend data set. diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake127QPulseV1.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake127QPulseV1.md index 11538dc0d01..c6ada4acf6c 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake127QPulseV1.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake127QPulseV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake127QPulseV1 -`qiskit.providers.fake_provider.Fake127QPulseV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/fake_127q_pulse_v1.py "view source code") +`qiskit.providers.fake_provider.Fake127QPulseV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/fake_127q_pulse_v1.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md index 34151f1410a..ef8d9a4e8c8 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`qiskit.providers.fake_provider.Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_1q.py "view source code") +`qiskit.providers.fake_provider.Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake20QV1.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake20QV1.md index c9044bef1ee..5c5f6dc9c7b 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake20QV1.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake20QV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake20QV1 -`qiskit.providers.fake_provider.Fake20QV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_20q/fake_20q.py "view source code") +`qiskit.providers.fake_provider.Fake20QV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_20q/fake_20q.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake27QPulseV1.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake27QPulseV1.md index 0c2ca85d595..de378b234e3 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake27QPulseV1.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake27QPulseV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake27QPulseV1 -`qiskit.providers.fake_provider.Fake27QPulseV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/fake_27q_pulse_v1.py "view source code") +`qiskit.providers.fake_provider.Fake27QPulseV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/fake_27q_pulse_v1.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake5QV1.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake5QV1.md index d5892edf2e9..7223fd0fa90 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake5QV1.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake5QV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake5QV1 -`qiskit.providers.fake_provider.Fake5QV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_5q/fake_5q_v1.py "view source code") +`qiskit.providers.fake_provider.Fake5QV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_5q/fake_5q_v1.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake7QPulseV1.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake7QPulseV1.md index 321b1a7898c..c03ccb7675c 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake7QPulseV1.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake7QPulseV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake7QPulseV1 -`qiskit.providers.fake_provider.Fake7QPulseV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/fake_7q_pulse_v1.py "view source code") +`qiskit.providers.fake_provider.Fake7QPulseV1` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/fake_7q_pulse_v1.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 98933f30ece..124d0a284cc 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`qiskit.providers.fake_provider.FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index 1cecdf7b69a..50c3990cfe1 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`qiskit.providers.fake_provider.FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.md index 73f3fe291b9..f3d28594fa5 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 -`qiskit.providers.fake_provider.GenericBackendV2(num_qubits, basis_gates=None, *, coupling_map=None, control_flow=False, calibrate_instructions=None, dtm=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/generic_backend_v2.py "view source code") +`qiskit.providers.fake_provider.GenericBackendV2(num_qubits, basis_gates=None, *, coupling_map=None, control_flow=False, calibrate_instructions=None, dtm=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/generic_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md index 9dc841eaa88..10e714bf45b 100644 --- a/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/qiskit.providers.models.BackendProperties.md index 88562a63874..e6c0c53630f 100644 --- a/docs/api/qiskit/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/qiskit.providers.models.BackendStatus.md index e80f8392941..99097cc19e0 100644 --- a/docs/api/qiskit/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendstatus.py "view source code") +`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.Command.md b/docs/api/qiskit/qiskit.providers.models.Command.md index 1be4b0e372d..72f0aecd491 100644 --- a/docs/api/qiskit/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/qiskit.providers.models.GateConfig.md index 54c2d7efe37..7013bf41454 100644 --- a/docs/api/qiskit/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.GateProperties.md b/docs/api/qiskit/qiskit.providers.models.GateProperties.md index af63a157802..cbb2123f948 100644 --- a/docs/api/qiskit/qiskit.providers.models.GateProperties.md +++ b/docs/api/qiskit/qiskit.providers.models.GateProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateProperties -`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/qiskit.providers.models.JobStatus.md index 68cd9bb92d6..a24e3331d81 100644 --- a/docs/api/qiskit/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/jobstatus.py "view source code") +`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/jobstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.Nduv.md b/docs/api/qiskit/qiskit.providers.models.Nduv.md index 443decce647..3c4e366d743 100644 --- a/docs/api/qiskit/qiskit.providers.models.Nduv.md +++ b/docs/api/qiskit/qiskit.providers.models.Nduv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Nduv -`qiskit.providers.models.Nduv(date, name, unit, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.Nduv(date, name, unit, value)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md index d3acf21c910..5b1569b7806 100644 --- a/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md index 1df2638c3c9..9c8aa01e071 100644 --- a/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md index 8ce5eba0f5a..8a71703f869 100644 --- a/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/qiskit.providers.models.UchannelLO.md index 3c931043ee7..b99747d48e6 100644 --- a/docs/api/qiskit/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`qiskit.providers.models.UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md index ea455dff1ab..bf5df89e835 100644 --- a/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`qiskit.pulse.InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instruction_schedule_map.py "view source code") +`qiskit.pulse.InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.Schedule.md b/docs/api/qiskit/qiskit.pulse.Schedule.md index 4cbf0bbe18a..703b2bdb5a8 100644 --- a/docs/api/qiskit/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md index 02275103158..1c3e4540897 100644 --- a/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md index 963fb687045..df3071a1b19 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md index d79d2a41ef9..a443f9fbaf2 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`qiskit.pulse.channels.ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.ControlChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md index 84be3f57ca0..ee20c9c8b56 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`qiskit.pulse.channels.DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.DriveChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md index 8fa1709d19c..f4ea72055cd 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md index 32cf4d2f147..ec0488936f7 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`qiskit.pulse.channels.MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MemorySlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md index 24ef077c940..4326ced2e96 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md index c37756b6a8b..f60cab82eb0 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md index 8e42b599b6f..fb21711302d 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/acquire.py "view source code") +`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/qiskit.pulse.instructions.Delay.md index c159ae2429b..61a40ed5d32 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`qiskit.pulse.instructions.Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/delay.py "view source code") +`qiskit.pulse.instructions.Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/delay.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/qiskit.pulse.instructions.Play.md index c93f76404bb..804d7559840 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`qiskit.pulse.instructions.Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/play.py "view source code") +`qiskit.pulse.instructions.Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/play.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/qiskit.pulse.instructions.Reference.md index 950aa7683f9..15b37236b3b 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`qiskit.pulse.instructions.Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/reference.py "view source code") +`qiskit.pulse.instructions.Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/reference.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md index 96ca357cc5f..ad4418ff826 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md index 4441d61074b..560a19638b8 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md index ff8725f8f8d..0b726187a5d 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md index 634f92b7748..dad429e6037 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md index aa80ae519ed..d07c37914d8 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md index 6e88b21477e..34bdc20b1a2 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/snapshot.py "view source code") +`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md index 51940f5f3af..0270bff7405 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md index 3f8f8b929f3..9b0552c17fd 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`qiskit.pulse.library.Constant(duration, amp, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Constant(duration, amp, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md index 0906017d97c..cfbd3d067ac 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") A cosine pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md index 56aee3ad898..ba2d36b5673 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md b/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md index 07efd2966f5..3f1d9a2fa6f 100644 --- a/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md +++ b/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv -`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized Gaussian derivative pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md index 73eb3056905..bc65d123227 100644 --- a/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md index 05b2d41c060..c4948bd0795 100644 --- a/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md index 062f32c32ce..9e0fd201196 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md index feec3ab39c6..a846a36621c 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") A sawtooth pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md b/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md index 16d2705ea43..6ab6e34bd0f 100644 --- a/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md +++ b/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.SechDeriv -`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech derivative pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md b/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md index 4d47d4d10df..eb65612b577 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sech -`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md index ede3090a9a2..675a0ccaead 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") A sinusoidal pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md b/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md index 92105b3439b..feac44f7010 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Square -`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") A square wave pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md index 520fe90d2c7..f87604c4ebf 100644 --- a/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md index d326c4313df..600861868b1 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") A triangle wave pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/qiskit.pulse.library.Waveform.md index 0e37751a7f9..7936acdfeef 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/waveform.py "view source code") +`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/waveform.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md b/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md index 399127c1482..77639608a27 100644 --- a/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md +++ b/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo -`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/library/symbolic_pulses.py "view source code") An echoed Gaussian square pulse with an active tone overlaid on it. diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md index 6d67cca6cc1..50d3f6982d3 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`qiskit.pulse.transforms.AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md index abea2edf19b..2c5c44ef9aa 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`qiskit.pulse.transforms.AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md index 9e231331aa8..516e5c0b515 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`qiskit.pulse.transforms.AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md index 18f136b9f5c..8dcf827640a 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`qiskit.pulse.transforms.AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md index 448b0d3a283..319f698cfd4 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`qiskit.pulse.transforms.AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/qiskit.qobj.GateCalibration.md index 6bd2bf91029..5fe6a717b35 100644 --- a/docs/api/qiskit/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`qiskit.qobj.GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md index 40677679d75..49f0adae700 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`qiskit.qobj.PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/qiskit.qobj.PulseQobj.md index f6412186a11..42cfb05cadf 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md index 1a37b901024..a24eb4c1e8b 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md index 11a750521d2..619adfc000a 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md index 97939b0f442..c479548dbc1 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md index 4b650e72fb5..d7c3b2b31ec 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md index 68aae9f8739..9b2374b7249 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`qiskit.qobj.QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/qiskit.qobj.QasmQobj.md index 1d93403219d..25bf7fde5e2 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md index 60b39f3eb86..430c40de44c 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md index a48dd24a41a..9444a1b6e65 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md index 017b231b65e..ec4a1a5f95e 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md index 06010de146e..98a2909137e 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md index bd888f57d88..94eb5cf39b2 100644 --- a/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`qiskit.qobj.QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/common.py "view source code") Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/qiskit.qobj.QobjHeader.md index 0601628af9b..30bf9da0ad4 100644 --- a/docs/api/qiskit/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`qiskit.qobj.QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/common.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md index d1303344237..55e14f97c53 100644 --- a/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`qiskit.qobj.QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md index 897d3290473..8507ca4621f 100644 --- a/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Chi.md b/docs/api/qiskit/qiskit.quantum_info.Chi.md index b5fe3270b72..a92dd21af3d 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/chi.py "view source code") +`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Choi.md b/docs/api/qiskit/qiskit.quantum_info.Choi.md index 58ec2639ce7..9d32c288039 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/choi.py "view source code") +`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/qiskit.quantum_info.Clifford.md index 0c2976d8d4a..3f717f3bf20 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`qiskit.quantum_info.Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`qiskit.quantum_info.Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md index b32be37b786..72f7c6b4d2e 100644 --- a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`qiskit.quantum_info.DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/densitymatrix.py "view source code") +`qiskit.quantum_info.DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/qiskit.quantum_info.Kraus.md index 5bc240fb806..7a0b2afefe7 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Operator.md b/docs/api/qiskit/qiskit.quantum_info.Operator.md index 681ebbd6a4b..859b7c3f21c 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/operator.py "view source code") +`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/operator.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/qiskit.quantum_info.PTM.md b/docs/api/qiskit/qiskit.quantum_info.PTM.md index b0c29567b5a..812c11193cb 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/qiskit.quantum_info.Pauli.md index 8b8c30e030e..93f033247b1 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`qiskit.quantum_info.Pauli(data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`qiskit.quantum_info.Pauli(data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `BasePauli` diff --git a/docs/api/qiskit/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/qiskit.quantum_info.PauliList.md index 58de6047ff0..0221d5d9a0e 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`qiskit.quantum_info.PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`qiskit.quantum_info.PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `BasePauli`, `LinearMixin`, `GroupMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/qiskit.quantum_info.Quaternion.md index e27f29e1b87..5cb048a42e3 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`qiskit.quantum_info.Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/quaternion.py "view source code") +`qiskit.quantum_info.Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/quaternion.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md index 13dccc4c96c..6cf5d72c375 100644 --- a/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/scalar_op.py "view source code") +`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md index 1a9a8acf050..8c27918442e 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md index 3dadbf9a7ab..0fa8f12e5df 100644 --- a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`qiskit.quantum_info.StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`qiskit.quantum_info.StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `QuantumState` diff --git a/docs/api/qiskit/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/qiskit.quantum_info.Statevector.md index 4140dddb2ce..0d53d436243 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`qiskit.quantum_info.Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/statevector.py "view source code") +`qiskit.quantum_info.Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/statevector.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/qiskit.quantum_info.Stinespring.md index 670a301f83f..303d5c20a09 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/qiskit.quantum_info.SuperOp.md index 41f3534c5a0..ffb8d77cd69 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/superop.py "view source code") +`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md index f04e39b68fe..95e82859d24 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md index 170305757a1..6b16b06e559 100644 --- a/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md index 18ac294222d..63651a483a2 100644 --- a/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`qiskit.result.BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`qiskit.result.BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md index 4497ab09e87..7d8e7e18a82 100644 --- a/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/qiskit.result.Counts.md b/docs/api/qiskit/qiskit.result.Counts.md index 2c77bcc75f9..e12b3bd0040 100644 --- a/docs/api/qiskit/qiskit.result.Counts.md +++ b/docs/api/qiskit/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/counts.py "view source code") +`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/counts.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md index e44aa66bf36..8d4e5fc3a1c 100644 --- a/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/qiskit.result.ProbDistribution.md b/docs/api/qiskit/qiskit.result.ProbDistribution.md index f52c88a33fb..d52fd707bf1 100644 --- a/docs/api/qiskit/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`qiskit.result.ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/distributions/probability.py "view source code") +`qiskit.result.ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/distributions/probability.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/qiskit.result.QuasiDistribution.md index 433559a3999..11478c4d938 100644 --- a/docs/api/qiskit/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/distributions/quasi.py "view source code") +`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/distributions/quasi.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.Result.md b/docs/api/qiskit/qiskit.result.Result.md index 6ca1397d0ea..b8196ff24eb 100644 --- a/docs/api/qiskit/qiskit.result.Result.md +++ b/docs/api/qiskit/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/result.py "view source code") +`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.ResultError.md b/docs/api/qiskit/qiskit.result.ResultError.md index f099eab0d8b..7e2738ff17d 100644 --- a/docs/api/qiskit/qiskit.result.ResultError.md +++ b/docs/api/qiskit/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`qiskit.result.ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/exceptions.py "view source code") +`qiskit.result.ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md index e559e8732a0..99bf70f90dd 100644 --- a/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`qiskit.synthesis.EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`qiskit.synthesis.EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/qiskit.synthesis.LieTrotter.md index 83905d1c2bb..b400feecbc4 100644 --- a/docs/api/qiskit/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md index 85ddd158e92..018335b36e9 100644 --- a/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`qiskit.synthesis.MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`qiskit.synthesis.MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.md b/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.md index 0e0aa940f83..be083adb3f7 100644 --- a/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer -`qiskit.synthesis.OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/one_qubit/one_qubit_decompose.py "view source code") +`qiskit.synthesis.OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/one_qubit/one_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/qiskit.synthesis.ProductFormula.md index 213f8376af7..5d1b8c96b27 100644 --- a/docs/api/qiskit/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/product_formula.py "view source code") +`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/qiskit.synthesis.QDrift.md b/docs/api/qiskit/qiskit.synthesis.QDrift.md index 2f9d523eb97..034f0c80f33 100644 --- a/docs/api/qiskit/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/qdrift.py "view source code") +`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md index 83dce1b921e..65650fd848c 100644 --- a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md index 94d62003cb2..29ef7333989 100644 --- a/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.md b/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.md index d36a842a6f1..5127859d4dc 100644 --- a/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer -`qiskit.synthesis.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") +`qiskit.synthesis.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.md b/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.md index b19e462a8b4..3894f777587 100644 --- a/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.md +++ b/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.TwoQubitWeylDecomposition -`qiskit.synthesis.TwoQubitWeylDecomposition(unitary_matrix, *, fidelity=0.999999999, _unpickling=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") +`qiskit.synthesis.TwoQubitWeylDecomposition(unitary_matrix, *, fidelity=0.999999999, _unpickling=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.XXDecomposer.md b/docs/api/qiskit/qiskit.synthesis.XXDecomposer.md index 7603257f737..3a6c43405a8 100644 --- a/docs/api/qiskit/qiskit.synthesis.XXDecomposer.md +++ b/docs/api/qiskit/qiskit.synthesis.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.XXDecomposer -`qiskit.synthesis.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/two_qubit/xx_decompose/decomposer.py "view source code") +`qiskit.synthesis.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/two_qubit/xx_decompose/decomposer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.md index 70139a03627..376b9f7072b 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC -`qiskit.synthesis.unitary.aqc.AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/aqc.py "view source code") +`qiskit.synthesis.unitary.aqc.AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/aqc.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md index 785b2629ca4..48aca3e6b85 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit -`qiskit.synthesis.unitary.aqc.ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/approximate.py "view source code") +`qiskit.synthesis.unitary.aqc.ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/approximate.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md index dd8e8c1b434..a13a2ce683e 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective -`qiskit.synthesis.unitary.aqc.ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/approximate.py "view source code") +`qiskit.synthesis.unitary.aqc.ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/approximate.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md index 6832aa22951..fefec6e20d8 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit -`qiskit.synthesis.unitary.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py "view source code") +`qiskit.synthesis.unitary.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py "view source code") Bases: [`ApproximateCircuit`](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.approximate.ApproximateCircuit") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md index b335662b4cd..55c7415a83b 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitObjective -`qiskit.synthesis.unitary.aqc.CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") +`qiskit.synthesis.unitary.aqc.CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md index fdd54051215..c680611f391 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective -`qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") +`qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md index 54127746fb0..85af742d50b 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective -`qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py "view source code") +`qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.md b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.md index 965fe79424e..f3fbae4162a 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.md +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.md @@ -131,7 +131,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.synthesis.unitary.aqc -`qiskit.synthesis.unitary.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_structures.py "view source code") +`qiskit.synthesis.unitary.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md index d672b97b949..bea45037075 100644 --- a/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`qiskit.transpiler.AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/qiskit.transpiler.CouplingMap.md index a84e16ea9b9..c2445165cdc 100644 --- a/docs/api/qiskit/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/coupling.py "view source code") +`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/coupling.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md index 4178494f8cd..d80e4792a5f 100644 --- a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/instruction_durations.py "view source code") +`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/instruction_durations.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md index ea2e7bc5d3c..ca42433fbb1 100644 --- a/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/target.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.Layout.md b/docs/api/qiskit/qiskit.transpiler.Layout.md index 3449347c7fc..38d7bc236cd 100644 --- a/docs/api/qiskit/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`qiskit.transpiler.Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.PassManager.md b/docs/api/qiskit/qiskit.transpiler.PassManager.md index 852aceb6040..0d6e5de980c 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passmanager.py "view source code") Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") diff --git a/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md index d53af0a3474..6dc4a8592f6 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passmanager_config.py "view source code") +`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passmanager_config.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md index 17935254285..96d4b7798af 100644 --- a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passmanager.py "view source code") Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/qiskit.transpiler.Target.md b/docs/api/qiskit/qiskit.transpiler.Target.md index b3690479892..b69bde0267f 100644 --- a/docs/api/qiskit/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/target.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/qiskit.transpiler.TransformationPass.md index 8c0fc35e4b4..6115c99c73b 100644 --- a/docs/api/qiskit/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`qiskit.transpiler.TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md index d4a7cd3ff54..8a16c032e5a 100644 --- a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md index be16f37045c..aacb8ba3630 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 90970877ba3..6dedf6b3949 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md index 0b8d786aec3..2753493f678 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index d1fcc8d7188..7a34734fbc6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md index 17b96d66361..6528a25b80e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md index 5f08b0102dd..634aad77359 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 7f750c60e42..08bbecb06a1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md index 19ccc712ee6..34e08389d27 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md index 1c4ea56c208..d2161a5db7e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md index 9fade7ddeaa..4c1ef98d373 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md index b0c5c29a242..10f1af6c8c8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md index 350216bc44b..f1a2d65d1fc 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md index b6cb5391297..6db6029262c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`qiskit.transpiler.passes.CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/check_map.py "view source code") +`qiskit.transpiler.passes.CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md index 106a5d40813..af5e18698bd 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md index 374c37759ff..c2844470dd4 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md index c6f951fd3fb..4e75b1d590d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md index 5be507ab471..b446fc106aa 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md index 25cd909b146..c185f3b8ad7 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md index 54fde584d52..e74832f8e23 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md index d930a4dbbaf..38c86d021bf 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 3f0e92e9f14..f0ae7b52858 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md index c81aba323c3..287b9a9e842 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md index 6d532cf16ee..37e6bf8d19e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md index def0cc4c098..eee7db9f009 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md index 607a6e07b17..1c375867947 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 68ae069757c..f51a1c588b6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md index fe3dc3181bc..388fcaa8b69 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`qiskit.transpiler.passes.CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`qiskit.transpiler.passes.CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md index e270eaa1c50..025287c3689 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md index 6bdc5bdf722..04ede6a046b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md index 326c6b0613e..6d9e247d3f5 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md index e0fae7defe5..3dcf8ba4111 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`qiskit.transpiler.passes.Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/decompose.py "view source code") +`qiskit.transpiler.passes.Decompose(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md index f2df77cebe8..ab0a59760ab 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/qiskit.transpiler.passes.Depth.md index c9c6bf60b2f..628a1fa6ea9 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`qiskit.transpiler.passes.Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/depth.py "view source code") +`qiskit.transpiler.passes.Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md index d74d26e3693..d90a3262e5e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 55a88cc764c..ca69eaef44c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md index 579caa49a91..c4af3fd3587 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.md b/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.md index c850d3a61f1..4add8393f59 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes -`qiskit.transpiler.passes.FilterOpNodes(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/filter_op_nodes.py "view source code") +`qiskit.transpiler.passes.FilterOpNodes(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/filter_op_nodes.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md index cbc8052c92e..c3cc5a853e8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md index 7b525e611df..c75fc589570 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md index c2815878364..2d3e32e01c0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`qiskit.transpiler.passes.GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`qiskit.transpiler.passes.GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md index 0d31f1a3360..53669e0efc8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.md b/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.md index 42e9112bc30..5b682302669 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HLSConfig -`qiskit.transpiler.passes.HLSConfig(use_default_on_unspecified=True, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HLSConfig(use_default_on_unspecified=True, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md index d63f7d5fb94..f476787997d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md index 53904bb29a6..6ac0f74d5a8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md index 2c819019cb5..d14e790f772 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md index 8aa08f464d2..5a723de7e53 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md index 6dcbd265813..10cc86ec141 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index c92e52cbfa7..b74910749ba 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md index 3a48373bb77..08e847d3f57 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md index a4589195a26..da50f2449e0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md index 04cf3a8916c..2e4d907b94c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md b/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md index ca01e5895f8..3ee01e748ff 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle -`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") +`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md index 0f8fb49b42e..9886d394f17 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md index 1a429bd73de..f4b8cbebb7e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 43d848b630d..d6470944c1a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index c531cc43a12..36a753a7514 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.md b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.md index a524de33de8..53d429947ab 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated -`qiskit.transpiler.passes.OptimizeAnnotated(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_annotated.py "view source code") +`qiskit.transpiler.passes.OptimizeAnnotated(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_annotated.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md index 7c591080444..60f5bb90013 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md index 3e374659cc8..39cf24b63cc 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`qiskit.transpiler.passes.PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`qiskit.transpiler.passes.PadDelay(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md index cab0b45cc3d..5a46996f777 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md index 78da1e5ad58..18de2ca3a78 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`qiskit.transpiler.passes.PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`qiskit.transpiler.passes.PulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md b/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md index e950b4cd571..13a815c85b8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder -`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") +`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 74a543d7bf0..3b36b737a5e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 56e5b9ac9f6..7cb1eb82e39 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md index fcdff5eb186..bfb51aa2da3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 255e77c5228..591aaa84163 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 8717987be94..06e2db36ebe 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md index c77826d3374..cd7cc086b62 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 12275bba2ac..4adbbe61744 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md index fb5ed8c539e..a20d1408991 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md index 74fbbf8dd03..327b5d2612e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout -`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") +`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md index 07ac20eddc5..1bcc0300a9f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md index 9167499a361..efbd4a76af0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md index daa527ea2d4..fc3069e700d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`qiskit.transpiler.passes.SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`qiskit.transpiler.passes.SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/qiskit.transpiler.passes.Size.md index 11a8f3506dc..96c96c638e4 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`qiskit.transpiler.passes.Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/size.py "view source code") +`qiskit.transpiler.passes.Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md index 8e17a97e8a4..92cdc2281f8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md index 9b0b9f308b9..6f2829867ea 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md index ca91b0facec..4befa0d1384 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md index c78aaac7a71..2eac935f800 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md index e8cd704d52f..21adfb69dc6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md index d89d5c0a6a1..2b7057e806f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md index dd2db82b466..08010533e4c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md index 4c4f22673fd..ccaf249308b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 88cd56e7cc5..e8eb9fb9051 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md index cd01b966493..b382e723b03 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md index 96513a7470e..1fe597bd44e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md index 10a4185028c..26fe872ed4a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md index 18e030fcf83..6636ff02934 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/qiskit.transpiler.passes.Width.md index be7a948bfff..d1a5001e039 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`qiskit.transpiler.passes.Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/width.py "view source code") +`qiskit.transpiler.passes.Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.md index 3ff8f465802..826d3a7b387 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugi -`qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/aqc_plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.aqc_plugin.AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/aqc_plugin.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.md index 5fad1fbe96e..f31b30db1eb 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynt -`qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.ACGSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.md index 902eee386f4..3ba06f66370 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynth -`qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.AGSynthesisClifford` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.md index 7f29987caa0..06dc8a6a88a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynth -`qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.BMSynthesisClifford` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.md index a8c4eb92461..10aaade8735 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSy -`qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.BasicSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.md index 040520f323a..5acd7e6b0e4 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.Default -`qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisClifford` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.md index f6f722dd0e3..7c7a923775f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.Default -`qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.DefaultSynthesisLinearFunction` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.md index 176654c982b..2a106a3feed 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedyS -`qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.GreedySynthesisClifford` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.md index 5729b9db985..8b8be1c38bd 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynt -`qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisLinearFunction` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.md index d702d08857d..0dba6b318fd 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynt -`qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.KMSSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.md index 3b03c3bde21..48a69e15af7 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLn -`qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerLnnSynthesisClifford` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.md index e9a1ad76bf5..a8d5f9d8ae3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSy -`qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.LayerSynthesisClifford` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.md index cb32834d45c..af1ece566a6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynt -`qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.PMHSynthesisLinearFunction` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.md index ae09ced3ecf..a37fefab311 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSw -`qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.high_level_synthesis.TokenSwapperSynthesisPermutation` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 122292ca9b7..026825c24c5 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index 5a60c9c491c..d8892eae446 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index f06c98bb2b9..060b78935a8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 852a54d65a4..abd88dbd4c3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md index cd03d449267..d7953464e2b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_ -`qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of plugin names installed for a given high level object name diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 909926f78ee..3948779afd8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.md index af3960b06ec..4cba97fd2ea 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.Sol -`qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.md index 6f03e22fb6e..b8773e0e870 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUni -`qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index ee3278ce559..151b7f84dc2 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index 2af5bf17061..4f44d05d41f 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/qiskit.visualization.array_to_latex.md index 9570532810b..558f3e2d701 100644 --- a/docs/api/qiskit/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/array.py "view source code") +`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/qiskit.visualization.circuit_drawer.md index 7ac8fccbbef..66d6a9aaea8 100644 --- a/docs/api/qiskit/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/qiskit.visualization.dag_drawer.md index 30d4a6d4208..4448113391d 100644 --- a/docs/api/qiskit/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/dag_visualization.py "view source code") +`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md index 34253360ff2..37fb85b9c55 100644 --- a/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/pass_manager_visualization.py "view source code") +`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md index 12ffc464953..513c96a37e6 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md index 69f844c94ed..44b8079a905 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md index e13b26b6407..54f63c920f3 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md index a12168d9d71..2d33d0a115f 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/qiskit.visualization.plot_distribution.md index b47160302d9..c62b60c2d04 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/qiskit.visualization.plot_error_map.md index 3f8278ae6de..eed857656df 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/qiskit.visualization.plot_gate_map.md index 0774ab8bd61..94698875cd9 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/qiskit.visualization.plot_histogram.md index 52ba0d67673..0704f0b2480 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/qiskit.visualization.plot_state_city.md index e575c43866c..cdb698d07c6 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md index 08f0f2a4289..fb4058d2e69 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md index 7f1c83809af..bbfd48a6ecc 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") Plot the Pauli-vector representation of a quantum state as bar graph. diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md index 4abb1e7d5e8..980c329d2e8 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/qiskit.visualization.visualize_transition.md index c81862c7581..32756521967 100644 --- a/docs/api/qiskit/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/transition_visualization.py "view source code") +`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/qpy.md b/docs/api/qiskit/qpy.md index 7530d2a1215..d9a78396386 100644 --- a/docs/api/qiskit/qpy.md +++ b/docs/api/qiskit/qpy.md @@ -59,7 +59,7 @@ and then loading that file will return a list with all the circuits -`qiskit.qpy.load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/interface.py "view source code") Load a QPY binary file @@ -106,7 +106,7 @@ The list of Qiskit programs contained in the QPY data. A list is always returned -`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=True, version=11)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=True, version=11)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file @@ -172,7 +172,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski -`qiskit.qpy.QpyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QpyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/exceptions.py "view source code") Errors raised by the qpy module. @@ -210,7 +210,7 @@ If a feature being loaded is deprecated in the corresponding qiskit release, QPY -`qiskit.qpy.QPYLoadingDeprecatedFeatureWarning`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QPYLoadingDeprecatedFeatureWarning` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qpy/exceptions.py "view source code") Visible deprecation warning for QPY loading functions without a stable point in the call stack. diff --git a/docs/api/qiskit/quantum_info.md b/docs/api/qiskit/quantum_info.md index 1dde924133c..384d4ebd7a8 100644 --- a/docs/api/qiskit/quantum_info.md +++ b/docs/api/qiskit/quantum_info.md @@ -60,7 +60,7 @@ python_api_name: qiskit.quantum_info -`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. @@ -102,7 +102,7 @@ The average gate fidelity $F_{\text{ave}}$. -`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. @@ -151,7 +151,7 @@ The process fidelity $F_{\text{pro}}$. -`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. @@ -188,7 +188,7 @@ The average gate error $E$. -`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. @@ -228,7 +228,7 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar -`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. @@ -264,7 +264,7 @@ The state fidelity $F(\rho_1, \rho_2)$. -`qiskit.quantum_info.purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. @@ -295,7 +295,7 @@ the purity $Tr[\rho^2]$. -`qiskit.quantum_info.concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. @@ -337,7 +337,7 @@ The concurrence. -`qiskit.quantum_info.entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. @@ -368,7 +368,7 @@ The von-Neumann entropy S(rho). -`qiskit.quantum_info.entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. @@ -396,7 +396,7 @@ The entanglement of formation. -`qiskit.quantum_info.mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. @@ -436,7 +436,7 @@ The mutual information $I(\rho_{AB})$. -`qiskit.quantum_info.partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. @@ -463,7 +463,7 @@ The reduced density matrix. -`qiskit.quantum_info.schmidt_decomposition(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.schmidt_decomposition(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/utils.py "view source code") Return the Schmidt Decomposition of a pure quantum state. @@ -513,7 +513,7 @@ list of tuples `(s, u, v)`, where `s` (float) are the Schmidt coefficients $\lam -`qiskit.quantum_info.shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. @@ -542,7 +542,7 @@ The Shannon entropy H(pvec). -`qiskit.quantum_info.commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`qiskit.quantum_info.commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/utils/commutator.py "view source code") Compute commutator of a and b. @@ -567,7 +567,7 @@ The commutator -`qiskit.quantum_info.anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`qiskit.quantum_info.anti_commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") Compute anti-commutator of a and b. @@ -592,7 +592,7 @@ The anti-commutator -`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") Compute symmetric double commutator of a, b and c. @@ -641,7 +641,7 @@ Methods of Molecular Quantum Mechanics. 2nd Edition, Academic Press, 1992. ISBN -`qiskit.quantum_info.random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. @@ -668,7 +668,7 @@ K. Zyczkowski and H. Sommers (2001), “Induced measures in the space of mixed q -`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. @@ -695,7 +695,7 @@ the random density matrix. -`qiskit.quantum_info.random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. @@ -718,7 +718,7 @@ a unitary operator. -`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. @@ -742,7 +742,7 @@ a Hermitian operator. -`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. @@ -764,7 +764,7 @@ a random Pauli -`qiskit.quantum_info.random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. @@ -791,7 +791,7 @@ a random Clifford operator. -`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. @@ -820,7 +820,7 @@ a quantum channel operator. -`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. @@ -841,7 +841,7 @@ a random CNOTDihedral element. -`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. @@ -866,7 +866,7 @@ a random PauliList. -`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. @@ -891,7 +891,7 @@ Distance -`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/result.md b/docs/api/qiskit/result.md index f7723e13ace..3e7e8c026a4 100644 --- a/docs/api/qiskit/result.md +++ b/docs/api/qiskit/result.md @@ -28,7 +28,7 @@ python_api_name: qiskit.result -`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -58,7 +58,7 @@ the observed counts, marginalized to only account for frequency of observations -`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -87,7 +87,7 @@ A marginalized dictionary -`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/utils.py "view source code") Marginalize shot memory @@ -127,7 +127,7 @@ marginal\_memory -`qiskit.result.sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/sampled_expval.py "view source code") +`qiskit.result.sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/scheduler.md b/docs/api/qiskit/scheduler.md index f3636be6be5..4709dd7cccc 100644 --- a/docs/api/qiskit/scheduler.md +++ b/docs/api/qiskit/scheduler.md @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. -`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/config.py "view source code") +`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. @@ -38,7 +38,7 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched -`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/schedule_circuit.py "view source code") +`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. @@ -74,7 +74,7 @@ Pulse scheduling methods. -`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -98,7 +98,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. diff --git a/docs/api/qiskit/synthesis.md b/docs/api/qiskit/synthesis.md index a81ff33031d..d907b4748a4 100644 --- a/docs/api/qiskit/synthesis.md +++ b/docs/api/qiskit/synthesis.md @@ -37,7 +37,7 @@ python_api_name: qiskit.synthesis -`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear/cnot_synth.py "view source code") +`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear/cnot_synth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. @@ -68,7 +68,7 @@ a CX-only circuit implementing the linear transformation. -`qiskit.synthesis.synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. @@ -100,7 +100,7 @@ The synthesized quantum circuit. -`qiskit.synthesis.synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cz_depth_line_mr(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. @@ -126,7 +126,7 @@ A circuit implementation of the CZ circuit of depth $2n+2$ for LNN connectivity. -`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") Joint synthesis of a -CZ-CX- circuit for linear nearest neighbour (LNN) connectivity, with 2-qubit depth at most 5n, based on Maslov and Yang. This method computes the CZ circuit inside the CX circuit via phase gate insertions. @@ -152,7 +152,7 @@ A circuit implementation of a CX circuit following a CZ circuit, denoted as a -C -`qiskit.synthesis.synth_cnot_phase_aam(cnots, angles, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear_phase/cnot_phase_synth.py "view source code") +`qiskit.synthesis.synth_cnot_phase_aam(cnots, angles, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/linear_phase/cnot_phase_synth.py "view source code") This function is an implementation of the GraySynth algorithm of Amy, Azimadeh and Mosca. @@ -207,7 +207,7 @@ The decomposed quantum circuit. -`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. @@ -233,7 +233,7 @@ The synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. @@ -255,7 +255,7 @@ The synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. @@ -286,7 +286,7 @@ The synthesized quantum circuit. -`qiskit.synthesis.synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`qiskit.synthesis.synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") operator into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -315,7 +315,7 @@ A circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`qiskit.synthesis.synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") operator into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") based on Aaronson-Gottesman method \[1]. @@ -339,7 +339,7 @@ A circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`qiskit.synthesis.synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") operator on 2 qubits or 3 qubits into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") based on the Bravyi-Maslov method \[1]. @@ -367,7 +367,7 @@ A circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`qiskit.synthesis.synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") operator into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin \[1]. @@ -399,7 +399,7 @@ A circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov \[1]. @@ -446,7 +446,7 @@ A circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_depth_lnn(cliff)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") into layers for linear-nearest neighbour connectivity. @@ -476,7 +476,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral") element into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -503,7 +503,7 @@ A circuit implementation of the [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedra -`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral") element on a single qubit and two qubits into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). This decomposition has an optimal number of [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")s. @@ -531,7 +531,7 @@ A circuit implementation of the [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedra -`qiskit.synthesis.synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral") element into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -563,7 +563,7 @@ A circuit implementation of the [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedra -`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of a stabilizer state into layers. @@ -612,7 +612,7 @@ A circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth $2n+2$ and two distinct CX layers, using [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")s and phase gates ([`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"), [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate") or [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate")). @@ -637,7 +637,7 @@ A circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_circuit_from_stabilizers(stabilizers, allow_redundant=False, allow_underconstrained=False, invert=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/stabilizer/stabilizer_circuit.py "view source code") +`qiskit.synthesis.synth_circuit_from_stabilizers(stabilizers, allow_redundant=False, allow_underconstrained=False, invert=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/stabilizer/stabilizer_circuit.py "view source code") Synthesis of a circuit that generates a state stabilized by the stabilizers using Gaussian elimination with Clifford gates. If the stabilizers are underconstrained, and `allow_underconstrained` is `True`, the circuit will output one of the states stabilized by the stabilizers. Based on stim implementation. @@ -675,7 +675,7 @@ A circuit that generates a state stabilized by `stabilizers`. -`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence`s with the gates in `basis_gates`. @@ -703,7 +703,7 @@ List of `GateSequence`s using the gates in `basis_gates`. -`qiskit.synthesis.synth_qft_line(num_qubits, do_swaps=True, approximation_degree=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/qft/qft_decompose_lnn.py "view source code") +`qiskit.synthesis.synth_qft_line(num_qubits, do_swaps=True, approximation_degree=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/qft/qft_decompose_lnn.py "view source code") Synthesis of a QFT circuit for a linear nearest neighbor connectivity. Based on Fig 2.b in Fowler et al. \[1]. @@ -735,7 +735,7 @@ Decomposition of general $2^n \times 2^n$ unitary matrices for any number of qub -`qiskit.synthesis.qs_decomposition(mat, opt_a1=True, opt_a2=True, decomposer_1q=None, decomposer_2q=None, *, _depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/qsd.py "view source code") +`qiskit.synthesis.qs_decomposition(mat, opt_a1=True, opt_a2=True, decomposer_1q=None, decomposer_2q=None, *, _depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/synthesis/unitary/qsd.py "view source code") Decomposes a unitary matrix into one and two qubit gates using Quantum Shannon Decomposition, diff --git a/docs/api/qiskit/transpiler.md b/docs/api/qiskit/transpiler.md index 7d8033a8175..c5285cf45cb 100644 --- a/docs/api/qiskit/transpiler.md +++ b/docs/api/qiskit/transpiler.md @@ -935,7 +935,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor -`qiskit.transpiler.TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. @@ -945,7 +945,7 @@ Set the error message. -`qiskit.transpiler.TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. @@ -955,7 +955,7 @@ Set the error message. -`qiskit.transpiler.CouplingError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CouplingError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") Base class for errors raised by the coupling graph object. @@ -965,7 +965,7 @@ Set the error message. -`qiskit.transpiler.LayoutError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.LayoutError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") Errors raised by the layout object. @@ -975,7 +975,7 @@ Set the error message. -`qiskit.transpiler.CircuitTooWideForTarget(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CircuitTooWideForTarget(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") Error raised if the circuit is too wide for the target. @@ -985,7 +985,7 @@ Set the error message. -`qiskit.transpiler.InvalidLayoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.InvalidLayoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/exceptions.py "view source code") Error raised when a user provided layout is invalid. diff --git a/docs/api/qiskit/transpiler_passes.md b/docs/api/qiskit/transpiler_passes.md index ce653d66f01..05dd43f88f4 100644 --- a/docs/api/qiskit/transpiler_passes.md +++ b/docs/api/qiskit/transpiler_passes.md @@ -95,7 +95,7 @@ python_api_name: qiskit.transpiler.passes -`qiskit.transpiler.passes.rzx_templates(template_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rzx_templates.py "view source code") +`qiskit.transpiler.passes.rzx_templates(template_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/passes/calibration/rzx_templates.py "view source code") Convenience function to get the cost\_dict and templates for template matching. diff --git a/docs/api/qiskit/transpiler_plugins.md b/docs/api/qiskit/transpiler_plugins.md index 500e9542cda..e9ad6f11bab 100644 --- a/docs/api/qiskit/transpiler_plugins.md +++ b/docs/api/qiskit/transpiler_plugins.md @@ -99,7 +99,7 @@ There isn’t a limit to the number of plugins a single package can include as l -`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. @@ -123,7 +123,7 @@ plugins -`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/transpiler_preset.md b/docs/api/qiskit/transpiler_preset.md index e7edb6b284d..ff3fbc9f453 100644 --- a/docs/api/qiskit/transpiler_preset.md +++ b/docs/api/qiskit/transpiler_preset.md @@ -28,7 +28,7 @@ This module contains functions for generating the preset pass managers for the t -`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=1.0, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=1.0, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -101,7 +101,7 @@ The preset pass manager for the given options -`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -129,7 +129,7 @@ a level 0 pass manager. -`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -155,7 +155,7 @@ a level 1 pass manager. -`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. @@ -183,7 +183,7 @@ a level 2 pass manager. -`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. @@ -215,7 +215,7 @@ a level 3 pass manager. -`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. @@ -231,7 +231,7 @@ a pass manager that populates the `contains_x` properties for each of the contro -`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. @@ -239,7 +239,7 @@ Get a pass manager that always raises an error if control flow is present in a g -`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -264,7 +264,7 @@ The unroll 3q or more pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -288,7 +288,7 @@ set has been set in earlier stages -`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -316,7 +316,7 @@ The routing pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -340,7 +340,7 @@ The pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -372,7 +372,7 @@ The basis translation pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/utils.md b/docs/api/qiskit/utils.md index 69487fa56f6..5d3ef24aa6e 100644 --- a/docs/api/qiskit/utils.md +++ b/docs/api/qiskit/utils.md @@ -22,7 +22,7 @@ python_api_name: qiskit.utils -`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") Dynamically insert the deprecation message into `func`’s docstring. @@ -37,7 +37,7 @@ Dynamically insert the deprecation message into `func`’s docstring. -`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") Decorator to indicate an argument has been deprecated in some way. @@ -67,7 +67,7 @@ Callable -`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_arg. @@ -89,7 +89,7 @@ Callable -`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") Decorator to indicate a function has been deprecated. @@ -118,7 +118,7 @@ Callable -`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_func. @@ -141,7 +141,7 @@ Callable -`qiskit.utils.local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. @@ -159,7 +159,7 @@ The hardware information. -`qiskit.utils.is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one @@ -167,7 +167,7 @@ Checks whether the current process is the main one -`qiskit.utils.apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/units.py "view source code") +`qiskit.utils.apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. @@ -200,7 +200,7 @@ Converted value. -`qiskit.utils.detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/units.py "view source code") +`qiskit.utils.detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. @@ -244,7 +244,7 @@ A tuple of scaled value and prefix. -`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/classtools.py "view source code") +`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. @@ -271,7 +271,7 @@ A helper function for calling a custom function with python [`ProcessPoolExecuto -`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/parallel.py "view source code") +`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -383,7 +383,7 @@ from qiskit.utils import LazyImportTester -`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -504,7 +504,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -518,7 +518,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. diff --git a/docs/api/qiskit/visualization.md b/docs/api/qiskit/visualization.md index 48fcbad08c0..f85017a0af3 100644 --- a/docs/api/qiskit/visualization.md +++ b/docs/api/qiskit/visualization.md @@ -227,7 +227,7 @@ You can find code examples for each visualization functions on the individual fu -`qiskit.visualization.VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/exceptions.py "view source code") +`qiskit.visualization.VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. From a930ad21b65300cc5e22f5401df922d0fc7ae84d Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:04:42 +0100 Subject: [PATCH 28/41] Regenerate qiskit 1.1.0-dev --- docs/api/qiskit/dev/assembler.md | 6 +- docs/api/qiskit/dev/circuit.md | 4 +- docs/api/qiskit/dev/circuit_classical.md | 70 ++++----- docs/api/qiskit/dev/circuit_library.md | 142 +++++++++--------- docs/api/qiskit/dev/circuit_singleton.md | 6 +- docs/api/qiskit/dev/compiler.md | 8 +- docs/api/qiskit/dev/converters.md | 16 +- docs/api/qiskit/dev/dagcircuit.md | 4 +- docs/api/qiskit/dev/exceptions.md | 14 +- docs/api/qiskit/dev/passmanager.md | 2 +- docs/api/qiskit/dev/providers.md | 10 +- .../api/qiskit/dev/providers_fake_provider.md | 6 +- docs/api/qiskit/dev/pulse.md | 100 ++++++------ docs/api/qiskit/dev/qasm2.md | 16 +- docs/api/qiskit/dev/qasm3.md | 16 +- .../qiskit/dev/qiskit.assembler.RunConfig.md | 2 +- .../qiskit/dev/qiskit.circuit.AncillaQubit.md | 2 +- .../dev/qiskit.circuit.AncillaRegister.md | 2 +- docs/api/qiskit/dev/qiskit.circuit.Bit.md | 2 +- .../qiskit/dev/qiskit.circuit.BreakLoopOp.md | 2 +- .../dev/qiskit.circuit.ClassicalRegister.md | 2 +- docs/api/qiskit/dev/qiskit.circuit.Clbit.md | 2 +- .../dev/qiskit.circuit.ContinueLoopOp.md | 2 +- .../dev/qiskit.circuit.ControlFlowOp.md | 2 +- .../dev/qiskit.circuit.ControlledGate.md | 2 +- docs/api/qiskit/dev/qiskit.circuit.Delay.md | 2 +- .../dev/qiskit.circuit.EquivalenceLibrary.md | 2 +- .../qiskit/dev/qiskit.circuit.ForLoopOp.md | 2 +- docs/api/qiskit/dev/qiskit.circuit.Gate.md | 2 +- .../api/qiskit/dev/qiskit.circuit.IfElseOp.md | 2 +- .../qiskit/dev/qiskit.circuit.Instruction.md | 2 +- .../dev/qiskit.circuit.InstructionSet.md | 2 +- .../qiskit/dev/qiskit.circuit.Operation.md | 2 +- .../qiskit/dev/qiskit.circuit.Parameter.md | 2 +- .../dev/qiskit.circuit.ParameterExpression.md | 2 +- .../dev/qiskit.circuit.ParameterVector.md | 2 +- .../dev/qiskit.circuit.QuantumCircuit.md | 2 +- .../dev/qiskit.circuit.QuantumRegister.md | 2 +- docs/api/qiskit/dev/qiskit.circuit.Qubit.md | 2 +- .../api/qiskit/dev/qiskit.circuit.Register.md | 2 +- .../qiskit/dev/qiskit.circuit.SwitchCaseOp.md | 2 +- .../qiskit/dev/qiskit.circuit.WhileLoopOp.md | 2 +- ...uit.classicalfunction.BooleanExpression.md | 2 +- ...uit.classicalfunction.ClassicalFunction.md | 2 +- ...tion.ClassicalFunctionCompilerTypeError.md | 2 +- ...calfunction.ClassicalFunctionParseError.md | 2 +- .../qiskit/dev/qiskit.circuit.library.AND.md | 2 +- .../dev/qiskit.circuit.library.Barrier.md | 2 +- .../dev/qiskit.circuit.library.C3SXGate.md | 2 +- .../dev/qiskit.circuit.library.C3XGate.md | 2 +- .../dev/qiskit.circuit.library.C4XGate.md | 2 +- .../dev/qiskit.circuit.library.CCXGate.md | 2 +- .../dev/qiskit.circuit.library.CCZGate.md | 2 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 2 +- .../dev/qiskit.circuit.library.CHGate.md | 2 +- .../dev/qiskit.circuit.library.CPhaseGate.md | 2 +- .../dev/qiskit.circuit.library.CRXGate.md | 2 +- .../dev/qiskit.circuit.library.CRYGate.md | 2 +- .../dev/qiskit.circuit.library.CRZGate.md | 2 +- .../dev/qiskit.circuit.library.CSGate.md | 2 +- .../dev/qiskit.circuit.library.CSXGate.md | 2 +- .../dev/qiskit.circuit.library.CSdgGate.md | 2 +- .../dev/qiskit.circuit.library.CSwapGate.md | 2 +- .../dev/qiskit.circuit.library.CU1Gate.md | 2 +- .../dev/qiskit.circuit.library.CU3Gate.md | 2 +- .../dev/qiskit.circuit.library.CUGate.md | 2 +- .../dev/qiskit.circuit.library.CXGate.md | 2 +- .../dev/qiskit.circuit.library.CYGate.md | 2 +- .../dev/qiskit.circuit.library.CZGate.md | 2 +- .../dev/qiskit.circuit.library.DCXGate.md | 2 +- .../dev/qiskit.circuit.library.Diagonal.md | 2 +- .../qiskit.circuit.library.DiagonalGate.md | 2 +- .../qiskit.circuit.library.DraperQFTAdder.md | 2 +- .../dev/qiskit.circuit.library.ECRGate.md | 2 +- .../qiskit.circuit.library.EfficientSU2.md | 2 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 2 +- .../qiskit.circuit.library.ExactReciprocal.md | 2 +- ...it.circuit.library.ExcitationPreserving.md | 2 +- .../qiskit.circuit.library.FourierChecking.md | 2 +- ...ircuit.library.FunctionalPauliRotations.md | 2 +- .../qiskit/dev/qiskit.circuit.library.GMS.md | 2 +- .../qiskit/dev/qiskit.circuit.library.GR.md | 2 +- .../qiskit/dev/qiskit.circuit.library.GRX.md | 2 +- .../qiskit/dev/qiskit.circuit.library.GRY.md | 2 +- .../qiskit/dev/qiskit.circuit.library.GRZ.md | 2 +- .../qiskit.circuit.library.GlobalPhaseGate.md | 2 +- .../dev/qiskit.circuit.library.GraphState.md | 2 +- .../qiskit.circuit.library.GroverOperator.md | 2 +- .../dev/qiskit.circuit.library.HGate.md | 2 +- ...circuit.library.HRSCumulativeMultiplier.md | 2 +- .../qiskit.circuit.library.HamiltonianGate.md | 2 +- ...it.circuit.library.HiddenLinearFunction.md | 2 +- .../dev/qiskit.circuit.library.IGate.md | 2 +- .../qiskit/dev/qiskit.circuit.library.IQP.md | 2 +- .../dev/qiskit.circuit.library.Initialize.md | 2 +- .../qiskit.circuit.library.InnerProduct.md | 2 +- ...iskit.circuit.library.IntegerComparator.md | 2 +- .../dev/qiskit.circuit.library.Isometry.md | 2 +- ...circuit.library.LinearAmplitudeFunction.md | 2 +- .../qiskit.circuit.library.LinearFunction.md | 2 +- ...it.circuit.library.LinearPauliRotations.md | 2 +- .../qiskit/dev/qiskit.circuit.library.MCMT.md | 2 +- .../dev/qiskit.circuit.library.MCMTVChain.md | 2 +- .../dev/qiskit.circuit.library.MCPhaseGate.md | 2 +- .../dev/qiskit.circuit.library.MCXGate.md | 2 +- .../dev/qiskit.circuit.library.MCXGrayCode.md | 2 +- .../qiskit.circuit.library.MCXRecursive.md | 2 +- .../dev/qiskit.circuit.library.MCXVChain.md | 2 +- .../dev/qiskit.circuit.library.MSGate.md | 2 +- .../dev/qiskit.circuit.library.Measure.md | 2 +- .../dev/qiskit.circuit.library.NLocal.md | 2 +- .../qiskit/dev/qiskit.circuit.library.OR.md | 2 +- ...skit.circuit.library.PauliEvolutionGate.md | 2 +- .../qiskit.circuit.library.PauliFeatureMap.md | 2 +- .../dev/qiskit.circuit.library.PauliGate.md | 2 +- .../qiskit.circuit.library.PauliTwoDesign.md | 2 +- .../dev/qiskit.circuit.library.Permutation.md | 2 +- .../qiskit.circuit.library.PermutationGate.md | 2 +- .../qiskit.circuit.library.PhaseEstimation.md | 2 +- .../dev/qiskit.circuit.library.PhaseGate.md | 2 +- .../dev/qiskit.circuit.library.PhaseOracle.md | 2 +- ...skit.circuit.library.PiecewiseChebyshev.md | 2 +- ...t.library.PiecewiseLinearPauliRotations.md | 2 +- ...brary.PiecewisePolynomialPauliRotations.md | 2 +- ...ircuit.library.PolynomialPauliRotations.md | 2 +- .../dev/qiskit.circuit.library.QAOAAnsatz.md | 2 +- .../qiskit/dev/qiskit.circuit.library.QFT.md | 2 +- .../qiskit.circuit.library.QuadraticForm.md | 2 +- .../qiskit.circuit.library.QuantumVolume.md | 2 +- .../dev/qiskit.circuit.library.RC3XGate.md | 2 +- .../dev/qiskit.circuit.library.RCCXGate.md | 2 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 2 +- .../dev/qiskit.circuit.library.RGate.md | 2 +- .../dev/qiskit.circuit.library.RVGate.md | 2 +- .../dev/qiskit.circuit.library.RXGate.md | 2 +- .../dev/qiskit.circuit.library.RXXGate.md | 2 +- .../dev/qiskit.circuit.library.RYGate.md | 2 +- .../dev/qiskit.circuit.library.RYYGate.md | 2 +- .../dev/qiskit.circuit.library.RZGate.md | 2 +- .../dev/qiskit.circuit.library.RZXGate.md | 2 +- .../dev/qiskit.circuit.library.RZZGate.md | 2 +- .../qiskit.circuit.library.RealAmplitudes.md | 2 +- .../dev/qiskit.circuit.library.Reset.md | 2 +- .../dev/qiskit.circuit.library.SGate.md | 2 +- .../dev/qiskit.circuit.library.SXGate.md | 2 +- .../dev/qiskit.circuit.library.SXdgGate.md | 2 +- .../dev/qiskit.circuit.library.SdgGate.md | 2 +- ...qiskit.circuit.library.StatePreparation.md | 2 +- .../dev/qiskit.circuit.library.SwapGate.md | 2 +- .../dev/qiskit.circuit.library.TGate.md | 2 +- .../dev/qiskit.circuit.library.TdgGate.md | 2 +- .../dev/qiskit.circuit.library.TwoLocal.md | 2 +- .../dev/qiskit.circuit.library.U1Gate.md | 2 +- .../dev/qiskit.circuit.library.U2Gate.md | 2 +- .../dev/qiskit.circuit.library.U3Gate.md | 2 +- .../dev/qiskit.circuit.library.UCGate.md | 2 +- .../qiskit.circuit.library.UCPauliRotGate.md | 2 +- .../dev/qiskit.circuit.library.UCRXGate.md | 2 +- .../dev/qiskit.circuit.library.UCRYGate.md | 2 +- .../dev/qiskit.circuit.library.UCRZGate.md | 2 +- .../dev/qiskit.circuit.library.UGate.md | 2 +- .../dev/qiskit.circuit.library.UnitaryGate.md | 2 +- .../qiskit.circuit.library.UnitaryOverlap.md | 2 +- ...kit.circuit.library.VBERippleCarryAdder.md | 2 +- .../qiskit.circuit.library.WeightedAdder.md | 2 +- .../dev/qiskit.circuit.library.XGate.md | 2 +- .../qiskit/dev/qiskit.circuit.library.XOR.md | 2 +- .../qiskit.circuit.library.XXMinusYYGate.md | 2 +- .../qiskit.circuit.library.XXPlusYYGate.md | 2 +- .../dev/qiskit.circuit.library.YGate.md | 2 +- .../dev/qiskit.circuit.library.ZFeatureMap.md | 2 +- .../dev/qiskit.circuit.library.ZGate.md | 2 +- .../qiskit.circuit.library.ZZFeatureMap.md | 2 +- .../dev/qiskit.circuit.library.iSwapGate.md | 2 +- .../dev/qiskit.dagcircuit.DAGCircuit.md | 2 +- .../dev/qiskit.dagcircuit.DAGDepNode.md | 2 +- .../dev/qiskit.dagcircuit.DAGDependency.md | 2 +- .../qiskit/dev/qiskit.dagcircuit.DAGInNode.md | 2 +- .../qiskit/dev/qiskit.dagcircuit.DAGNode.md | 2 +- .../qiskit/dev/qiskit.dagcircuit.DAGOpNode.md | 2 +- .../dev/qiskit.dagcircuit.DAGOutNode.md | 2 +- .../dev/qiskit.passmanager.BaseController.md | 2 +- .../dev/qiskit.passmanager.BasePassManager.md | 2 +- ...iskit.passmanager.ConditionalController.md | 2 +- .../qiskit.passmanager.DoWhileController.md | 2 +- ...qiskit.passmanager.FlowControllerLinear.md | 2 +- .../dev/qiskit.passmanager.GenericPass.md | 2 +- .../qiskit.passmanager.PassManagerState.md | 2 +- .../dev/qiskit.passmanager.PropertySet.md | 2 +- .../dev/qiskit.passmanager.WorkflowStatus.md | 2 +- .../dev/qiskit.primitives.BackendEstimator.md | 2 +- .../dev/qiskit.primitives.BackendSampler.md | 2 +- .../dev/qiskit.primitives.BaseEstimatorV2.md | 2 +- .../dev/qiskit.primitives.BaseSamplerV2.md | 2 +- .../qiskit/dev/qiskit.primitives.Estimator.md | 2 +- .../dev/qiskit.primitives.EstimatorResult.md | 2 +- .../dev/qiskit.primitives.PrimitiveResult.md | 2 +- .../qiskit/dev/qiskit.primitives.PubResult.md | 2 +- .../qiskit/dev/qiskit.primitives.Sampler.md | 2 +- .../dev/qiskit.primitives.SamplerResult.md | 2 +- .../qiskit.primitives.StatevectorEstimator.md | 2 +- .../qiskit.primitives.StatevectorSampler.md | 2 +- .../qiskit/dev/qiskit.providers.Backend.md | 2 +- .../qiskit/dev/qiskit.providers.BackendV1.md | 2 +- .../qiskit/dev/qiskit.providers.BackendV2.md | 2 +- .../qiskit.providers.BackendV2Converter.md | 2 +- docs/api/qiskit/dev/qiskit.providers.Job.md | 2 +- .../qiskit/dev/qiskit.providers.JobStatus.md | 2 +- docs/api/qiskit/dev/qiskit.providers.JobV1.md | 2 +- .../qiskit/dev/qiskit.providers.Options.md | 2 +- .../qiskit/dev/qiskit.providers.Provider.md | 2 +- .../qiskit/dev/qiskit.providers.ProviderV1.md | 2 +- .../dev/qiskit.providers.QubitProperties.md | 2 +- ....providers.basic_provider.BasicProvider.md | 2 +- ...iders.basic_provider.BasicProviderError.md | 2 +- ...oviders.basic_provider.BasicProviderJob.md | 2 +- ...providers.basic_provider.BasicSimulator.md | 2 +- .../dev/qiskit.providers.convert_to_target.md | 2 +- ...providers.fake_provider.Fake127QPulseV1.md | 2 +- .../qiskit.providers.fake_provider.Fake1Q.md | 2 +- ...iskit.providers.fake_provider.Fake20QV1.md | 2 +- ....providers.fake_provider.Fake27QPulseV1.md | 2 +- ...qiskit.providers.fake_provider.Fake5QV1.md | 2 +- ...t.providers.fake_provider.Fake7QPulseV1.md | 2 +- ...providers.fake_provider.FakeOpenPulse2Q.md | 2 +- ...providers.fake_provider.FakeOpenPulse3Q.md | 2 +- ...roviders.fake_provider.GenericBackendV2.md | 2 +- ...t.providers.models.BackendConfiguration.md | 2 +- ...skit.providers.models.BackendProperties.md | 2 +- .../qiskit.providers.models.BackendStatus.md | 2 +- .../dev/qiskit.providers.models.Command.md | 2 +- .../dev/qiskit.providers.models.GateConfig.md | 2 +- .../qiskit.providers.models.GateProperties.md | 2 +- .../dev/qiskit.providers.models.JobStatus.md | 2 +- .../dev/qiskit.providers.models.Nduv.md | 2 +- ...viders.models.PulseBackendConfiguration.md | 2 +- .../qiskit.providers.models.PulseDefaults.md | 2 +- ...oviders.models.QasmBackendConfiguration.md | 2 +- .../dev/qiskit.providers.models.UchannelLO.md | 2 +- .../qiskit.pulse.InstructionScheduleMap.md | 2 +- docs/api/qiskit/dev/qiskit.pulse.Schedule.md | 2 +- .../qiskit/dev/qiskit.pulse.ScheduleBlock.md | 2 +- .../qiskit.pulse.channels.AcquireChannel.md | 2 +- .../qiskit.pulse.channels.ControlChannel.md | 2 +- .../dev/qiskit.pulse.channels.DriveChannel.md | 2 +- .../qiskit.pulse.channels.MeasureChannel.md | 2 +- .../dev/qiskit.pulse.channels.MemorySlot.md | 2 +- .../dev/qiskit.pulse.channels.RegisterSlot.md | 2 +- .../qiskit.pulse.channels.SnapshotChannel.md | 2 +- .../dev/qiskit.pulse.instructions.Acquire.md | 2 +- .../dev/qiskit.pulse.instructions.Delay.md | 2 +- .../dev/qiskit.pulse.instructions.Play.md | 2 +- .../qiskit.pulse.instructions.Reference.md | 2 +- ...skit.pulse.instructions.RelativeBarrier.md | 2 +- .../qiskit.pulse.instructions.SetFrequency.md | 2 +- .../dev/qiskit.pulse.instructions.SetPhase.md | 2 +- ...iskit.pulse.instructions.ShiftFrequency.md | 2 +- .../qiskit.pulse.instructions.ShiftPhase.md | 2 +- .../dev/qiskit.pulse.instructions.Snapshot.md | 2 +- .../qiskit.pulse.instructions.TimeBlockade.md | 2 +- ...qiskit.pulse.library.Constant_class.rst.md | 2 +- .../dev/qiskit.pulse.library.Cos_class.rst.md | 2 +- .../qiskit.pulse.library.Drag_class.rst.md | 2 +- .../dev/qiskit.pulse.library.GaussianDeriv.md | 2 +- .../qiskit.pulse.library.GaussianSquare.md | 2 +- ...qiskit.pulse.library.GaussianSquareDrag.md | 2 +- ...qiskit.pulse.library.Gaussian_class.rst.md | 2 +- ...qiskit.pulse.library.Sawtooth_class.rst.md | 2 +- .../dev/qiskit.pulse.library.SechDeriv.md | 2 +- .../dev/qiskit.pulse.library.Sech_fun.rst.md | 2 +- .../dev/qiskit.pulse.library.Sin_class.rst.md | 2 +- .../qiskit.pulse.library.Square_fun.rst.md | 2 +- .../dev/qiskit.pulse.library.SymbolicPulse.md | 2 +- ...qiskit.pulse.library.Triangle_class.rst.md | 2 +- .../dev/qiskit.pulse.library.Waveform.md | 2 +- ...skit.pulse.library.gaussian_square_echo.md | 2 +- ...qiskit.pulse.transforms.AlignEquispaced.md | 2 +- .../dev/qiskit.pulse.transforms.AlignFunc.md | 2 +- .../dev/qiskit.pulse.transforms.AlignLeft.md | 2 +- .../dev/qiskit.pulse.transforms.AlignRight.md | 2 +- ...qiskit.pulse.transforms.AlignSequential.md | 2 +- .../qiskit/dev/qiskit.qobj.GateCalibration.md | 2 +- .../dev/qiskit.qobj.PulseLibraryItem.md | 2 +- docs/api/qiskit/dev/qiskit.qobj.PulseQobj.md | 2 +- .../qiskit/dev/qiskit.qobj.PulseQobjConfig.md | 2 +- .../dev/qiskit.qobj.PulseQobjExperiment.md | 2 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 2 +- .../dev/qiskit.qobj.PulseQobjInstruction.md | 2 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 2 +- docs/api/qiskit/dev/qiskit.qobj.QasmQobj.md | 2 +- .../qiskit/dev/qiskit.qobj.QasmQobjConfig.md | 2 +- .../dev/qiskit.qobj.QasmQobjExperiment.md | 2 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 2 +- .../dev/qiskit.qobj.QasmQobjInstruction.md | 2 +- .../dev/qiskit.qobj.QobjExperimentHeader.md | 2 +- docs/api/qiskit/dev/qiskit.qobj.QobjHeader.md | 2 +- .../dev/qiskit.qobj.QobjMeasurementOption.md | 2 +- .../dev/qiskit.quantum_info.CNOTDihedral.md | 2 +- .../api/qiskit/dev/qiskit.quantum_info.Chi.md | 2 +- .../qiskit/dev/qiskit.quantum_info.Choi.md | 2 +- .../dev/qiskit.quantum_info.Clifford.md | 2 +- .../dev/qiskit.quantum_info.DensityMatrix.md | 2 +- .../qiskit/dev/qiskit.quantum_info.Kraus.md | 2 +- .../dev/qiskit.quantum_info.Operator.md | 2 +- .../api/qiskit/dev/qiskit.quantum_info.PTM.md | 2 +- .../qiskit/dev/qiskit.quantum_info.Pauli.md | 2 +- .../dev/qiskit.quantum_info.PauliList.md | 2 +- .../dev/qiskit.quantum_info.Quaternion.md | 2 +- .../dev/qiskit.quantum_info.ScalarOp.md | 2 +- .../dev/qiskit.quantum_info.SparsePauliOp.md | 2 +- .../qiskit.quantum_info.StabilizerState.md | 2 +- .../dev/qiskit.quantum_info.Statevector.md | 2 +- .../dev/qiskit.quantum_info.Stinespring.md | 2 +- .../qiskit/dev/qiskit.quantum_info.SuperOp.md | 2 +- .../dev/qiskit.quantum_info.Z2Symmetries.md | 2 +- .../dev/qiskit.quantum_info.pauli_basis.md | 2 +- .../dev/qiskit.result.BaseReadoutMitigator.md | 2 +- ...iskit.result.CorrelatedReadoutMitigator.md | 2 +- docs/api/qiskit/dev/qiskit.result.Counts.md | 2 +- .../qiskit.result.LocalReadoutMitigator.md | 2 +- .../dev/qiskit.result.ProbDistribution.md | 2 +- .../dev/qiskit.result.QuasiDistribution.md | 2 +- docs/api/qiskit/dev/qiskit.result.Result.md | 2 +- .../qiskit/dev/qiskit.result.ResultError.md | 2 +- .../qiskit.synthesis.EvolutionSynthesis.md | 2 +- .../qiskit/dev/qiskit.synthesis.LieTrotter.md | 2 +- .../dev/qiskit.synthesis.MatrixExponential.md | 2 +- ...iskit.synthesis.OneQubitEulerDecomposer.md | 2 +- .../dev/qiskit.synthesis.ProductFormula.md | 2 +- .../api/qiskit/dev/qiskit.synthesis.QDrift.md | 2 +- ...it.synthesis.SolovayKitaevDecomposition.md | 2 +- .../dev/qiskit.synthesis.SuzukiTrotter.md | 2 +- ...iskit.synthesis.TwoQubitBasisDecomposer.md | 2 +- ...kit.synthesis.TwoQubitWeylDecomposition.md | 2 +- .../dev/qiskit.synthesis.XXDecomposer.md | 2 +- .../dev/qiskit.synthesis.unitary.aqc.AQC.md | 2 +- ...ynthesis.unitary.aqc.ApproximateCircuit.md | 2 +- ...esis.unitary.aqc.ApproximatingObjective.md | 2 +- ...t.synthesis.unitary.aqc.CNOTUnitCircuit.md | 2 +- ...synthesis.unitary.aqc.CNOTUnitObjective.md | 2 +- ...is.unitary.aqc.DefaultCNOTUnitObjective.md | 2 +- ...hesis.unitary.aqc.FastCNOTUnitObjective.md | 2 +- .../dev/qiskit.transpiler.AnalysisPass.md | 2 +- .../dev/qiskit.transpiler.CouplingMap.md | 2 +- .../qiskit.transpiler.InstructionDurations.md | 2 +- ...qiskit.transpiler.InstructionProperties.md | 2 +- .../qiskit/dev/qiskit.transpiler.Layout.md | 2 +- .../dev/qiskit.transpiler.PassManager.md | 2 +- .../qiskit.transpiler.PassManagerConfig.md | 2 +- .../qiskit.transpiler.StagedPassManager.md | 2 +- .../qiskit/dev/qiskit.transpiler.Target.md | 2 +- .../qiskit.transpiler.TransformationPass.md | 2 +- .../dev/qiskit.transpiler.TranspileLayout.md | 2 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 2 +- ....transpiler.passes.ALAPScheduleAnalysis.md | 2 +- ...it.transpiler.passes.AQCSynthesisPlugin.md | 2 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 2 +- ....transpiler.passes.ASAPScheduleAnalysis.md | 2 +- .../qiskit.transpiler.passes.AlignMeasures.md | 2 +- .../qiskit.transpiler.passes.ApplyLayout.md | 2 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 2 +- .../dev/qiskit.transpiler.passes.BasicSwap.md | 2 +- ...iskit.transpiler.passes.BasisTranslator.md | 2 +- .../dev/qiskit.transpiler.passes.CSPLayout.md | 2 +- ...qiskit.transpiler.passes.CXCancellation.md | 2 +- ...it.transpiler.passes.CheckGateDirection.md | 2 +- .../dev/qiskit.transpiler.passes.CheckMap.md | 2 +- .../qiskit.transpiler.passes.Collect1qRuns.md | 2 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 2 +- ...skit.transpiler.passes.CollectCliffords.md | 2 +- ...ranspiler.passes.CollectLinearFunctions.md | 2 +- ...t.transpiler.passes.CollectMultiQBlocks.md | 2 +- ...t.transpiler.passes.CommutationAnalysis.md | 2 +- ...anspiler.passes.CommutativeCancellation.md | 2 +- ...r.passes.CommutativeInverseCancellation.md | 2 +- ...transpiler.passes.Commuting2qGateRouter.md | 2 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 2 +- ...transpiler.passes.ConstrainedReschedule.md | 2 +- ...t.transpiler.passes.ContainsInstruction.md | 2 +- ...nspiler.passes.ConvertConditionsToIfOps.md | 2 +- .../dev/qiskit.transpiler.passes.CountOps.md | 2 +- ...t.transpiler.passes.CountOpsLongestPath.md | 2 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 2 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 2 +- .../dev/qiskit.transpiler.passes.Decompose.md | 2 +- .../qiskit.transpiler.passes.DenseLayout.md | 2 +- .../dev/qiskit.transpiler.passes.Depth.md | 2 +- ...t.transpiler.passes.DynamicalDecoupling.md | 2 +- ...nspiler.passes.EchoRZXWeylDecomposition.md | 2 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 2 +- .../qiskit.transpiler.passes.FilterOpNodes.md | 2 +- .../qiskit.transpiler.passes.FixedPoint.md | 2 +- ...transpiler.passes.FullAncillaAllocation.md | 2 +- .../qiskit.transpiler.passes.GateDirection.md | 2 +- .../qiskit.transpiler.passes.GatesInBasis.md | 2 +- .../dev/qiskit.transpiler.passes.HLSConfig.md | 2 +- ...it.transpiler.passes.HighLevelSynthesis.md | 2 +- ...qiskit.transpiler.passes.HoareOptimizer.md | 2 +- ...nspiler.passes.InstructionDurationCheck.md | 2 +- ...t.transpiler.passes.InverseCancellation.md | 2 +- ...skit.transpiler.passes.Layout2qDistance.md | 2 +- ...er.passes.LinearFunctionsToPermutations.md | 2 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 2 +- ...transpiler.passes.MergeAdjacentBarriers.md | 2 +- .../qiskit.transpiler.passes.MinimumPoint.md | 2 +- ...skit.transpiler.passes.NormalizeRXAngle.md | 2 +- ...skit.transpiler.passes.NumTensorFactors.md | 2 +- ...iskit.transpiler.passes.Optimize1qGates.md | 2 +- ...ler.passes.Optimize1qGatesDecomposition.md | 2 +- ...passes.Optimize1qGatesSimpleCommutation.md | 2 +- ...kit.transpiler.passes.OptimizeAnnotated.md | 2 +- ...kit.transpiler.passes.OptimizeCliffords.md | 2 +- .../dev/qiskit.transpiler.passes.PadDelay.md | 2 +- ...ranspiler.passes.PadDynamicalDecoupling.md | 2 +- .../qiskit.transpiler.passes.PulseGates.md | 2 +- ....transpiler.passes.RXCalibrationBuilder.md | 2 +- ...transpiler.passes.RZXCalibrationBuilder.md | 2 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 2 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 2 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 2 +- ...anspiler.passes.RemoveFinalMeasurements.md | 2 +- ...ranspiler.passes.RemoveResetInZeroState.md | 2 +- ....passes.ResetAfterMeasureSimplification.md | 2 +- .../qiskit.transpiler.passes.SabreLayout.md | 2 +- ...qiskit.transpiler.passes.SabrePreLayout.md | 2 +- .../dev/qiskit.transpiler.passes.SabreSwap.md | 2 +- .../qiskit.transpiler.passes.SetIOLatency.md | 2 +- .../dev/qiskit.transpiler.passes.SetLayout.md | 2 +- .../dev/qiskit.transpiler.passes.Size.md | 2 +- .../qiskit.transpiler.passes.SolovayKitaev.md | 2 +- ...ranspiler.passes.SolovayKitaevSynthesis.md | 2 +- ...qiskit.transpiler.passes.StochasticSwap.md | 2 +- ....transpiler.passes.TemplateOptimization.md | 2 +- ...it.transpiler.passes.TimeUnitConversion.md | 2 +- ...iler.passes.TranslateParameterizedGates.md | 2 +- .../qiskit.transpiler.passes.TrivialLayout.md | 2 +- ...skit.transpiler.passes.UnitarySynthesis.md | 2 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 2 +- ...anspiler.passes.UnrollCustomDefinitions.md | 2 +- ...qiskit.transpiler.passes.UnrollForLoops.md | 2 +- .../dev/qiskit.transpiler.passes.VF2Layout.md | 2 +- .../qiskit.transpiler.passes.VF2PostLayout.md | 2 +- ...it.transpiler.passes.ValidatePulseGates.md | 2 +- .../dev/qiskit.transpiler.passes.Width.md | 2 +- ...nthesis.plugin.HighLevelSynthesisPlugin.md | 2 +- ....plugin.HighLevelSynthesisPluginManager.md | 2 +- ...synthesis.plugin.UnitarySynthesisPlugin.md | 2 +- ...is.plugin.UnitarySynthesisPluginManager.md | 2 +- ...lugin.high_level_synthesis_plugin_names.md | 2 +- ...s.plugin.unitary_synthesis_plugin_names.md | 2 +- ...smanagers.plugin.PassManagerStagePlugin.md | 2 +- ...rs.plugin.PassManagerStagePluginManager.md | 2 +- .../qiskit.visualization.array_to_latex.md | 2 +- .../qiskit.visualization.circuit_drawer.md | 2 +- .../dev/qiskit.visualization.dag_drawer.md | 2 +- ...iskit.visualization.pass_manager_drawer.md | 2 +- ...it.visualization.plot_bloch_multivector.md | 2 +- .../qiskit.visualization.plot_bloch_vector.md | 2 +- ...iskit.visualization.plot_circuit_layout.md | 2 +- .../qiskit.visualization.plot_coupling_map.md | 2 +- .../qiskit.visualization.plot_distribution.md | 2 +- .../qiskit.visualization.plot_error_map.md | 2 +- .../dev/qiskit.visualization.plot_gate_map.md | 2 +- .../qiskit.visualization.plot_histogram.md | 2 +- .../qiskit.visualization.plot_state_city.md | 2 +- .../qiskit.visualization.plot_state_hinton.md | 2 +- ...iskit.visualization.plot_state_paulivec.md | 2 +- ...qiskit.visualization.plot_state_qsphere.md | 2 +- ...skit.visualization.visualize_transition.md | 2 +- docs/api/qiskit/dev/qpy.md | 8 +- docs/api/qiskit/dev/quantum_info.md | 54 +++---- docs/api/qiskit/dev/result.md | 8 +- docs/api/qiskit/dev/scheduler.md | 8 +- docs/api/qiskit/dev/synthesis.md | 46 +++--- docs/api/qiskit/dev/synthesis_aqc.md | 2 +- docs/api/qiskit/dev/transpiler.md | 12 +- docs/api/qiskit/dev/transpiler_passes.md | 2 +- docs/api/qiskit/dev/transpiler_plugins.md | 4 +- docs/api/qiskit/dev/transpiler_preset.md | 26 ++-- docs/api/qiskit/dev/utils.md | 28 ++-- docs/api/qiskit/dev/visualization.md | 2 +- 481 files changed, 764 insertions(+), 764 deletions(-) diff --git a/docs/api/qiskit/dev/assembler.md b/docs/api/qiskit/dev/assembler.md index 3edc543c3ca..9c05951f5eb 100644 --- a/docs/api/qiskit/dev/assembler.md +++ b/docs/api/qiskit/dev/assembler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.assembler -`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/assemble_circuits.py "view source code") +`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. @@ -69,7 +69,7 @@ qobj = assemble_circuits(circuits=[qc], -`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/assemble_schedules.py "view source code") +`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. @@ -135,7 +135,7 @@ pulseQobj = assemble_schedules(schedules=[schedule], -`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/disassemble.py "view source code") +`qiskit.assembler.disassemble(qobj)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/dev/circuit.md b/docs/api/qiskit/dev/circuit.md index 5f5b6b27810..70478d38150 100644 --- a/docs/api/qiskit/dev/circuit.md +++ b/docs/api/qiskit/dev/circuit.md @@ -289,7 +289,7 @@ with qc.switch(cr) as case: -`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/random/utils.py "view source code") +`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. @@ -334,7 +334,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c -`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/exceptions.py "view source code") +`qiskit.circuit.CircuitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/exceptions.py "view source code") Base class for errors raised while processing a circuit. diff --git a/docs/api/qiskit/dev/circuit_classical.md b/docs/api/qiskit/dev/circuit_classical.md index 8cd8a8f518f..179c6db472c 100644 --- a/docs/api/qiskit/dev/circuit_classical.md +++ b/docs/api/qiskit/dev/circuit_classical.md @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are -`qiskit.circuit.classical.expr.Expr`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") +`qiskit.circuit.classical.expr.Expr` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap -`final class qiskit.circuit.classical.expr.Var(var, type)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Var(var, type)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") A classical variable. @@ -74,7 +74,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` -`final class qiskit.circuit.classical.expr.Value(value, type)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Value(value, type)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") A single scalar value. @@ -82,7 +82,7 @@ The operations traditionally associated with pre-, post- or infix operators in p -`final class qiskit.circuit.classical.expr.Unary(op, operand, type)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Unary(op, operand, type)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") A unary expression. @@ -120,7 +120,7 @@ Logical negation. `!operand`. -`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") A binary expression. @@ -237,7 +237,7 @@ Expressions in this system are defined to act only on certain sets of types. How -`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/expr.py "view source code") A cast from one type to another, implied by the use of an expression in a different context. @@ -253,7 +253,7 @@ The functions and methods described in this section are a more user-friendly way -`qiskit.circuit.classical.expr.lift(value, /, type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift(value, /, type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Lift the given Python `value` to a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value") or [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var"). @@ -293,7 +293,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo -`qiskit.circuit.classical.expr.cast(operand, type, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.cast(operand, type, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create an explicit cast from the given value to the given type. @@ -318,7 +318,7 @@ There are helper constructor functions for each of the unary operations. -`qiskit.circuit.classical.expr.bit_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -341,7 +341,7 @@ Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) -`qiskit.circuit.classical.expr.logic_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_not(operand, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -366,7 +366,7 @@ Similarly, the binary operations and relations have helper functions defined. -`qiskit.circuit.classical.expr.bit_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -389,7 +389,7 @@ Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint -`qiskit.circuit.classical.expr.bit_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -412,7 +412,7 @@ Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint( -`qiskit.circuit.classical.expr.bit_xor(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_xor(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a bitwise ‘exclusive or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -435,7 +435,7 @@ Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.logic_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_and(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -458,7 +458,7 @@ Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool -`qiskit.circuit.classical.expr.logic_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_or(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a logical ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -481,7 +481,7 @@ Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool( -`qiskit.circuit.classical.expr.equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create an ‘equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -504,7 +504,7 @@ Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3 -`qiskit.circuit.classical.expr.not_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.not_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘not equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -527,7 +527,7 @@ Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Ui -`qiskit.circuit.classical.expr.less(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -550,7 +550,7 @@ Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3) -`qiskit.circuit.classical.expr.less_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘less than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -573,7 +573,7 @@ Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(Classi -`qiskit.circuit.classical.expr.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -596,7 +596,7 @@ Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.greater_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater_equal(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Create a ‘greater than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -621,7 +621,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition -`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/constructors.py "view source code") Lift a legacy two-tuple equality condition into a new-style [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"). @@ -650,7 +650,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/visitors.py "view source code") Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. @@ -722,7 +722,7 @@ For the convenience of simple visitors that only need to inspect the variables i -`qiskit.circuit.classical.expr.iter_vars(node)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.iter_vars(node)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/visitors.py "view source code") Get an iterator over the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") nodes referenced at any level in the given [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr"). @@ -752,7 +752,7 @@ Two expressions can be compared for direct structural equality by using the buil -`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/expr/visitors.py "view source code") Do these two expressions have exactly the same tree structure, up to some key function for the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") objects? @@ -815,7 +815,7 @@ All types inherit from an abstract base class: -`qiskit.circuit.classical.types.Type`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/types.py "view source code") +`qiskit.circuit.classical.types.Type` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/types.py "view source code") Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -827,13 +827,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q -`final class qiskit.circuit.classical.types.Bool`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Bool` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/types.py "view source code") The Boolean type. This has exactly two values: `True` and `False`. -`final class qiskit.circuit.classical.types.Uint(width)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Uint(width)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/types.py "view source code") An unsigned integer of fixed bit width. @@ -853,7 +853,7 @@ The low-level interface to querying the subtyping relationship is the [`order()` -`qiskit.circuit.classical.types.order(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.order(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") Get the ordering relationship between the two types as an enumeration value. @@ -882,7 +882,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. -`qiskit.circuit.classical.types.Ordering(value)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.Ordering(value)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -894,7 +894,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis -`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \le \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -925,7 +925,7 @@ False -`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") Does the relation $\text{left} \ge \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -956,7 +956,7 @@ False -`qiskit.circuit.classical.types.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.greater(left, right, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") Get the greater of the two types, assuming that there is an ordering relation between them. Technically, this is a slightly restricted version of the concept of the ‘meet’ of the two types in that the return value must be one of the inputs. In practice in the type system there is no concept of a ‘sum’ type, so the ‘meet’ exists if and only if there is an ordering between the two types, and is equal to the greater of the two types. @@ -990,7 +990,7 @@ It is common to need to cast values of one type to another type. The casting rul -`qiskit.circuit.classical.types.cast_kind(from_, to_, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.cast_kind(from_, to_, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") Determine the sort of cast that is required to move from the left type to the right type. @@ -1016,7 +1016,7 @@ The return values from this function are an enumeration explaining the types of -`qiskit.circuit.classical.types.CastKind(value)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.CastKind(value)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classical/types/ordering.py "view source code") A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/dev/circuit_library.md b/docs/api/qiskit/dev/circuit_library.md index 3032ad7ae20..da75e21bbc2 100644 --- a/docs/api/qiskit/dev/circuit_library.md +++ b/docs/api/qiskit/dev/circuit_library.md @@ -328,7 +328,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib -`qiskit.circuit.library.templates.nct.template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** @@ -342,7 +342,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** @@ -356,7 +356,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** @@ -370,7 +370,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** @@ -384,7 +384,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** @@ -398,7 +398,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** @@ -412,7 +412,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** @@ -426,7 +426,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** @@ -440,7 +440,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** @@ -454,7 +454,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** @@ -468,7 +468,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** @@ -482,7 +482,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** @@ -496,7 +496,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** @@ -510,7 +510,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** @@ -524,7 +524,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** @@ -538,7 +538,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** @@ -552,7 +552,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** @@ -566,7 +566,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** @@ -580,7 +580,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** @@ -594,7 +594,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** @@ -608,7 +608,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7b_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** @@ -622,7 +622,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** @@ -636,7 +636,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** @@ -650,7 +650,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7e_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** @@ -664,7 +664,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9a_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** @@ -678,7 +678,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** @@ -692,7 +692,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** @@ -706,7 +706,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** @@ -720,7 +720,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** @@ -734,7 +734,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_5()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** @@ -748,7 +748,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_6()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** @@ -762,7 +762,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_7()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** @@ -776,7 +776,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_8()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** @@ -790,7 +790,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_9()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** @@ -804,7 +804,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_10()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** @@ -818,7 +818,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_11()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** @@ -832,7 +832,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_12()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** @@ -846,7 +846,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** @@ -860,7 +860,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** @@ -874,7 +874,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** @@ -888,7 +888,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** @@ -902,7 +902,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_5()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** @@ -916,7 +916,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_6()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** @@ -930,7 +930,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_7()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** @@ -944,7 +944,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_8()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** @@ -958,7 +958,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_9()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** @@ -972,7 +972,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_10()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** @@ -990,7 +990,7 @@ Template circuits over Clifford gates. -`qiskit.circuit.library.clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`qiskit.circuit.library.clifford_2_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** @@ -1004,7 +1004,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`qiskit.circuit.library.clifford_2_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** @@ -1018,7 +1018,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`qiskit.circuit.library.clifford_2_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** @@ -1032,7 +1032,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`qiskit.circuit.library.clifford_2_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** @@ -1046,7 +1046,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`qiskit.circuit.library.clifford_3_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** @@ -1060,7 +1060,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`qiskit.circuit.library.clifford_4_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** @@ -1074,7 +1074,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`qiskit.circuit.library.clifford_4_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** @@ -1088,7 +1088,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`qiskit.circuit.library.clifford_4_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** @@ -1102,7 +1102,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`qiskit.circuit.library.clifford_4_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** @@ -1116,7 +1116,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`qiskit.circuit.library.clifford_5_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** @@ -1130,7 +1130,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`qiskit.circuit.library.clifford_6_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** @@ -1144,7 +1144,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`qiskit.circuit.library.clifford_6_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** @@ -1158,7 +1158,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`qiskit.circuit.library.clifford_6_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** @@ -1172,7 +1172,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`qiskit.circuit.library.clifford_6_4()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** @@ -1186,7 +1186,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`qiskit.circuit.library.clifford_6_5()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** @@ -1200,7 +1200,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`qiskit.circuit.library.clifford_8_1()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** @@ -1214,7 +1214,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`qiskit.circuit.library.clifford_8_2()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** @@ -1228,7 +1228,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`qiskit.circuit.library.clifford_8_3()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** @@ -1246,7 +1246,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui -`qiskit.circuit.library.rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`qiskit.circuit.library.rzx_yz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. @@ -1254,7 +1254,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`qiskit.circuit.library.rzx_xz(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. @@ -1262,7 +1262,7 @@ Template for CX - RXGate - CX. -`qiskit.circuit.library.rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`qiskit.circuit.library.rzx_cy(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. @@ -1270,7 +1270,7 @@ Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`qiskit.circuit.library.rzx_zz1(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. @@ -1278,7 +1278,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`qiskit.circuit.library.rzx_zz2(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. @@ -1286,7 +1286,7 @@ Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`qiskit.circuit.library.rzx_zz3(theta=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/dev/circuit_singleton.md b/docs/api/qiskit/dev/circuit_singleton.md index db5ed51e7ad..28e4e6e72de 100644 --- a/docs/api/qiskit/dev/circuit_singleton.md +++ b/docs/api/qiskit/dev/circuit_singleton.md @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir -`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/singleton.py "view source code") A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. @@ -56,7 +56,7 @@ The exception to be aware of with this class though are the [`Instruction`](qisk -`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/singleton.py "view source code") A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. @@ -64,7 +64,7 @@ This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton -`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/singleton.py "view source code") A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances diff --git a/docs/api/qiskit/dev/compiler.md b/docs/api/qiskit/dev/compiler.md index aa67f478563..477334f0778 100644 --- a/docs/api/qiskit/dev/compiler.md +++ b/docs/api/qiskit/dev/compiler.md @@ -24,7 +24,7 @@ python_api_name: qiskit.compiler -`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/assembler.py "view source code") +`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. @@ -107,7 +107,7 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will -`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/scheduler.py "view source code") +`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`. @@ -136,7 +136,7 @@ A pulse `Schedule` that implements the input circuit -`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/transpiler.py "view source code") +`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False, num_processes=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. @@ -286,7 +286,7 @@ The transpiled circuit(s). -`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/sequencer.py "view source code") +`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/dev/converters.md b/docs/api/qiskit/dev/converters.md index d3a07f79f94..f49c19695c0 100644 --- a/docs/api/qiskit/dev/converters.md +++ b/docs/api/qiskit/dev/converters.md @@ -22,7 +22,7 @@ python_api_name: qiskit.converters -`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_dag.py "view source code") +`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_dag.py "view source code") Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -66,7 +66,7 @@ dag = circuit_to_dag(circ) -`qiskit.converters.dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dag_to_circuit.py "view source code") +`qiskit.converters.dag_to_circuit(dag, copy_operations=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. @@ -110,7 +110,7 @@ circuit.draw('mpl') -`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_instruction.py "view source code") +`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -155,7 +155,7 @@ circuit_to_instruction(circ) -`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_gate.py "view source code") +`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -184,7 +184,7 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g -`qiskit.converters.dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dagdependency_to_circuit.py "view source code") +`qiskit.converters.dagdependency_to_circuit(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. @@ -204,7 +204,7 @@ the circuit representing the input dag dependency. -`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_dagdependency.py "view source code") +`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -225,7 +225,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dag_to_dagdependency.py "view source code") +`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. @@ -246,7 +246,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dagdependency_to_dag.py "view source code") +`qiskit.converters.dagdependency_to_dag(dagdependency)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/dev/dagcircuit.md b/docs/api/qiskit/dev/dagcircuit.md index c8a99cbc105..159497aa7af 100644 --- a/docs/api/qiskit/dev/dagcircuit.md +++ b/docs/api/qiskit/dev/dagcircuit.md @@ -36,7 +36,7 @@ python_api_name: qiskit.dagcircuit -`qiskit.dagcircuit.DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGCircuitError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. @@ -46,7 +46,7 @@ Set the error message. -`qiskit.dagcircuit.DAGDependencyError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGDependencyError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGDependency object. diff --git a/docs/api/qiskit/dev/exceptions.md b/docs/api/qiskit/dev/exceptions.md index 51e8b28a7dd..9028943d3c5 100644 --- a/docs/api/qiskit/dev/exceptions.md +++ b/docs/api/qiskit/dev/exceptions.md @@ -26,7 +26,7 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base: -`qiskit.exceptions.QiskitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Base class for errors raised by Qiskit. @@ -44,7 +44,7 @@ Qiskit has several optional features that depend on other packages that are not -`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Raised when an optional library is missing. @@ -56,7 +56,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, -`qiskit.exceptions.QiskitUserConfigError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitUserConfigError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Raised when an error is encountered reading a user config file. @@ -66,7 +66,7 @@ Set the error message. -`qiskit.exceptions.InvalidFileError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.InvalidFileError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Raised when the file provided is not valid for the specific task. @@ -80,7 +80,7 @@ Some particular features of Qiskit may raise custom warnings. In general, Qiskit -`qiskit.exceptions.QiskitWarning`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitWarning` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Common subclass of warnings for Qiskit-specific warnings being raised. @@ -90,7 +90,7 @@ Related to [`MissingOptionalLibraryError`](#qiskit.exceptions.MissingOptionalLib -`qiskit.exceptions.OptionalDependencyImportWarning`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.OptionalDependencyImportWarning` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Raised when an optional library raises errors during its import. @@ -104,7 +104,7 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni -`qiskit.exceptions.ExperimentalWarning`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") +`qiskit.exceptions.ExperimentalWarning` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/exceptions.py "view source code") Raised when an experimental feature is being used. diff --git a/docs/api/qiskit/dev/passmanager.md b/docs/api/qiskit/dev/passmanager.md index e8b61dd8a3f..d28d6e689e0 100644 --- a/docs/api/qiskit/dev/passmanager.md +++ b/docs/api/qiskit/dev/passmanager.md @@ -164,7 +164,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza -`qiskit.passmanager.PassManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/exceptions.py "view source code") +`qiskit.passmanager.PassManagerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/exceptions.py "view source code") Pass manager error. diff --git a/docs/api/qiskit/dev/providers.md b/docs/api/qiskit/dev/providers.md index ba43fc9b098..37a02bf1983 100644 --- a/docs/api/qiskit/dev/providers.md +++ b/docs/api/qiskit/dev/providers.md @@ -79,7 +79,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p -`qiskit.providers.QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.QiskitBackendNotFoundError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. @@ -89,7 +89,7 @@ Set the error message. -`qiskit.providers.BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendPropertyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. @@ -99,7 +99,7 @@ Set the error message. -`qiskit.providers.JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. @@ -109,7 +109,7 @@ Set the error message. -`qiskit.providers.JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. @@ -119,7 +119,7 @@ Set the error message. -`qiskit.providers.BackendConfigurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendConfigurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/exceptions.py "view source code") Base class for errors raised by the BackendConfiguration. diff --git a/docs/api/qiskit/dev/providers_fake_provider.md b/docs/api/qiskit/dev/providers_fake_provider.md index 9a24b64058a..076599fc24f 100644 --- a/docs/api/qiskit/dev/providers_fake_provider.md +++ b/docs/api/qiskit/dev/providers_fake_provider.md @@ -83,7 +83,7 @@ The V1 fake backends are based on a set of base classes: -`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_backend.py "view source code") This is a dummy backend just for testing purposes. @@ -96,7 +96,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakeQasmBackend`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") +`qiskit.providers.fake_provider.FakeQasmBackend` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") A fake OpenQASM backend. @@ -109,7 +109,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakePulseBackend`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") +`qiskit.providers.fake_provider.FakePulseBackend` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") A fake pulse backend. diff --git a/docs/api/qiskit/dev/pulse.md b/docs/api/qiskit/dev/pulse.md index c2c681134e9..80c9032270e 100644 --- a/docs/api/qiskit/dev/pulse.md +++ b/docs/api/qiskit/dev/pulse.md @@ -72,7 +72,7 @@ These are all instances of the same base class: -`qiskit.pulse.instructions.Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/instruction.py "view source code") +`qiskit.pulse.instructions.Instruction(operands, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -165,7 +165,7 @@ All channels are children of the same abstract base class: -`qiskit.pulse.channels.Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.Channel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -220,7 +220,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`qiskit.pulse.transforms.AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignmentKind(context_params)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -236,7 +236,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -261,7 +261,7 @@ A `Schedule` with the additional acquisition instructions. -`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. @@ -330,7 +330,7 @@ The input list of schedules transformed to have their measurements aligned. -`qiskit.pulse.transforms.block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.block_to_schedule(block)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. @@ -359,7 +359,7 @@ Scheduled pulse program. -`qiskit.pulse.transforms.compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.compress_pulses(schedules)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. @@ -379,7 +379,7 @@ Compressed schedules. -`qiskit.pulse.transforms.flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.flatten(program)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. @@ -403,7 +403,7 @@ Flatten pulse program. -`qiskit.pulse.transforms.inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.inline_subroutines(program)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. @@ -429,7 +429,7 @@ A schedule without subroutine. -`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. @@ -457,7 +457,7 @@ The padded schedule. -`qiskit.pulse.transforms.remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_directives(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. @@ -477,7 +477,7 @@ A schedule without directives. -`qiskit.pulse.transforms.remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_trivial_barriers(schedule)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. @@ -503,7 +503,7 @@ The DAG transforms create DAG representation of input program. This can be used -`qiskit.pulse.transforms.block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/dag.py "view source code") +`qiskit.pulse.transforms.block_to_dag(block)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. @@ -563,7 +563,7 @@ A sequence of transformations to generate a target code. -`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/base_transforms.py "view source code") +`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. @@ -782,7 +782,7 @@ The above is just a small taste of what is possible with the builder. See the re -`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. @@ -844,7 +844,7 @@ DriveChannel(0) -`qiskit.pulse.builder.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. @@ -872,7 +872,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.control_channels(*qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. @@ -909,7 +909,7 @@ List of control channels associated with the supplied ordered list of qubits. -`qiskit.pulse.builder.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. @@ -937,7 +937,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. @@ -998,7 +998,7 @@ drive_sched.draw() -`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1037,7 +1037,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. @@ -1106,7 +1106,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1277,7 +1277,7 @@ Currently, the backend calibrated gates are provided in the form of [`Schedule`] -`qiskit.pulse.builder.delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. @@ -1302,7 +1302,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. @@ -1327,7 +1327,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. @@ -1354,7 +1354,7 @@ main_prog.assign_references(subroutine_dict={("x_gate", "q0"): subroutine}) -`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. @@ -1379,7 +1379,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. @@ -1406,7 +1406,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. @@ -1431,7 +1431,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_phase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. @@ -1458,7 +1458,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Simulator snapshot. @@ -1502,7 +1502,7 @@ pulse_prog.draw() -`qiskit.pulse.builder.align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_equispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. @@ -1550,7 +1550,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_func(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. @@ -1604,7 +1604,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_left()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. @@ -1641,7 +1641,7 @@ None -`qiskit.pulse.builder.align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_right()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. @@ -1678,7 +1678,7 @@ None -`qiskit.pulse.builder.align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_sequential()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. @@ -1715,7 +1715,7 @@ None -`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. @@ -1761,7 +1761,7 @@ None -`qiskit.pulse.builder.phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.phase_offset(phase, *channels)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. @@ -1817,7 +1817,7 @@ MemorySlot(0) -`qiskit.pulse.builder.measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure(qubits, registers=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. @@ -1874,7 +1874,7 @@ The `register` the qubit measurement result will be stored in. -`qiskit.pulse.builder.measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_all()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. @@ -1909,7 +1909,7 @@ The `register`s the qubit measurement results will be stored in. -`qiskit.pulse.builder.delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay_qubits(duration, *qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Insert delays on all the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -1968,7 +1968,7 @@ There are 1e-06 seconds in 4500 samples. -`qiskit.pulse.builder.active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_backend()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. @@ -1990,7 +1990,7 @@ builder context. -`qiskit.pulse.builder.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.num_qubits()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. @@ -2022,7 +2022,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.qubit_channels(qubit)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. @@ -2058,7 +2058,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.samples_to_seconds(samples)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2078,7 +2078,7 @@ The time that elapses in `samples`. -`qiskit.pulse.builder.seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.seconds_to_samples(seconds)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. @@ -2108,7 +2108,7 @@ The number of samples for the time to elapse -`qiskit.pulse.PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.PulseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. @@ -2118,7 +2118,7 @@ Set the error message. -`qiskit.pulse.BackendNotSet(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.BackendNotSet(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") Raised if the builder context does not have a backend. @@ -2128,7 +2128,7 @@ Set the error message. -`qiskit.pulse.NoActiveBuilder(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.NoActiveBuilder(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") Raised if no builder context is active. @@ -2138,7 +2138,7 @@ Set the error message. -`qiskit.pulse.UnassignedDurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedDurationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") Raised if instruction duration is unassigned. @@ -2148,7 +2148,7 @@ Set the error message. -`qiskit.pulse.UnassignedReferenceError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedReferenceError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/exceptions.py "view source code") Raised if subroutine is unassigned. diff --git a/docs/api/qiskit/dev/qasm2.md b/docs/api/qiskit/dev/qasm2.md index 80d75b445cb..2e37c8ea09f 100644 --- a/docs/api/qiskit/dev/qasm2.md +++ b/docs/api/qiskit/dev/qasm2.md @@ -34,7 +34,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -59,7 +59,7 @@ A circuit object representing the same OpenQASM 2 program. -`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/__init__.py "view source code") Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -89,7 +89,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/parse.py "view source code") +`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/parse.py "view source code") Information about a custom instruction that should be defined during the parse. @@ -129,7 +129,7 @@ Similar to other serialisation modules in Python, this module offers two public -`qiskit.qasm2.dump(circuit, filename_or_stream, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dump(circuit, filename_or_stream, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/export.py "view source code") Dump a circuit as an OpenQASM 2 program to a file or stream. @@ -146,7 +146,7 @@ Dump a circuit as an OpenQASM 2 program to a file or stream. -`qiskit.qasm2.dumps(circuit, /)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dumps(circuit, /)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/export.py "view source code") Export a circuit to an OpenQASM 2 program in a string. @@ -174,7 +174,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep -`qiskit.qasm2.QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2Error(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/exceptions.py "view source code") A general error raised by the OpenQASM 2 interoperation layer. @@ -186,7 +186,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`qiskit.qasm2.QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to parse an OpenQASM 2 file. @@ -198,7 +198,7 @@ When the exporters fail to export a circuit, likely because it has structure tha -`qiskit.qasm2.QASM2ExportError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ExportError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm2/exceptions.py "view source code") An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. diff --git a/docs/api/qiskit/dev/qasm3.md b/docs/api/qiskit/dev/qasm3.md index 0c85e373aa5..85ca3bcfc72 100644 --- a/docs/api/qiskit/dev/qasm3.md +++ b/docs/api/qiskit/dev/qasm3.md @@ -28,7 +28,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`qiskit.qasm3.dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dump(circuit, stream, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. @@ -42,7 +42,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`qiskit.qasm3.dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dumps(circuit, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. @@ -63,7 +63,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/exporter.py "view source code") +`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -117,7 +117,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`qiskit.qasm3.QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ExporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -129,7 +129,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`qiskit.qasm3.ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/experimental.py "view source code") +`qiskit.qasm3.ExperimentalFeatures(value)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/experimental.py "view source code") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -227,7 +227,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`qiskit.qasm3.load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.load(filename)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -251,7 +251,7 @@ a circuit representation of the OpenQASM 3 program. -`qiskit.qasm3.loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.loads(program)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -277,7 +277,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`qiskit.qasm3.QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ImporterError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/dev/qiskit.assembler.RunConfig.md b/docs/api/qiskit/dev/qiskit.assembler.RunConfig.md index 060d977487d..64da9f55c24 100644 --- a/docs/api/qiskit/dev/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/dev/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/run_config.py "view source code") +`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/assembler/run_config.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/dev/qiskit.circuit.AncillaQubit.md index d42568f1382..934aace6abb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`qiskit.circuit.AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaQubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/dev/qiskit.circuit.AncillaRegister.md index 19973db7fa2..5a0319f1038 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/dev/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Bit.md b/docs/api/qiskit/dev/qiskit.circuit.Bit.md index 10f6581e1b2..0cf3dae054e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`qiskit.circuit.Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/bit.py "view source code") +`qiskit.circuit.Bit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/bit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.md index 16348e7561a..2ac71440b83 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/break_loop.py "view source code") +`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md index afe000486e1..bf261b9a267 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Clbit.md b/docs/api/qiskit/dev/qiskit.circuit.Clbit.md index a261385ec57..f6e84c983bf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`qiskit.circuit.Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.Clbit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.md index 39cf42a81df..044251bbd43 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/continue_loop.py "view source code") +`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.md index 8d44fd5c431..934768c6a12 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/control_flow.py "view source code") +`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md index 1b13701fea9..a2f81d4608e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlledgate.py "view source code") +`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlledgate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Delay.md b/docs/api/qiskit/dev/qiskit.circuit.Delay.md index 9dac1fb5cd1..98573dcf0d1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`qiskit.circuit.Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/delay.py "view source code") +`qiskit.circuit.Delay(duration, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/delay.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.md index 92d0206b509..7b912c269c0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`qiskit.circuit.EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/equivalence.py "view source code") +`qiskit.circuit.EquivalenceLibrary(*, base=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/equivalence.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.md index edeafeeface..16bf4d60335 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/for_loop.py "view source code") +`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Gate.md b/docs/api/qiskit/dev/qiskit.circuit.Gate.md index 2ab3e862a7a..cbf141683ec 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/gate.py "view source code") +`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/gate.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.md index 49c3a48cf2f..c9ccbbd5fe7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/if_else.py "view source code") +`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Instruction.md b/docs/api/qiskit/dev/qiskit.circuit.Instruction.md index 60ab200fd6e..8bc07da8a46 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/instruction.py "view source code") +`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/instruction.py "view source code") Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.md index 3b77031c1a6..f92d724f9f5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`qiskit.circuit.InstructionSet(*, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/instructionset.py "view source code") +`qiskit.circuit.InstructionSet(*, resource_requester=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/instructionset.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Operation.md b/docs/api/qiskit/dev/qiskit.circuit.Operation.md index 2ae9bbdd9eb..5bdd9baedee 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`qiskit.circuit.Operation`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/operation.py "view source code") +`qiskit.circuit.Operation` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/operation.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Parameter.md b/docs/api/qiskit/dev/qiskit.circuit.Parameter.md index a975d294747..46779a707b7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`qiskit.circuit.Parameter(name, *, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/parameter.py "view source code") +`qiskit.circuit.Parameter(name, *, uuid=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/parameter.py "view source code") Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md index 3778c44a233..0ddfc1438d5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`qiskit.circuit.ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/parameterexpression.py "view source code") +`qiskit.circuit.ParameterExpression(symbol_map, expr)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/parameterexpression.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.md index 9e250ab3751..315adb2cc5c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`qiskit.circuit.ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/parametervector.py "view source code") +`qiskit.circuit.ParameterVector(name, length=0)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/parametervector.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md index afa40cbf292..0ab1da5ef7f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumcircuit.py "view source code") +`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md index d1cd3b3d2d4..b928631ba6f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Qubit.md b/docs/api/qiskit/dev/qiskit.circuit.Qubit.md index cd7c23fdf0e..e722126e60d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`qiskit.circuit.Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.Qubit(register=None, index=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/quantumregister.py "view source code") Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.Register.md b/docs/api/qiskit/dev/qiskit.circuit.Register.md index 4537124accb..747e6798b7f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Register.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`qiskit.circuit.Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/register.py "view source code") +`qiskit.circuit.Register(size=None, name=None, bits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/register.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.md index 5b0dda8af2d..d240ae616f5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/switch_case.py "view source code") +`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/switch_case.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.md index 03cddab2456..cb394171003 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`qiskit.circuit.WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/while_loop.py "view source code") +`qiskit.circuit.WhileLoopOp(condition, body, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md index 3dc23660475..2bfb7d7b35d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md index 0841f68c4a2..a1ec5fa6031 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `ClassicalElement` diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 8035f0a6774..074eb8108fd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index e1b593c45fb..b6ab1aa26bc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.AND.md b/docs/api/qiskit/dev/qiskit.circuit.library.AND.md index e79e9a24ee4..76e51f8df0d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/dev/qiskit.circuit.library.Barrier.md index 81066496a6b..64152530907 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`qiskit.circuit.library.Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/barrier.py "view source code") +`qiskit.circuit.library.Barrier(num_qubits, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/barrier.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md index 8a25873f1ea..825927ac1ee 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md index 6d77d873140..90c67ee0bed 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md index b4e64ca083b..6b3ce1f3727 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md index a67d82e2093..b846747aa18 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md index 386832b4e25..1ad75cee8ba 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md index bbae0437590..62efbeff07a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.md index 3fc3abcab5e..2ae3c7f7290 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md index 77c828fd235..aa625fac5dd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md index e22c8db4756..9dc26c1654b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md index 13f33b1119b..b8e45f89ff8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md index 2853201f508..d0780bcaca4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md index 841863ba972..e0a6982cbfe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.md index 38cf5e29764..813b1238085 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md index c6dc520697d..e1610edad55 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md index 94bd57c0cea..075bf447af0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md index 831bd30430b..1069e0a74f2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md index 5cf6af40800..50bddb3ca40 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md index cd2fd395511..a03c1c7909f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md index 09cf897a531..aff09346f2b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md index 9e6e72c5640..4848259c3d2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md index f4c4945e620..34d94474af9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.md index 0565a31e235..bd79ed6e96f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md index 12db1ab9896..0ca2d407e54 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`qiskit.circuit.library.Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.Diagonal(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.md index f69053ec40d..429a5ff51ec 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate -`qiskit.circuit.library.DiagonalGate(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.DiagonalGate(diag)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md index 8b0940d5f03..b99c32a5196 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md index 241d3d635bf..f773decf910 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md index 7f30a23a4a8..ae664918b25 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 2ff67648e1b..a6e167ddcba 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/evolved_operator_ansatz.py "view source code") +`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/evolved_operator_ansatz.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.md index 7ec56c49224..aad87d77dd4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.md index ec03982825e..b536106a6de 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.md index c9cd98ad29a..05061244298 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`qiskit.circuit.library.FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/fourier_checking.py "view source code") +`qiskit.circuit.library.FourierChecking(f, g)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.md index ba58c8c3689..6c35ecd95bf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.md b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.md index fe884b275d4..617406c588d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`qiskit.circuit.library.GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.GMS(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GR.md b/docs/api/qiskit/dev/qiskit.circuit.library.GR.md index 0dbc6a2a5f3..fa762912bd1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`qiskit.circuit.library.GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GR(num_qubits, theta, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md index ed84cf7da63..140b97221b1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`qiskit.circuit.library.GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRX(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md index e90426a4a38..dad8186ae52 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`qiskit.circuit.library.GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRY(num_qubits, theta)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md index d89afd17588..0c0e7d154f5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`qiskit.circuit.library.GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRZ(num_qubits, phi)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md index ec24b5ef10f..96dee6d33e7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/global_phase.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md index df06fce4ed4..232f12e6913 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`qiskit.circuit.library.GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/graph_state.py "view source code") +`qiskit.circuit.library.GraphState(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/graph_state.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md index 60443d3b9cc..82bf7e456e1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/grover_operator.py "view source code") +`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md index a7124e1cff2..af86d3ffd42 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md index 7d8a3f60a95..47d65c2077d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md index 59f14e67029..3ad589a08e4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate -`qiskit.circuit.library.HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/hamiltonian_gate.py "view source code") +`qiskit.circuit.library.HamiltonianGate(data, time, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/hamiltonian_gate.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md index 23d50dcb74d..4e28b1aee46 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/hidden_linear_function.py "view source code") +`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md index 3b111e25cf7..89f65416761 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/i.py "view source code") +`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md index 887b45539db..0399d93245c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`qiskit.circuit.library.IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/iqp.py "view source code") +`qiskit.circuit.library.IQP(interactions)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/iqp.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.md b/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.md index cdb435eba43..37bcc251c9a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Initialize -`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/initializer.py "view source code") +`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/initializer.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md index d8984499ae2..c30ed311673 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`qiskit.circuit.library.InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`qiskit.circuit.library.InnerProduct(num_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md index 1e3e86d6c30..d63cf7a79f2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.md b/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.md index 386b6100e51..905a43c4cac 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Isometry -`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/isometry.py "view source code") +`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/isometry.py "view source code") Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md index b77e5e03a7a..93cc720b167 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.md index 93adda5fa47..222f15ef6d4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`qiskit.circuit.library.LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`qiskit.circuit.library.LinearFunction(linear, validate_input=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md index 76e37a6432c..621cef07f10 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md index cac16537165..d4a5f0da671 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md index 480d67c4a9d..bea4fea1722 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md index 413e20ff453..d9feeb03245 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md index 7442c14f279..488242be7f7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md index 0ba78cbb15f..da8f400db13 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md index b14fafe738d..892daf16b0b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md index 175d410b95e..f2681b0641d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.md index d5e21df11a7..89d00caa03c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Measure.md b/docs/api/qiskit/dev/qiskit.circuit.library.Measure.md index 0cccc391e04..90eac192755 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`qiskit.circuit.library.Measure(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/measure.py "view source code") +`qiskit.circuit.library.Measure(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/measure.py "view source code") Bases: [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md index 00a19ae09fa..981a41dd126 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/n_local.py "view source code") +`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.OR.md b/docs/api/qiskit/dev/qiskit.circuit.library.OR.md index 58c8b1c8095..bc4df0f4328 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.md index 571b8c1af8d..e91d73a15aa 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/pauli_evolution.py "view source code") +`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md index b115bc645dc..6816e780066 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.md index e5bba4cfefd..83c0e72d123 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`qiskit.circuit.library.PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`qiskit.circuit.library.PauliGate(label)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md index 0bd0a5fb194..c290ba78ad6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md index b222b5e3101..ad1a0380071 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.md index 53789e1e21e..f4ff429d917 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`qiskit.circuit.library.PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.PermutationGate(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md index db3c83e2e28..4a05605113b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/phase_estimation.py "view source code") +`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md index 80eb8d31aa6..32a0345dc48 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md index e95b5da922e..06c67867944 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/phase_oracle.py "view source code") +`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md index 9641b4d949e..8a9efeb2ed0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index dd3b7a6cefc..75d11dc3578 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 4542591517d..63d23cf388a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md index ac2c8147526..75706c99247 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md index 094756243ab..13355b6ecd0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.n_local.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md index 7a14c1f974c..3e76620c544 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/basis_change/qft.py "view source code") +`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md index a3233eca226..5841c651574 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md index 317de5945e8..43a778973be 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/quantum_volume.py "view source code") +`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.md index 53c5f85edcc..f0ab86b433f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.md index 73e94f5c584..4815c50fc1d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md index 9717e7f1142..03de7b8bcf4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `Multiplier` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md index 7ffa9bd7c8f..fe4337fc487 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/r.py "view source code") +`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.md index e94745c4fa8..c4e9257abff 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md index f3a907fb1e6..241619dc6b6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md index eac13c82134..ae3ec02b287 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md index a61e5c744b6..9de0e065ff9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md index 7144a4fa470..27698c31c6c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md index 433bd655915..14527cdc9cb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md index 26076437cd5..dceaa813760 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md index 363007ec57c..01bc529b47a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md index 143907422c0..7e4115fcf0a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Reset.md b/docs/api/qiskit/dev/qiskit.circuit.library.Reset.md index 4ab3a31470e..ea32475e31a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`qiskit.circuit.library.Reset(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/reset.py "view source code") +`qiskit.circuit.library.Reset(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/reset.py "view source code") Bases: [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md index fa97c68bf9d..08b0b517d69 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md index bfd8d7ae3fc..32389b09b04 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md index 7746508140b..5aa79313441 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md index 671ac8f0b20..97909e3f214 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.md index b860ffe3af8..4fd539df2ba 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md index d922e3f925b..6110131f659 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md index 3b6b2ef4f8d..c51c154cab3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md index 0954839a216..48b0d09adaf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md index 32b78b90e22..291d04898bf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/two_local.py "view source code") +`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md index 7ea4550a455..7038809dfd5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md index f59425e86a1..ed45c96931d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u2.py "view source code") +`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md index a72194fa5e4..b7ea99186f3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.md index 1c6e39b1b8b..3cb922305a1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCGate -`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/uc.py "view source code") +`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/uc.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.md index 880e153cd42..ffd9ba559ba 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate -`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") +`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.md index 5e6ae27f4f0..44a56a8af30 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRXGate -`qiskit.circuit.library.UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") +`qiskit.circuit.library.UCRXGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.md index c38f6d98457..945e109e9a2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRYGate -`qiskit.circuit.library.UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/ucry.py "view source code") +`qiskit.circuit.library.UCRYGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/ucry.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.md index 6e9bcb48169..295c879acf0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRZGate -`qiskit.circuit.library.UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") +`qiskit.circuit.library.UCRZGate(angle_list)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md index 6ed31a08cc3..b3fae7cc05d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md index e9b81cd47d6..b9408e04f36 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate -`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/unitary.py "view source code") +`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/generalized_gates/unitary.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md index c0429fdc2f0..35d52383032 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap -`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/overlap.py "view source code") +`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/overlap.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md index 74a9b4741e9..19623e991c6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `Adder` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md index 5160608fb71..628e857d255 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `BlueprintCircuit` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md index 28591b49868..a7a914245ff 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md index 3586d8c26ea..b7c74c3c930 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md index 33602131635..59ace51a1b9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md index fabe5a522f7..6c7a1ae2fe0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md index cb5cf9cc3d6..f01ea7384cd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md index b42b33b9d21..cf2f2abf472 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md index aa7f2a36f23..8fa963fcd1d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md index ab91486a6b4..d27d4013711 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.md index 72c99fa92db..e4c98d0c3bd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.md index 3f75d46ba49..d0675209eb0 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`qiskit.dagcircuit.DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagcircuit.py "view source code") +`qiskit.dagcircuit.DAGCircuit` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.md index fd873a38928..f69ca31c872 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagdepnode.py "view source code") +`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.md index 45bf6e684ec..b22061ba86b 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`qiskit.dagcircuit.DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagdependency.py "view source code") +`qiskit.dagcircuit.DAGDependency` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagdependency.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.md index 82d9e2d341f..0930584aad6 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`qiskit.dagcircuit.DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGInNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.md index b1ac3f19330..b950389cf5c 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`qiskit.dagcircuit.DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGNode(nid=-1)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.md index cc3ba69fd78..6f1e7ac9195 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.md index df9a8d2fe83..9c2523e234e 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`qiskit.dagcircuit.DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOutNode(wire)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md index 285388ec928..5c4e6aca383 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BaseController -`qiskit.passmanager.BaseController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.BaseController(options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.md b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.md index 7fa64810010..ab7e5bee886 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BasePassManager -`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/passmanager.py "view source code") +`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/passmanager.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md index 671a4435499..4e48b6735fd 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.ConditionalController -`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md index 6502473539e..e0222825968 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.DoWhileController -`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md index f14ce15f88d..dfa4954f1a9 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear -`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/flow_controllers.py "view source code") Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md index d6e8fa0c447..fefa8a91c57 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.GenericPass -`qiskit.passmanager.GenericPass`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.GenericPass` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/base_tasks.py "view source code") Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.md b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.md index a8d0b36afa6..555b15c0b77 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PassManagerState -`qiskit.passmanager.PassManagerState(workflow_status, property_set)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PassManagerState(workflow_status, property_set)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md index ed26e3a3a33..4ddcfe72ddf 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PropertySet -`qiskit.passmanager.PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PropertySet` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/compilation_status.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.md b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.md index f534e271a02..05cf4f7d227 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus -`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/passmanager/compilation_status.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md index 25b3e16b942..516355ba41f 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/backend_estimator.py "view source code") +`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/backend_estimator.py "view source code") Bases: `BaseEstimatorV1`\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md index c2c1253eb55..aa6c9184a3a 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/backend_sampler.py "view source code") +`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/backend_sampler.py "view source code") Bases: `BaseSamplerV1`\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md index a9199a237bf..d02ed08e5d5 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 -`qiskit.primitives.BaseEstimatorV2`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimatorV2` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/base_estimator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.md b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.md index ef363f22819..5c28cd67aa8 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.md +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 -`qiskit.primitives.BaseSamplerV2`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSamplerV2` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/base_sampler.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.primitives.Estimator.md b/docs/api/qiskit/dev/qiskit.primitives.Estimator.md index d2faf289adb..06f43ac9ea5 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/dev/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`qiskit.primitives.Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/estimator.py "view source code") +`qiskit.primitives.Estimator(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/estimator.py "view source code") Bases: `BaseEstimatorV1`\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.md index 4d4c8893254..5dd204cee11 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/dev/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`qiskit.primitives.EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/estimator_result.py "view source code") +`qiskit.primitives.EstimatorResult(values, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/estimator_result.py "view source code") Bases: `_BasePrimitiveResult` diff --git a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md index 32f17758ce8..f50a7cf6982 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md +++ b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.PrimitiveResult -`qiskit.primitives.PrimitiveResult(pub_results, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/containers/primitive_result.py "view source code") +`qiskit.primitives.PrimitiveResult(pub_results, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/containers/primitive_result.py "view source code") Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/dev/qiskit.primitives.PubResult.md b/docs/api/qiskit/dev/qiskit.primitives.PubResult.md index a543fbb972b..ea3774d021e 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.PubResult.md +++ b/docs/api/qiskit/dev/qiskit.primitives.PubResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.PubResult -`qiskit.primitives.PubResult(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/containers/pub_result.py "view source code") +`qiskit.primitives.PubResult(data, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/containers/pub_result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.primitives.Sampler.md b/docs/api/qiskit/dev/qiskit.primitives.Sampler.md index 518a1fbb02d..09b07a2c446 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/dev/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`qiskit.primitives.Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/sampler.py "view source code") +`qiskit.primitives.Sampler(*, options=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/sampler.py "view source code") Bases: `BaseSamplerV1`\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md index c759ae9f23c..caf72a8e2ce 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`qiskit.primitives.SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/sampler_result.py "view source code") +`qiskit.primitives.SamplerResult(quasi_dists, metadata)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/base/sampler_result.py "view source code") Bases: `_BasePrimitiveResult` diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md index cb2f30d60db..31de8946dca 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.StatevectorEstimator -`qiskit.primitives.StatevectorEstimator(*, default_precision=0.0, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/statevector_estimator.py "view source code") +`qiskit.primitives.StatevectorEstimator(*, default_precision=0.0, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/statevector_estimator.py "view source code") Bases: [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.base.base_estimator.BaseEstimatorV2") diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.md b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.md index 20ed51d0735..2e6260dd526 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.md +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.StatevectorSampler -`qiskit.primitives.StatevectorSampler(*, default_shots=1024, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/statevector_sampler.py "view source code") +`qiskit.primitives.StatevectorSampler(*, default_shots=1024, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/primitives/statevector_sampler.py "view source code") Bases: [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.base.base_sampler.BaseSamplerV2") diff --git a/docs/api/qiskit/dev/qiskit.providers.Backend.md b/docs/api/qiskit/dev/qiskit.providers.Backend.md index db363e1ff1b..70c0139ffa2 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Backend.md +++ b/docs/api/qiskit/dev/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`qiskit.providers.Backend`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") +`qiskit.providers.Backend` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV1.md b/docs/api/qiskit/dev/qiskit.providers.BackendV1.md index 59bc0dfaba8..ccf8336ff6b 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`qiskit.providers.BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV1(configuration, provider=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2.md b/docs/api/qiskit/dev/qiskit.providers.BackendV2.md index 1e4630f635e..7e41423df1f 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.md index 74cf875a40d..0443421fbe5 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=True, filter_faulty=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=True, filter_faulty=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend_compat.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/dev/qiskit.providers.Job.md b/docs/api/qiskit/dev/qiskit.providers.Job.md index d3e16236ea8..8833c98faf4 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Job.md +++ b/docs/api/qiskit/dev/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`qiskit.providers.Job`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/job.py "view source code") +`qiskit.providers.Job` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/job.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.JobStatus.md b/docs/api/qiskit/dev/qiskit.providers.JobStatus.md index 0e55569d627..f3a22ba97c6 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/dev/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`qiskit.providers.JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/jobstatus.py "view source code") +`qiskit.providers.JobStatus(value)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/jobstatus.py "view source code") Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.JobV1.md b/docs/api/qiskit/dev/qiskit.providers.JobV1.md index 5241a284634..531d32618de 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`qiskit.providers.JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/job.py "view source code") +`qiskit.providers.JobV1(backend, job_id, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/job.py "view source code") Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.Options.md b/docs/api/qiskit/dev/qiskit.providers.Options.md index 65df1c01cdd..f1fe7672add 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Options.md +++ b/docs/api/qiskit/dev/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`qiskit.providers.Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/options.py "view source code") +`qiskit.providers.Options(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/options.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.Provider.md b/docs/api/qiskit/dev/qiskit.providers.Provider.md index 36ac6917787..e0f5db7432f 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Provider.md +++ b/docs/api/qiskit/dev/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`qiskit.providers.Provider`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/provider.py "view source code") +`qiskit.providers.Provider` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/provider.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.ProviderV1.md b/docs/api/qiskit/dev/qiskit.providers.ProviderV1.md index 62f4150e1e2..744818ee135 100644 --- a/docs/api/qiskit/dev/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`qiskit.providers.ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/provider.py "view source code") +`qiskit.providers.ProviderV1` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/provider.py "view source code") Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.QubitProperties.md b/docs/api/qiskit/dev/qiskit.providers.QubitProperties.md index 39c1b15f650..11d08a08861 100644 --- a/docs/api/qiskit/dev/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/dev/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") +`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.md b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.md index 61b6f0fe0da..af42553fda0 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.md +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider -`qiskit.providers.basic_provider.BasicProvider`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/basic_provider.py "view source code") +`qiskit.providers.basic_provider.BasicProvider` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/basic_provider.py "view source code") Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.md b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.md index 4c0835033fb..c01866a0cf8 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.md +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError -`qiskit.providers.basic_provider.BasicProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/exceptions.py "view source code") +`qiskit.providers.basic_provider.BasicProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/exceptions.py "view source code") Base class for errors raised by the Basic Provider. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.md b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.md index 9262d483c20..194c2d63fdd 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.md +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob -`qiskit.providers.basic_provider.BasicProviderJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/basic_provider_job.py "view source code") +`qiskit.providers.basic_provider.BasicProviderJob(backend, job_id, result)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/basic_provider_job.py "view source code") Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md index 87bf63e125f..ae15d3f732e 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator -`qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/basic_simulator.py "view source code") +`qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/basic_provider/basic_simulator.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/dev/qiskit.providers.convert_to_target.md b/docs/api/qiskit/dev/qiskit.providers.convert_to_target.md index 89a78c0219b..37ec68cb7e8 100644 --- a/docs/api/qiskit/dev/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/dev/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=True, filter_faulty=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=True, filter_faulty=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/backend_compat.py "view source code") Decode transpiler target from backend data set. diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md index 15eabfdd54a..43eabe4e129 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake127QPulseV1 -`qiskit.providers.fake_provider.Fake127QPulseV1`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/fake_127q_pulse_v1.py "view source code") +`qiskit.providers.fake_provider.Fake127QPulseV1` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/fake_127q_pulse_v1.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.md index 9f7c2672cd6..25914b8ed46 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`qiskit.providers.fake_provider.Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_1q.py "view source code") +`qiskit.providers.fake_provider.Fake1Q` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md index d93a10104bc..a2567866ccc 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake20QV1 -`qiskit.providers.fake_provider.Fake20QV1`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_20q/fake_20q.py "view source code") +`qiskit.providers.fake_provider.Fake20QV1` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_20q/fake_20q.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md index 4be8d74d812..ed22bd93b20 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake27QPulseV1 -`qiskit.providers.fake_provider.Fake27QPulseV1`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/fake_27q_pulse_v1.py "view source code") +`qiskit.providers.fake_provider.Fake27QPulseV1` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/fake_27q_pulse_v1.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md index 0eda3efbb5d..5204eb91761 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake5QV1 -`qiskit.providers.fake_provider.Fake5QV1`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_5q/fake_5q_v1.py "view source code") +`qiskit.providers.fake_provider.Fake5QV1` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_5q/fake_5q_v1.py "view source code") Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md index 5b53f64f82a..9ff9c859cb2 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake7QPulseV1 -`qiskit.providers.fake_provider.Fake7QPulseV1`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/fake_7q_pulse_v1.py "view source code") +`qiskit.providers.fake_provider.Fake7QPulseV1` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/fake_7q_pulse_v1.py "view source code") Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 71cb902d374..24a526bb91d 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`qiskit.providers.fake_provider.FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse2Q` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index bb58320f345..545bd8c3378 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`qiskit.providers.fake_provider.FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse3Q` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md index 3551f8fd189..6c7db7b4529 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 -`qiskit.providers.fake_provider.GenericBackendV2(num_qubits, basis_gates=None, *, coupling_map=None, control_flow=False, calibrate_instructions=None, dtm=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/generic_backend_v2.py "view source code") +`qiskit.providers.fake_provider.GenericBackendV2(num_qubits, basis_gates=None, *, coupling_map=None, control_flow=False, calibrate_instructions=None, dtm=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/fake_provider/generic_backend_v2.py "view source code") Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.md index 39712dc2ea0..d3713bf44fb 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.md index 3c032e3620c..7be1f4c22ee 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.md index 5675261b8fe..99a7fe5f24a 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendstatus.py "view source code") +`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.Command.md b/docs/api/qiskit/dev/qiskit.providers.models.Command.md index 5ca71c6342e..023cdc475c5 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.md index 87d01e2fa18..b4f90da0f12 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.md b/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.md index 2e010451ff0..6d9b93dc41d 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.GateProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateProperties -`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.md index cbd08c93d1d..e2f7f840439 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/jobstatus.py "view source code") +`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/jobstatus.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.Nduv.md b/docs/api/qiskit/dev/qiskit.providers.models.Nduv.md index acdd74378f0..30cb60683d7 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.Nduv.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.Nduv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Nduv -`qiskit.providers.models.Nduv(date, name, unit, value)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.Nduv(date, name, unit, value)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendproperties.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.md index 67ce58adbd3..ad3060ed1eb 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.md index ec8dd54c67c..b5fb1bcbd08 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/pulsedefaults.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.md index 2825948ea57..21103944d48 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.md index 374ca58ce20..49b9636e5a9 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/dev/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`qiskit.providers.models.UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.UchannelLO(q, scale)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.md index b550f163c4f..b12078a96e9 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`qiskit.pulse.InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instruction_schedule_map.py "view source code") +`qiskit.pulse.InstructionScheduleMap` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.Schedule.md b/docs/api/qiskit/dev/qiskit.pulse.Schedule.md index a88d9f0c722..1ade5c2680c 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/dev/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md index fa7d7b81698..83b35380398 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/schedule.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.md index 5448fdc80a3..87ba717012f 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.md index 108ee3a8684..0bc72491a94 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`qiskit.pulse.channels.ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.ControlChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.md index c7a0859d447..af33e2b7ea7 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`qiskit.pulse.channels.DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.DriveChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.md index a3cd34caae3..c5cd67ebefd 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: `PulseChannel` diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.md index 78ee2ebeb53..7cb3b0f3b6a 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`qiskit.pulse.channels.MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MemorySlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.md index df71644e1e9..1b8a868e099 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.md index d1b4bc8532e..ae4680c1eb3 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/dev/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/channels.py "view source code") Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.md index 29ac6396806..3ac33151dd5 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/acquire.py "view source code") +`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.md index 32eb2dd47c3..6db1f87b934 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`qiskit.pulse.instructions.Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/delay.py "view source code") +`qiskit.pulse.instructions.Delay(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/delay.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.md index 90a35900567..d4040591874 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`qiskit.pulse.instructions.Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/play.py "view source code") +`qiskit.pulse.instructions.Play(pulse, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/play.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.md index 97bfce29254..bd45e4deb25 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`qiskit.pulse.instructions.Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/reference.py "view source code") +`qiskit.pulse.instructions.Reference(name, *extra_keys)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/reference.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.md index dcfc47dbe35..a4e88a5ba26 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.md index 658b83fbbf1..fe08a423fdd 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.md index 75e562ae499..fcc749e5536 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.md index 9f86e460e7c..a4c3a19ac80 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.md index e21e50dcc66..d6c3e7c8efe 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/phase.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.md index 4e625ffb90c..4d1afc8eee0 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/snapshot.py "view source code") +`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.md index ddc28fcff28..8cfeee1b23a 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/instructions/directives.py "view source code") Bases: `Directive` diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.md index eca6d19355c..9df9e85fcf5 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`qiskit.pulse.library.Constant(duration, amp, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Constant(duration, amp, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Cos_class.rst.md index cbe05b1dd93..105824142e6 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") A cosine pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.md index a0da4fd4d3a..198d9840b2e 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.md b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.md index f9ed5090bd1..3b770c0cb32 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv -`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized Gaussian derivative pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.md index 85173600bf4..38a0c52cc47 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.md index f8f605da444..bd9d0ee56f2 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.md index 4afb32f1203..6b527c7e8ed 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Gaussian -`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth_class.rst.md index f137642b094..8283096932a 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") A sawtooth pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.md b/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.md index 0309559678f..4a6bc7c02fb 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.SechDeriv -`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech derivative pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Sech_fun.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Sech_fun.rst.md index e6a4793994b..69863b2651a 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Sech_fun.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Sech_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sech -`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") An unnormalized sech pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Sin_class.rst.md index e41ec397223..5a7fe564ace 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") A sinusoidal pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Square_fun.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Square_fun.rst.md index 84c2ac612c8..28624fea920 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Square_fun.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Square_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Square -`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") A square wave pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.md index 57c81c46338..1fe79147ecb 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/dev/qiskit.pulse.library.Triangle_class.rst.md index 9a64a6e44cd..c3d68c004a8 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") A triangle wave pulse. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.md index 8d23183a834..bb827520e0a 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/waveform.py "view source code") +`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/waveform.py "view source code") Bases: `Pulse` diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.md b/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.md index 5910fc4ba3a..c080d598ae7 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.md +++ b/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo -`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/library/symbolic_pulses.py "view source code") An echoed Gaussian square pulse with an active tone overlaid on it. diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.md index 951e5365198..3114d4bb560 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`qiskit.pulse.transforms.AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignEquispaced(duration)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.md index fec0e9b96d0..f34094c9cbc 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`qiskit.pulse.transforms.AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignFunc(duration, func)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.md index c5fbe14ff1d..6817224a73e 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`qiskit.pulse.transforms.AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignLeft` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.md index 4798cc1b720..6d73adddee3 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`qiskit.pulse.transforms.AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignRight` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.md index 9a741e4389e..6bff86ff2f2 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`qiskit.pulse.transforms.AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignSequential` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.md index adcf6ad291a..bf186a676de 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/dev/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`qiskit.qobj.GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.GateCalibration(name, qubits, params, instructions)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.md index 9d145495310..f4cd1b78654 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`qiskit.qobj.PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseLibraryItem(name, samples)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.md index f4c9ef8d73d..74e7f7105af 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.md index b9054098f54..f9470365151 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.md index 9ff45c6f67c..e39a56a817a 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.md index 3bbfd822f66..d207bed833b 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.md index 32af7ed6f97..afdddf4ee87 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/dev/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.md index 40efb7f9d2f..1aa1d8b94ad 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`qiskit.qobj.QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmExperimentCalibrations(gates)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.md index 91c7e1c897a..f9acf053f93 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.md index c713b6a018b..5149dee4754 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.md index 750ae020bc9..37c34020f20 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.md index 53785139ca4..3a05c4c3764 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.md index 11cc5fc2004..54efefc2893 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/qasm_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.md index c1f1a3e4ca5..84c7ea433e4 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`qiskit.qobj.QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjExperimentHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/common.py "view source code") Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.md index 66fdc25b902..a54ce01c97e 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`qiskit.qobj.QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjHeader(**kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/common.py "view source code") Bases: `QobjDictField` diff --git a/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.md index e3dd1880d9b..a67d559e232 100644 --- a/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/dev/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`qiskit.qobj.QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.QobjMeasurementOption(name, params=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qobj/pulse_qobj.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.md index 2879c580971..047a444c311 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.md b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.md index 5873e052ae0..3dee95fffbe 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/chi.py "view source code") +`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.md b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.md index b451ee94e0d..59a535b26c0 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/choi.py "view source code") +`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.md index 59ae0f5fffe..d17a67618ab 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`qiskit.quantum_info.Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`qiskit.quantum_info.Clifford(data, validate=True, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.md index ccd6b3f2cd9..9a62d560aeb 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`qiskit.quantum_info.DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/densitymatrix.py "view source code") +`qiskit.quantum_info.DensityMatrix(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.md index b8a7e8fd032..dfc4e4746a7 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.md b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.md index 367e5bb9ff3..7ca08501361 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/operator.py "view source code") +`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/operator.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.md b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.md index 36282e7dd8f..1af7d1a6642 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.md index 69b666d2ace..5b3ced37da5 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`qiskit.quantum_info.Pauli(data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`qiskit.quantum_info.Pauli(data=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `BasePauli` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.md index 10b9d6ee988..c3bc55932d6 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`qiskit.quantum_info.PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`qiskit.quantum_info.PauliList(data)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `BasePauli`, `LinearMixin`, `GroupMixin` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.md index 594cf260e76..a534518fd99 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`qiskit.quantum_info.Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/quaternion.py "view source code") +`qiskit.quantum_info.Quaternion(data)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/quaternion.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.md index 71fecf8e848..4b62841690c 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/scalar_op.py "view source code") +`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.md index e70010484dd..9c6cb52bd8e 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `LinearOp` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.md index a303087cd6e..e89e618b48d 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`qiskit.quantum_info.StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`qiskit.quantum_info.StabilizerState(data, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `QuantumState` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.md index aa2635c9ca8..5ea15238e81 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`qiskit.quantum_info.Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/statevector.py "view source code") +`qiskit.quantum_info.Statevector(data, dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/statevector.py "view source code") Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.md index ea888f2be1b..dafbf5ac40a 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.md index f029ea9dadc..77c44871ab4 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/superop.py "view source code") +`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `QuantumChannel` diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md index 83dc9a5e679..ee22360c2ea 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/dev/qiskit.quantum_info.pauli_basis.md index e1415994f71..3e2a632f19f 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.md index 9b13d5d5491..c8ddb56d377 100644 --- a/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/dev/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`qiskit.result.BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`qiskit.result.BaseReadoutMitigator` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.md index 11296131744..ff63bcd6dd0 100644 --- a/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/dev/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/dev/qiskit.result.Counts.md b/docs/api/qiskit/dev/qiskit.result.Counts.md index 6594920a8f4..aede5de5bf6 100644 --- a/docs/api/qiskit/dev/qiskit.result.Counts.md +++ b/docs/api/qiskit/dev/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/counts.py "view source code") +`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/counts.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.md index cf81965bbe1..bdc2db86aa7 100644 --- a/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/dev/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md index 62ec0dd847c..4c4af8b5363 100644 --- a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`qiskit.result.ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/distributions/probability.py "view source code") +`qiskit.result.ProbDistribution(data, shots=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/distributions/probability.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md index 25eb4693fca..c50b7b74646 100644 --- a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/distributions/quasi.py "view source code") +`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/distributions/quasi.py "view source code") Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.result.Result.md b/docs/api/qiskit/dev/qiskit.result.Result.md index 7eff1354388..286a16193f4 100644 --- a/docs/api/qiskit/dev/qiskit.result.Result.md +++ b/docs/api/qiskit/dev/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/result.py "view source code") +`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/result.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.result.ResultError.md b/docs/api/qiskit/dev/qiskit.result.ResultError.md index c0a5895f7ae..da0fd468eaa 100644 --- a/docs/api/qiskit/dev/qiskit.result.ResultError.md +++ b/docs/api/qiskit/dev/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`qiskit.result.ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/exceptions.py "view source code") +`qiskit.result.ResultError(error)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.md index 5bdfaf92294..52460239b41 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`qiskit.synthesis.EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`qiskit.synthesis.EvolutionSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.md index 38a70102e52..8d6226f0637 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.md index efcfa0d5bf4..4765b91cb88 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`qiskit.synthesis.MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`qiskit.synthesis.MatrixExponential` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.md b/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.md index 2b4ff60b518..fad095d4425 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer -`qiskit.synthesis.OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/one_qubit/one_qubit_decompose.py "view source code") +`qiskit.synthesis.OneQubitEulerDecomposer(basis='U3', use_dag=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/one_qubit/one_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.md index 7c1c78b8ae8..4f3beadf2d7 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/product_formula.py "view source code") +`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.QDrift.md b/docs/api/qiskit/dev/qiskit.synthesis.QDrift.md index 025b7222434..2ddfcaf352f 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/qdrift.py "view source code") +`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.md index bc546ee1272..c7296d4f6f4 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.md index fc83e15bb25..c4918cee79e 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md index c2e4ac1f638..8466d3cb629 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer -`qiskit.synthesis.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") +`qiskit.synthesis.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md index cb967ded672..a70b5b501a2 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.TwoQubitWeylDecomposition -`qiskit.synthesis.TwoQubitWeylDecomposition(unitary_matrix, *, fidelity=0.999999999, _unpickling=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") +`qiskit.synthesis.TwoQubitWeylDecomposition(unitary_matrix, *, fidelity=0.999999999, _unpickling=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/two_qubit/two_qubit_decompose.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.md b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.md index 30640855ea1..97c37c875a0 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.XXDecomposer -`qiskit.synthesis.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/two_qubit/xx_decompose/decomposer.py "view source code") +`qiskit.synthesis.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/two_qubit/xx_decompose/decomposer.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.md index 03bdeaa67fa..b234b9f7751 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC -`qiskit.synthesis.unitary.aqc.AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/aqc.py "view source code") +`qiskit.synthesis.unitary.aqc.AQC(optimizer=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/aqc.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md index 23636a5e610..f71fb165453 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit -`qiskit.synthesis.unitary.aqc.ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/approximate.py "view source code") +`qiskit.synthesis.unitary.aqc.ApproximateCircuit(num_qubits, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/approximate.py "view source code") Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md index bb7a1ce3091..b923e6f93e7 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective -`qiskit.synthesis.unitary.aqc.ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/approximate.py "view source code") +`qiskit.synthesis.unitary.aqc.ApproximatingObjective` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/approximate.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md index 6a2abc6287d..cc7103afa42 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit -`qiskit.synthesis.unitary.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py "view source code") +`qiskit.synthesis.unitary.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py "view source code") Bases: [`ApproximateCircuit`](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.approximate.ApproximateCircuit") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md index 41109a34076..5159c818782 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitObjective -`qiskit.synthesis.unitary.aqc.CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") +`qiskit.synthesis.unitary.aqc.CNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md index 168b0d36749..17be35d86b5 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective -`qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") +`qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_unit_objective.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md index 23e78a14686..34990cf5b82 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective -`qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py "view source code") +`qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective(num_qubits, cnots)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`CNOTUnitObjective`](qiskit.synthesis.unitary.aqc.CNOTUnitObjective "qiskit.synthesis.unitary.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md index e7d97758ce0..b84b8f397b7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`qiskit.transpiler.AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.AnalysisPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.md index df7c2603470..f06ef2afd40 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/coupling.py "view source code") +`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/coupling.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.md index 64d1e283a9c..bd48f8e277e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/instruction_durations.py "view source code") +`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/instruction_durations.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.md index c2f5180f177..d5e33473c7c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/target.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Layout.md b/docs/api/qiskit/dev/qiskit.transpiler.Layout.md index 35578f8a5b6..f7c8ff50b25 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`qiskit.transpiler.Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.Layout(input_dict=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.md b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.md index c0239022534..25484dfe0bb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passmanager.py "view source code") Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.md index cb6759a2946..20dde189f5c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passmanager_config.py "view source code") +`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passmanager_config.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.md index aa9dfa2c773..80ea9218bb4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.StagedPassManager -`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passmanager.py "view source code") Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Target.md b/docs/api/qiskit/dev/qiskit.transpiler.Target.md index c0d28eb81b6..e88f3930aa9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/target.py "view source code") Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md index 6d6ad890aae..c50cbe624e0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`qiskit.transpiler.TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.TransformationPass(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/basepasses.py "view source code") Bases: `BasePass` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.md index f8b10eb78ec..300e8a23619 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/layout.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md index 9f27817f34f..72db4cd0235 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index f4556683cff..9efe9317ff2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.AQCSynthesisPlugin.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.AQCSynthesisPlugin.md index 9c3b753a78a..b545fa8b230 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AQCSynthesisPlugin -`qiskit.transpiler.passes.AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/aqc_plugin.py "view source code") +`qiskit.transpiler.passes.AQCSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/aqc_plugin.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md index bd8349267fb..1ec59a6d292 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 8036595fd00..75b03797ec5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `BaseScheduler` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md index 83a0e2919eb..a6b99d95823 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md index 94c8c4927e0..fc2df8f6b31 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 80631c6e038..b47ed41298a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md index a850c9fc604..618b57744a8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md index dc70d02e358..d3ecde45988 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md index dd298a98642..49ba45618c6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md index b375a4ba74b..3d82ca1fda2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md index b8b129d8bd0..7cbfe4a3e87 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md index d277e1f9f88..6323faf6082 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`qiskit.transpiler.passes.CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/check_map.py "view source code") +`qiskit.transpiler.passes.CheckMap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md index 6d559844d36..9dbb2fbc334 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md index 1af63525e31..a4f03add3f7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md index 2a99c6fb004..25442fce31c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md index b71e6f95360..fda6979683a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md index 39870e8353e..c2de260936d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md index 63e6fc36abd..bc8d728d020 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md index 9bb013f3756..8eb74a3d8e5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 282c8136d59..7e62e88a557 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md index c9ac7b41ba1..f6b020b9a94 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md index 95534b80353..63b74d89568 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md index 340ac43d60e..2df6a738c71 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md index a82b430e853..aa5bff09dd1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 0014defc8fb..11ed446f635 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md index 4f4606cace6..efd34205464 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`qiskit.transpiler.passes.CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`qiskit.transpiler.passes.CountOps(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md index 95d4ff8033c..9115a746159 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md index 911a8b9e5ae..33fa7ed4890 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md index ab0df88c034..a13b10e6a48 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md index bdeac877b71..65f68d7f173 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`qiskit.transpiler.passes.Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/decompose.py "view source code") +`qiskit.transpiler.passes.Decompose(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md index 698cebf00a6..da20caff651 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md index 13a1f7d6c69..5d216bdde83 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`qiskit.transpiler.passes.Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/depth.py "view source code") +`qiskit.transpiler.passes.Depth(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md index bd259dfbe0b..3ddbd3bfb86 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 67ff7249065..b341c45f05c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md index d967540ee8f..c7d08f59b25 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md index db73096e926..a50c45dde6b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes -`qiskit.transpiler.passes.FilterOpNodes(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/filter_op_nodes.py "view source code") +`qiskit.transpiler.passes.FilterOpNodes(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/filter_op_nodes.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md index c016f8fb4a9..8a72d8d9391 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md index 5d833ff927c..2317d2ffe55 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md index 09fde6f97a8..01a4cc779ae 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`qiskit.transpiler.passes.GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`qiskit.transpiler.passes.GateDirection(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md index 5dbc2178728..90e102e9a8a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.md index 5ba64938749..0dcd1371446 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HLSConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HLSConfig -`qiskit.transpiler.passes.HLSConfig(use_default_on_unspecified=True, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HLSConfig(use_default_on_unspecified=True, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md index 3c61166b2a2..350aee43c3e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md index d08164c7f41..8e1c9a947f3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md index 59ca37c8f34..f77880004eb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md index db3a2142738..735573f9329 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md index 97dd335931f..f2246105927 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 5ffa0e58095..05e4844ac70 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md index 6a1f2ee471b..86c11d7423f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 7256e211cd8..5d82409ed8f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md index ea4e553496a..b30bcec1e8d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/minimum_point.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md index f700e691bc0..b3eb2fff86c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle -`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") +`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md index 2280188a8c4..cc51cd7c69a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md index e8526033cfd..86e2c65ead9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 8a777f31651..053243ac041 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 05e4ade1201..4df7dc82c7f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md index ef88a590f0f..54dac4db27c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated -`qiskit.transpiler.passes.OptimizeAnnotated(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_annotated.py "view source code") +`qiskit.transpiler.passes.OptimizeAnnotated(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_annotated.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md index f6f34ece643..088e4869613 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md index e70b5d25d4b..efd29a84782 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`qiskit.transpiler.passes.PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`qiskit.transpiler.passes.PadDelay(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md index f8de24e71a7..fcf91e353b9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `BasePadding` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md index af79804df7f..bd3935a6475 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`qiskit.transpiler.passes.PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`qiskit.transpiler.passes.PulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md index 4ac79f69c02..6eb77722560 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder -`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") +`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md index fa0856b470a..0626fb2ad4d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 075ab6de1ef..2942bdd1236 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md index 2b793ae25ac..dafe81dac1e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 86657828c0a..f146c4e3ed2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 50fbacf72c8..203966ef442 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md index d3c9bfa924f..4daee628147 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 4451a235ebd..45c7f27d56e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md index 3eaac81e306..f7f48008077 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md index 8ee541f55dd..4d2ef8b03c3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout -`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") +`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md index 9bd0f00d046..4a0146d486c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md index 9dccfd324f1..c474b0ac1dd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md index cb0e3522425..0496a894be8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`qiskit.transpiler.passes.SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`qiskit.transpiler.passes.SetLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md index 6184d4651ef..7259d217342 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`qiskit.transpiler.passes.Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/size.py "view source code") +`qiskit.transpiler.passes.Size(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md index c9e4d0e0199..717f5e02933 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index 7c3bbbb5366..6f8f8ff87f7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`qiskit.transpiler.passes.SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaevSynthesis` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md index 2265c10c5b9..00f34b9f03a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md index 1f63f43eecb..bb7bfa601a0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md index 70bf9dd6f05..3afba9d78c2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md index 72bff72dd15..6e92829968e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md index 89a308bd387..32b7677eafe 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md index 630c29b9633..612bef49dc5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md index a0e2ff4d78e..22cc951aa49 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 9785dd7e699..fba1cbd0411 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md index 76900293cb3..d0b9d803aa9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md index 6307de9cf32..339e866db09 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md index 3e754898f1b..2eda327bd0b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md index 47471e0b8f2..fd693bff3b7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md index 4084d80f821..00b96e4eee2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`qiskit.transpiler.passes.Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/width.py "view source code") +`qiskit.transpiler.passes.Width(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 17d473802e7..f826381c447 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index 483fc7c3891..26700856286 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index 3c703f05aa5..81ce372f688 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index 9dae1e023e0..0582e3ed2a5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md index 966c136048b..526aa7a5065 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_ -`qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names(op_name)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of plugin names installed for a given high level object name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index fa5de650272..9471cabe742 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index d3f3329f872..384a11fbea5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index 52fbf97c229..cddcf7318aa 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/dev/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/dev/qiskit.visualization.array_to_latex.md index 7ffb6caf977..f7a537cd441 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/dev/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/array.py "view source code") +`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/dev/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/dev/qiskit.visualization.circuit_drawer.md index cf64fb0393d..c7d005d6635 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/dev/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/dev/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/dev/qiskit.visualization.dag_drawer.md index a3e5c0bf8d2..788b975aa36 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/dev/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/dag_visualization.py "view source code") +`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.md index 048ec80726a..12bbebc557d 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/pass_manager_visualization.py "view source code") +`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.md index c770fc92377..ede4b4601c7 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.md index 14cf75aad43..5e29daad7eb 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/dev/qiskit.visualization.plot_circuit_layout.md index ed63cd2048b..f3461900902 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/dev/qiskit.visualization.plot_coupling_map.md index 82c7a17ad60..56b8fa8b329 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.md index 370b4c05e33..f7777840773 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/dev/qiskit.visualization.plot_error_map.md index f8a29ae578d..127f085e8fa 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/dev/qiskit.visualization.plot_gate_map.md index 1760cff2353..8b8fb8e0ecc 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.md index 602f4d4ab8a..1a43886c81a 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.md index 7d121c007a4..f03c96580ef 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.md index e9063cb06fd..7f161eedb34 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.md index a617ddeb85f..141414b6d09 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") Plot the Pauli-vector representation of a quantum state as bar graph. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.md index 54ae1f85c67..d08033441cd 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/dev/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/dev/qiskit.visualization.visualize_transition.md index 2abe24407e5..f5cae66f896 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/dev/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/transition_visualization.py "view source code") +`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/dev/qpy.md b/docs/api/qiskit/dev/qpy.md index 8a19f11425a..c955963fb20 100644 --- a/docs/api/qiskit/dev/qpy.md +++ b/docs/api/qiskit/dev/qpy.md @@ -59,7 +59,7 @@ and then loading that file will return a list with all the circuits -`qiskit.qpy.load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.load(file_obj, metadata_deserializer=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/interface.py "view source code") Load a QPY binary file @@ -106,7 +106,7 @@ The list of Qiskit programs contained in the QPY data. A list is always returned -`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=True, version=11)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=True, version=11)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file @@ -172,7 +172,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski -`qiskit.qpy.QpyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QpyError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/exceptions.py "view source code") Errors raised by the qpy module. @@ -210,7 +210,7 @@ If a feature being loaded is deprecated in the corresponding qiskit release, QPY -`qiskit.qpy.QPYLoadingDeprecatedFeatureWarning`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QPYLoadingDeprecatedFeatureWarning` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/qpy/exceptions.py "view source code") Visible deprecation warning for QPY loading functions without a stable point in the call stack. diff --git a/docs/api/qiskit/dev/quantum_info.md b/docs/api/qiskit/dev/quantum_info.md index a169080911b..f340df47045 100644 --- a/docs/api/qiskit/dev/quantum_info.md +++ b/docs/api/qiskit/dev/quantum_info.md @@ -60,7 +60,7 @@ python_api_name: qiskit.quantum_info -`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. @@ -102,7 +102,7 @@ The average gate fidelity $F_{\text{ave}}$. -`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. @@ -151,7 +151,7 @@ The process fidelity $F_{\text{pro}}$. -`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. @@ -188,7 +188,7 @@ The average gate error $E$. -`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. @@ -228,7 +228,7 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar -`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. @@ -264,7 +264,7 @@ The state fidelity $F(\rho_1, \rho_2)$. -`qiskit.quantum_info.purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.purity(state, validate=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. @@ -295,7 +295,7 @@ the purity $Tr[\rho^2]$. -`qiskit.quantum_info.concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.concurrence(state)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. @@ -337,7 +337,7 @@ The concurrence. -`qiskit.quantum_info.entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entropy(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. @@ -368,7 +368,7 @@ The von-Neumann entropy S(rho). -`qiskit.quantum_info.entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entanglement_of_formation(state)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. @@ -396,7 +396,7 @@ The entanglement of formation. -`qiskit.quantum_info.mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.mutual_information(state, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. @@ -436,7 +436,7 @@ The mutual information $I(\rho_{AB})$. -`qiskit.quantum_info.partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.partial_trace(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. @@ -463,7 +463,7 @@ The reduced density matrix. -`qiskit.quantum_info.schmidt_decomposition(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.schmidt_decomposition(state, qargs)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/utils.py "view source code") Return the Schmidt Decomposition of a pure quantum state. @@ -513,7 +513,7 @@ list of tuples `(s, u, v)`, where `s` (float) are the Schmidt coefficients $\lam -`qiskit.quantum_info.shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.shannon_entropy(pvec, base=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. @@ -542,7 +542,7 @@ The Shannon entropy H(pvec). -`qiskit.quantum_info.commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`qiskit.quantum_info.commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/utils/commutator.py "view source code") Compute commutator of a and b. @@ -567,7 +567,7 @@ The commutator -`qiskit.quantum_info.anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`qiskit.quantum_info.anti_commutator(a, b)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") Compute anti-commutator of a and b. @@ -592,7 +592,7 @@ The anti-commutator -`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") Compute symmetric double commutator of a, b and c. @@ -641,7 +641,7 @@ Methods of Molecular Quantum Mechanics. 2nd Edition, Academic Press, 1992. ISBN -`qiskit.quantum_info.random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_statevector(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. @@ -668,7 +668,7 @@ K. Zyczkowski and H. Sommers (2001), “Induced measures in the space of mixed q -`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. @@ -695,7 +695,7 @@ the random density matrix. -`qiskit.quantum_info.random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_unitary(dims, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. @@ -718,7 +718,7 @@ a unitary operator. -`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. @@ -742,7 +742,7 @@ a Hermitian operator. -`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. @@ -764,7 +764,7 @@ a random Pauli -`qiskit.quantum_info.random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_clifford(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. @@ -791,7 +791,7 @@ a random Clifford operator. -`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. @@ -820,7 +820,7 @@ a quantum channel operator. -`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. @@ -841,7 +841,7 @@ a random CNOTDihedral element. -`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. @@ -866,7 +866,7 @@ a random PauliList. -`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. @@ -891,7 +891,7 @@ Distance -`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/dev/result.md b/docs/api/qiskit/dev/result.md index 2a627522f62..8d1c5eaa70f 100644 --- a/docs/api/qiskit/dev/result.md +++ b/docs/api/qiskit/dev/result.md @@ -28,7 +28,7 @@ python_api_name: qiskit.result -`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -58,7 +58,7 @@ the observed counts, marginalized to only account for frequency of observations -`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. @@ -87,7 +87,7 @@ A marginalized dictionary -`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/utils.py "view source code") Marginalize shot memory @@ -127,7 +127,7 @@ marginal\_memory -`qiskit.result.sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/sampled_expval.py "view source code") +`qiskit.result.sampled_expectation_value(dist, oper)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/dev/scheduler.md b/docs/api/qiskit/dev/scheduler.md index ee27bb2209f..57f734408fc 100644 --- a/docs/api/qiskit/dev/scheduler.md +++ b/docs/api/qiskit/dev/scheduler.md @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. -`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/config.py "view source code") +`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/config.py "view source code") Configuration for pulse scheduling. @@ -38,7 +38,7 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched -`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/schedule_circuit.py "view source code") +`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/schedule_circuit.py "view source code") Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. @@ -74,7 +74,7 @@ Pulse scheduling methods. -`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -98,7 +98,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/scheduler/methods/basic.py "view source code") Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. diff --git a/docs/api/qiskit/dev/synthesis.md b/docs/api/qiskit/dev/synthesis.md index 2ce7e550397..f0db1f34303 100644 --- a/docs/api/qiskit/dev/synthesis.md +++ b/docs/api/qiskit/dev/synthesis.md @@ -37,7 +37,7 @@ python_api_name: qiskit.synthesis -`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear/cnot_synth.py "view source code") +`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear/cnot_synth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. @@ -68,7 +68,7 @@ a CX-only circuit implementing the linear transformation. -`qiskit.synthesis.synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cnot_depth_line_kms(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. @@ -100,7 +100,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cz_depth_line_mr(mat)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. @@ -126,7 +126,7 @@ a circuit implementation of the CZ circuit of depth 2\*n+2 for LNN connectivity. -`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") Joint synthesis of a -CZ-CX- circuit for linear nearest neighbour (LNN) connectivity, with 2-qubit depth at most 5n, based on Maslov and Yang. This method computes the CZ circuit inside the CX circuit via phase gate insertions. @@ -152,7 +152,7 @@ a circuit implementation of a CX circuit following a CZ circuit, denoted as a -C -`qiskit.synthesis.synth_cnot_phase_aam(cnots, angles, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear_phase/cnot_phase_synth.py "view source code") +`qiskit.synthesis.synth_cnot_phase_aam(cnots, angles, section_size=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/linear_phase/cnot_phase_synth.py "view source code") This function is an implementation of the GraySynth algorithm of Amy, Azimadeh and Mosca. @@ -207,7 +207,7 @@ the decomposed quantum circuit. -`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. @@ -229,7 +229,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_basic(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. @@ -251,7 +251,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_acg(pattern)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. @@ -277,7 +277,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`qiskit.synthesis.synth_clifford_full(clifford, method=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. @@ -306,7 +306,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`qiskit.synthesis.synth_clifford_ag(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. @@ -330,7 +330,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`qiskit.synthesis.synth_clifford_bm(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. @@ -358,7 +358,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`qiskit.synthesis.synth_clifford_greedy(clifford)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. @@ -388,7 +388,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov. @@ -435,7 +435,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_depth_lnn(cliff)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers for linear-nearest neighbour connectivity. @@ -465,7 +465,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_full(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. @@ -490,7 +490,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. @@ -518,7 +518,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_general(elem)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. @@ -550,7 +550,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of a stabilizer state into layers. @@ -599,7 +599,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth 2\*n+2 and two distinct CX layers, using CX and phase gates (S, Sdg or Z). @@ -624,7 +624,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_circuit_from_stabilizers(stabilizers, allow_redundant=False, allow_underconstrained=False, invert=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/stabilizer/stabilizer_circuit.py "view source code") +`qiskit.synthesis.synth_circuit_from_stabilizers(stabilizers, allow_redundant=False, allow_underconstrained=False, invert=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/stabilizer/stabilizer_circuit.py "view source code") Synthesis of a circuit that generates a state stabilized by the stabilziers using Gaussian elimination with Clifford gates. If the stabilizers are underconstrained, and allow\_underconstrained is True, the circuit will output one of the states stabilized by the stabilizers. Based on stim implementation. @@ -662,7 +662,7 @@ a circuit that generates a state stabilized by stabilizers. -`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. @@ -690,7 +690,7 @@ List of `GateSequences` using the gates in `basic_gates`. -`qiskit.synthesis.synth_qft_line(num_qubits, do_swaps=True, approximation_degree=0)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/qft/qft_decompose_lnn.py "view source code") +`qiskit.synthesis.synth_qft_line(num_qubits, do_swaps=True, approximation_degree=0)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/qft/qft_decompose_lnn.py "view source code") Synthesis of a QFT circuit for a linear nearest neighbor connectivity. Based on Fig 2.b in Fowler et al. \[1]. @@ -722,7 +722,7 @@ Decomposition of general $2^n \times 2^n$ unitary matrices for any number of qub -`qiskit.synthesis.qs_decomposition(mat, opt_a1=True, opt_a2=True, decomposer_1q=None, decomposer_2q=None, *, _depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/qsd.py "view source code") +`qiskit.synthesis.qs_decomposition(mat, opt_a1=True, opt_a2=True, decomposer_1q=None, decomposer_2q=None, *, _depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/qsd.py "view source code") Decomposes a unitary matrix into one and two qubit gates using Quantum Shannon Decomposition, diff --git a/docs/api/qiskit/dev/synthesis_aqc.md b/docs/api/qiskit/dev/synthesis_aqc.md index 278ff3330ae..80733bc9e87 100644 --- a/docs/api/qiskit/dev/synthesis_aqc.md +++ b/docs/api/qiskit/dev/synthesis_aqc.md @@ -129,7 +129,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.synthesis.unitary.aqc -`qiskit.synthesis.unitary.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_structures.py "view source code") +`qiskit.synthesis.unitary.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/synthesis/unitary/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/dev/transpiler.md b/docs/api/qiskit/dev/transpiler.md index 8882d1aa576..9e48d6150e5 100644 --- a/docs/api/qiskit/dev/transpiler.md +++ b/docs/api/qiskit/dev/transpiler.md @@ -935,7 +935,7 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor -`qiskit.transpiler.TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. @@ -945,7 +945,7 @@ Set the error message. -`qiskit.transpiler.TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerAccessError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. @@ -955,7 +955,7 @@ Set the error message. -`qiskit.transpiler.CouplingError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CouplingError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") Base class for errors raised by the coupling graph object. @@ -965,7 +965,7 @@ Set the error message. -`qiskit.transpiler.LayoutError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.LayoutError(*msg)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") Errors raised by the layout object. @@ -975,7 +975,7 @@ Set the error message. -`qiskit.transpiler.CircuitTooWideForTarget(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CircuitTooWideForTarget(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") Error raised if the circuit is too wide for the target. @@ -985,7 +985,7 @@ Set the error message. -`qiskit.transpiler.InvalidLayoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.InvalidLayoutError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/exceptions.py "view source code") Error raised when a user provided layout is invalid. diff --git a/docs/api/qiskit/dev/transpiler_passes.md b/docs/api/qiskit/dev/transpiler_passes.md index 55d5de5af13..ff74ec075c7 100644 --- a/docs/api/qiskit/dev/transpiler_passes.md +++ b/docs/api/qiskit/dev/transpiler_passes.md @@ -95,7 +95,7 @@ python_api_name: qiskit.transpiler.passes -`qiskit.transpiler.passes.rzx_templates(template_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rzx_templates.py "view source code") +`qiskit.transpiler.passes.rzx_templates(template_list=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/passes/calibration/rzx_templates.py "view source code") Convenience function to get the cost\_dict and templates for template matching. diff --git a/docs/api/qiskit/dev/transpiler_plugins.md b/docs/api/qiskit/dev/transpiler_plugins.md index ab9b8393b1a..68c13b129d9 100644 --- a/docs/api/qiskit/dev/transpiler_plugins.md +++ b/docs/api/qiskit/dev/transpiler_plugins.md @@ -99,7 +99,7 @@ There isn’t a limit to the number of plugins a single package can include as l -`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. @@ -123,7 +123,7 @@ plugins -`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/dev/transpiler_preset.md b/docs/api/qiskit/dev/transpiler_preset.md index c57125ffdd9..8f686a4005f 100644 --- a/docs/api/qiskit/dev/transpiler_preset.md +++ b/docs/api/qiskit/dev/transpiler_preset.md @@ -28,7 +28,7 @@ This module contains functions for generating the preset pass managers for the t -`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=1.0, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=1.0, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -101,7 +101,7 @@ The preset pass manager for the given options -`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -129,7 +129,7 @@ a level 0 pass manager. -`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -155,7 +155,7 @@ a level 1 pass manager. -`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. @@ -183,7 +183,7 @@ a level 2 pass manager. -`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. @@ -215,7 +215,7 @@ a level 3 pass manager. -`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. @@ -231,7 +231,7 @@ a pass manager that populates the `contains_x` properties for each of the contro -`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. @@ -239,7 +239,7 @@ Get a pass manager that always raises an error if control flow is present in a g -`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -264,7 +264,7 @@ The unroll 3q or more pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -288,7 +288,7 @@ set has been set in earlier stages -`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -316,7 +316,7 @@ The routing pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -340,7 +340,7 @@ The pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -372,7 +372,7 @@ The basis translation pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/dev/utils.md b/docs/api/qiskit/dev/utils.md index 5bee46c77f6..4a26e5ff13a 100644 --- a/docs/api/qiskit/dev/utils.md +++ b/docs/api/qiskit/dev/utils.md @@ -22,7 +22,7 @@ python_api_name: qiskit.utils -`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") Dynamically insert the deprecation message into `func`’s docstring. @@ -37,7 +37,7 @@ Dynamically insert the deprecation message into `func`’s docstring. -`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") Decorator to indicate an argument has been deprecated in some way. @@ -67,7 +67,7 @@ Callable -`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_arg. @@ -89,7 +89,7 @@ Callable -`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") Decorator to indicate a function has been deprecated. @@ -118,7 +118,7 @@ Callable -`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/deprecation.py "view source code") Deprecated. Instead, use @deprecate\_func. @@ -141,7 +141,7 @@ Callable -`qiskit.utils.local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.local_hardware_info()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. @@ -159,7 +159,7 @@ The hardware information. -`qiskit.utils.is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.is_main_process()` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one @@ -167,7 +167,7 @@ Checks whether the current process is the main one -`qiskit.utils.apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/units.py "view source code") +`qiskit.utils.apply_prefix(value, unit)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. @@ -200,7 +200,7 @@ Converted value. -`qiskit.utils.detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/units.py "view source code") +`qiskit.utils.detach_prefix(value, decimal=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. @@ -244,7 +244,7 @@ A tuple of scaled value and prefix. -`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/classtools.py "view source code") +`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. @@ -271,7 +271,7 @@ A helper function for calling a custom function with python [`ProcessPoolExecuto -`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/parallel.py "view source code") +`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -383,7 +383,7 @@ from qiskit.utils import LazyImportTester -`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -504,7 +504,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -518,7 +518,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. diff --git a/docs/api/qiskit/dev/visualization.md b/docs/api/qiskit/dev/visualization.md index 285edeb0200..b336c5a9275 100644 --- a/docs/api/qiskit/dev/visualization.md +++ b/docs/api/qiskit/dev/visualization.md @@ -227,7 +227,7 @@ You can find code examples for each visualization functions on the individual fu -`qiskit.visualization.VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/exceptions.py "view source code") +`qiskit.visualization.VisualizationError(*message)` [GitHub](https://github.com/qiskit/qiskit/tree/main/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. From 7ceb0f2659aa1fa5e2a7bb278b446a4d04124177 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:04:52 +0100 Subject: [PATCH 29/41] Regenerate qiskit-ibm-runtime 0.14.0 --- .../api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md | 2 +- .../qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../0.14/qiskit_ibm_runtime.ParameterNamespace.md | 2 +- .../0.14/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeProgram.md | 2 +- docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md | 2 +- .../0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../0.14/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../0.14/qiskit_ibm_runtime.options.Options.md | 2 +- .../0.14/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../0.14/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../0.14/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md index ef8945ab292..17605bd0c1c 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md index c13dc573bd8..0da4d99a456 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md index 28e64ada419..558687fd5bd 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_program.py "view source code") A namespace for program parameters with validation. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md index 455421ceee5..de5c23c711e 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md index 811b39aa555..ef9ae55599b 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md index 61ec4f746d7..16110c6fa0c 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md index 9a33ac8a6f2..d5de8834411 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md index 00432a3b753..17d5d80b36c 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md index c3a61a60917..c8c4b2d2055 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_program.py "view source code") Class representing program metadata. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md index 25b65e83f02..79d9708edc9 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md index 335421e3e4c..5544df6be9f 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md index 930a5042c73..0dc834bd6a7 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md index 1834cb65c94..dfb60c894d4 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md index 9b5b24163d6..3e4ab3fe51e 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md index d451c1e77d4..6cdb686af35 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md index 8a4189ddeb1..f9d429b0858 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md index 17ccb3e3073..45f7153512c 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. From 8e7edc64993c2ff444e2e195d585ecf9703473ea Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:05:01 +0100 Subject: [PATCH 30/41] Regenerate qiskit-ibm-runtime 0.15.0 --- .../api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md | 2 +- .../qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../0.15/qiskit_ibm_runtime.ParameterNamespace.md | 2 +- .../0.15/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeProgram.md | 2 +- docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md | 2 +- .../0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.options.Options.md | 2 +- .../0.15/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md index 3585263d84d..aba712b1f3f 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md index b2675eec2da..cf052882d62 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md index fc17cf68834..87f5baefab9 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.ParameterNamespace -`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_program.py "view source code") +`ParameterNamespace(parameters)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_program.py "view source code") A namespace for program parameters with validation. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md index ff8facac958..9f5898380f2 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md index dfd9ab5fa94..a7680fa04c2 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md index bd77659d8f1..34d302636c2 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md index c1026f2fed1..5fd1365ce83 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md index 58dc1a66db9..ac706008a6f 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md index 308e3e53776..c52e05d96ec 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_program.py "view source code") +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_program.py "view source code") Class representing program metadata. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md index 572d8f5c754..f684344c3f1 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md index 936913a6114..5ea71fbc233 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md index ff00beac674..3deaedd6b5b 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md index b178127a453..39609f742f0 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md index 6c4a9a207b3..6b7726f2d66 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md index 75b4d7895f6..020843b8b3f 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md index 2f526f70b0e..b537857f132 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md index 706c2cedf6a..ea6c2bdef95 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. From abcfe62838a558c640bd0cd47d77f008c9ac892d Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:05:11 +0100 Subject: [PATCH 31/41] Regenerate qiskit-ibm-runtime 0.16.1 --- .../api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md | 2 +- .../qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../0.16/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md | 2 +- .../0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../0.16/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../0.16/qiskit_ibm_runtime.options.Options.md | 2 +- .../0.16/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../0.16/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../0.16/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md index 932c79f6d01..da4262ab8f2 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md index 74edba64268..babe77b2e93 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md index 883d8f40c68..2ae0b3941af 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md index 7a768189ad3..b2727cb9e56 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md index 23f51ad27c5..d68d85d6333 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md index f6fe2a4fcfc..15d25b9af9f 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md index 3699cf37c03..12e1307aa60 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md index f16bec7fbb7..f4d09a1fb65 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md index f6e8bf5d211..f691e7131d9 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md index 54531b7523a..f1f707577da 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md index 20a91324699..76cd21c98b8 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md index 70ed08479db..2d04292cbc0 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md index 9ae98a40b83..c57f55845a5 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md index 986b77a4b6c..8cc9e329c15 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md index fb077a1b52a..6559b5bbb16 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. From 82c0d001dc5200f30dd89ed440bda3584248cb2a Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:05:19 +0100 Subject: [PATCH 32/41] Regenerate qiskit-ibm-runtime 0.17.0 --- .../api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.md | 2 +- .../qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../0.17/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.17/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.17/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.17/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md | 2 +- .../0.17/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../0.17/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../0.17/qiskit_ibm_runtime.options.Options.md | 2 +- .../0.17/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../0.17/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../0.17/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.md index 9dca205e864..240bc13bf3d 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.md index e2d8ab0c1e0..92ccc3b873c 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md index b435c7fda99..0052537e6b8 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.md index bac7fe00916..16678ae9a8d 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.md index cef5950dcdd..9b040c37ab9 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.md index 74a04f74a7c..047a590c409 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.md index c1c3585fc63..8bfdb5ce73d 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.md index 82a4901169d..521b55c9282 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md index 6b601d49289..f840b83b893 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.md index 31f4ada9bac..088ddd3fd90 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.md index 12b7e92328d..dd1e0e2e3ae 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md index 265fcea8d35..1639c274405 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.md index 173b577f758..0776f59f091 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.md index 73712941cb9..5635d731881 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.md index 1cb9054dcaa..a65e81203d3 100644 --- a/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.17/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. From ae925395870e2807c56c79b7a7355ffacb5f2762 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:05:40 +0100 Subject: [PATCH 33/41] Regenerate qiskit-ibm-runtime 0.18.0 --- .../api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.md | 2 +- .../qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../0.18/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.18/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.18/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.18/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeLima.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeManila.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeParis.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakePerth.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakePrague.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.md | 2 +- ...qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeRome.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.md | 2 +- .../0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md | 2 +- .../0.18/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../0.18/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../0.18/qiskit_ibm_runtime.options.Options.md | 2 +- .../0.18/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../0.18/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../0.18/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- ...runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ..._ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...iler.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- .../qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md | 2 +- ...ntime.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- 112 files changed, 112 insertions(+), 112 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.md index 5e001df8cae..a779072ee07 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.md index e30e71c935f..f23283471d7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md index bc416469370..78540c23bbe 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.md index 3d78ab2e114..870c01c15e7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.md index 252c4cdebd8..cc6f6d7dabc 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.md index fbf4469a020..55d83edf713 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.md index e1025310f77..f57320251d0 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.md index 7f04acf3343..09d779af07b 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md index a9557b85c9c..fe945281c88 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md index 2733b49fb3f..79807c036a1 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md index 46e73e559f6..54ea5ffcb23 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.md index d585995b4f6..80c88f6ca7e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md index 4659af87397..a6bbf060ef5 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.md index 867e997f7dd..97f0bda2bc3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md index d234e3c2522..d06b4cf6493 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.md index eea415ca0e4..1c201d474f6 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.md index ca801fb7743..960d295e1d2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md index 5ea1cf6c31c..4428040bee7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md index 764eea0f013..1becd96cf75 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md index 1f575b52621..d4955b2f6e3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.md index e873ca3690a..149ee71f577 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md index 31ea67febfe..43e3baee56d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md index 367877bab66..32e95a617e9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md index 9d7f326ec31..861ab1d6b8c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.md index 443aa4d97c3..508df3db284 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md index 73ccf9df474..d059e4c80b3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.md index 42d8c9fd19a..f9e707eea48 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md index 572f6730904..445879a6f06 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.md index d4161491db4..3d4c654a41c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md index 47a09ec396a..6257bb987c3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md index 76df8b5e11d..51b1dd1f22f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md index a4d366ccab3..1066c015117 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.md index b667ef5ac8c..4e11d83ab97 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md index 29245210fcc..336f567beb7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.md index f129929223f..3a222bad19e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md index c428b6cd3f6..c70cf4d3a2d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md index 9e59b95b0e1..f0c3cac47f1 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.md index 9679d0fd9e6..c0c4f901532 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md index cf4d0871361..1d9c64b2f9e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.md index 8bb73e419c4..d0b6c1bd2bd 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md index b114905a771..008faa63d3d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md index a5b69f0852e..26a3733a96e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md index 995312400e6..c961ccb2e11 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.md index 23070bc3240..5dd20d4cda4 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md index 4e96b073d01..1b7e17baf3e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.md index 97b50ab90a6..66b48ccff03 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md index 10cc798589e..8d4549dd22e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.md index 3c641cac4ef..f28828bec10 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md index 8eff9c99172..586c2dad04c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.md index 288d19f3372..c7b65cebf17 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md index a060b356ecf..1f35e6b7401 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.md index fc5628faf38..ec477a82e3e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md index 6fa241e08d3..2b94c7c88d3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.md index 2ec69307264..3780a296567 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md index 5cc84074e75..f7a6b49bfd2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md index 7b08090d8b4..4c079d3fe34 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md index 1eef5579144..bb9bb2a3a95 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.md index f29f7569f50..2d7dae31637 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md index 14326c8c8a4..2d779285d28 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.md index 22620afbb6f..1fc12d8e9f7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md index 415e9636dee..7f8f168dd11 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.md index e08bc2bc01a..64f5f7fe29a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md index b7bbd6dd2f7..7fcb6885b4f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.md index 0bf82e6198c..a7f8246ef8d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.md index eda7fed0c91..d9d49b056a2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md index adb0ee5f49f..5c1c4e213f3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.md index 618825103b5..ed7d14bf964 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.md index bf7deb29039..7f71d536de2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.md index 09c54ecd64b..20e79488e7a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md index 5254e189c48..fb77f732732 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md index b228e57d7b1..707d1e96fc2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.md index beb99b25704..cb3e01bef2d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") A fake 33 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.md index 92e06bab71e..a3445f26542 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md index ce37668b45c..4116d87437c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.md index 277e16e93f3..8f7a51b4920 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md index 9ccff98e40e..3e51f60ee81 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.md index f7167d3514d..bbd44d36959 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md index d42757e201c..aafaff7e29f 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.md index abaf3205f7a..4b73a59ed31 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md index b0686dc41f0..5303cdf2752 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md index d20fe3eb113..387e87debe2 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.md index 7c8fb2ed197..8eb5cc30152 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md index 63a48a2fc8c..4faadda7539 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md index 8dc9effcec2..287683cca16 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.md index 9d8a737c160..28af8ce4ab4 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md index da330d078c3..1b5c99cef56 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.md index 5a22bde677a..5e1874aacdc 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md index c3b21bfeee6..9d682d94a5d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.md index 965fb9eddb2..986e8f32659 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.md index ce14a58ce5f..31a2a546e53 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") A fake 20 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.md index 814fd24205c..e2758b13396 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md index 2b4bb316627..80e554e79ff 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.md index 1241c3906c5..24be27b512d 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md index 717668baaf5..2f3e209f05e 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.md index 4b95560d8fc..69648838740 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md index aff95d2c6d4..44737955f39 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.md index 9f17f296247..6787c2056f3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md index de968b02d4b..e6e0d037565 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.md index 456a92ae45f..372e65eb175 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md index eed7e30f930..75737329de9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.md index f1c3a7806b0..e6c0a2f37fb 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.md index 02433701bed..8022841f0f9 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md index 813eddcfb2c..e9f9e896cde 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.md index 90461ffcd56..56bf0a902fb 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.md index f58031b26bb..a3ff01c5664 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.md index 2fccd2f0a22..c3a65bf91f7 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index 1bef9e5e7d0..4357852b89a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 6f25bb03f78..234da63c877 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md index bbb974ce499..3f56a340b5c 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 0a6c354520f..57bacea8eec 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md index 8de01e9c0a5..2b90e2bf0f3 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay -`PadDelay(fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 73a6ac7f444..c7bed7e390a 100644 --- a/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. From 75796718c28f045f29097fff8fd357c9a80eeb76 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:06:01 +0100 Subject: [PATCH 34/41] Regenerate qiskit-ibm-runtime 0.19.1 --- .../api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.md | 2 +- .../qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../0.19/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.19/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.19/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.19/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeLima.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeManila.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeParis.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakePerth.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakePrague.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.md | 2 +- ...qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeRome.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.md | 2 +- .../0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md | 2 +- .../0.19/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../0.19/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../0.19/qiskit_ibm_runtime.options.Options.md | 2 +- .../0.19/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../0.19/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../0.19/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- ...runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ..._ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...iler.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- .../qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md | 2 +- ...ntime.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- 112 files changed, 112 insertions(+), 112 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.md index 22c803b1506..1b358427497 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.md index 8d851ff23bb..25d2f382b9b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md index a1539ded35f..da435dfa8cc 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.md index 354fe92e667..b733dbd0110 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.md index adfe7e1f32d..1392815ded3 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.md index 560b6242c37..4cd107c5942 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.md index 938c57a3296..354e88e9fac 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.md index 7bd6a881fb9..e795a9d97fd 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md index b06fc8d5749..0d27c7e9d2e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md index 4c9ad3f596b..f73b87ab209 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md index 52776d36035..a60ea9aaca9 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.md index c1033f7ee80..109c07a2447 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md index 84a7c119988..35f2a588d33 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.md index 5867512345f..b0f0aa0de3a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md index 7c55dcab98d..4c5596fd8e5 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.md index f5c0d8dadec..081f3929f5b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.md index 0fe1a0bd177..b947a33fc44 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md index e40783e2525..2fa639f3b49 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md index 6d83fee0a53..5e7999a1913 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md index a07759494b1..2fc91e6768f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.md index 67b5df79ddb..4023df9e94d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md index c315b8cca60..ad27ce8641b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md index fe8e8ebe37a..a47712f0c67 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md index 49439c428b9..2b64c78ec08 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.md index 68228a14301..64fae7f1093 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md index a2280ea40de..14212d5d9f5 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.md index b58909bba6d..d924173b825 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md index 5afa260b4bb..aea3c1883b6 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.md index ac2b707e9aa..98c8548c027 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md index c645becdbb0..e32fb1b2035 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md index 03f20e25765..2e1538f6155 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md index f4e5772becf..a2f4b37aca7 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.md index c99808e9a94..62d4feb72c8 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md index b5f23725caf..bc1c9f10fee 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.md index ac1a2c3fbb9..2a161152aae 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md index d0a54f96765..f75c96bf0a1 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md index ab73bea6491..a5875f8841d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.md index 90da4af1afb..85e70ca06db 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md index b65cb6baf34..d1c9bd10315 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.md index 1ff18003fa4..f0d1eb76b9b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md index bc71c67f97f..271834e555f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md index 2a87c0c8f80..5ac78011630 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md index ad07ace8e41..33617b63149 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.md index 769e783f805..2409ddf960f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md index 1342a1ae581..0be97d06ca2 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.md index 0bf2dc0ff0b..368290e7c54 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md index 2f60dc6effa..1c30383a939 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.md index 8db4c37ebc4..8cbd0d8f908 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md index 1b748d8c1e6..fbe1a9b6b68 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.md index a5efdc3feb8..3272e0ba45b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md index 7eb52c5bc52..898f64f712b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.md index 838a6ac754b..fc5731aafba 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md index d2479e0d687..1926823cc35 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.md index dc5e087d0a5..d437bdb12fb 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md index 753fa3a185f..1d25987464b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md index 1b3e03d6415..c922659bc8f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md index 54b91b94f7e..168f531e58a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.md index 68a96890032..a0ead981d49 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md index 7cbeb16db6b..4ade1735349 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.md index cf25bbe425b..b280f17ad61 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md index 9422577e151..b06112bcf1f 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.md index 4e3dbe2e458..4a6b36c8447 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md index 6f0d01afbf8..720c2a20581 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.md index a1d01f7e8e2..e1a69af6513 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.md index 9f7ce493acc..05ed696c00b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md index 24ad5a7b410..22083974f0b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.md index 7b7591effbc..e541880f469 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.md index 80c3c37cdb9..0797464dc6e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.md index 65f6c12b7b1..e4607273e94 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md index 5c77eb06b7c..6b192b3374d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md index 1a85e306738..5ac52753e9d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.md index 6a39cfaaefd..11d54b68a00 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") A fake 33 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.md index 5acb546fbe6..c8ae88f73ab 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md index 8a50f0f2853..0a58aeb2c02 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.md index 6f7b9fe6454..bded18af5bf 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md index 031550b7f9b..c025e84a691 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.md index ef3ed92efd8..be53a3d42d6 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md index 25d384d934c..d7a24e3fe19 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.md index 4f62fe78b21..0bf8b549f1e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md index 162d9ad4a4e..87f116f126c 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md index 80fd308fd4d..3a24b1497be 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.md index 4c3814d4807..31c34be374a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md index 7e72d04f6ef..c769be50f9d 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md index 759a5015779..c5996533198 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.md index 69b8744faa6..90dfd870493 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md index 55a9b5a1001..8eaa2942065 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.md index 6329009ae2e..9190a1de33b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md index 0458b3a5fb5..b15ae85dafb 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.md index b9e4f39afa2..3e365e0c2e5 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.md index 196dceae84a..3bd32ba77c8 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") A fake 20 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.md index d2dab963de7..a3311a4dfcd 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md index f931c0fc638..024324c798a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.md index 5467139ba18..281d8d0e3ab 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md index 19136627907..7b59b943b97 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.md index e82a0287c9b..48416a3e526 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md index 5ceddf12692..419af4d6d30 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.md index d219770f76f..89d18588a29 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md index f57ed5866a6..dad74dff379 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.md index b1a01d45985..788fed35dae 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md index e7f1a7f201b..12f39b82d4a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.md index 4d7a4f86c92..1733f5e994a 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.md index ecbebe7c6f5..dde7b53d82e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md index 88ac5fc1d3d..d75c79dffd1 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.md index b43d688640d..0b2fff60335 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.md index b370f2c89e4..709a984e254 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.md index ea9b500fc70..0b26b4a7ec0 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index 278d85bff41..66d67aeb8f0 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 3c53f54d66f..07ef01d515b 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md index d301e70cc66..69208fe40ee 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 884997a348d..4382442ec36 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md index b48b74e62a1..b98ae6ba2f6 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay -`PadDelay(fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 609b7e00481..8a24d82819e 100644 --- a/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-runtime/0.19/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.19/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. From 4b7ce2340de8c3c38cef75beb33966784aff07fb Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:06:22 +0100 Subject: [PATCH 35/41] Regenerate qiskit-ibm-runtime 0.20.0 --- docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md | 2 +- docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeAlmaden.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeArmonk.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeAthens.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeAthensV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeAuckland.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBelem.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBelemV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBogota.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBurlington.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeCairo.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeCairoV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeCambridge.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeCasablanca.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeEssex.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeEssexV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeGeneva.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeHanoi.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeJakarta.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeKolkata.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeLagos.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeLagosV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeLima.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeLimaV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeLondon.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeLondonV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeManhattan.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeManila.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeManilaV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeMelbourne.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeMontreal.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeMumbai.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeNairobi.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeOslo.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeOurense.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeParis.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeParisV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakePerth.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakePrague.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeProvider.md | 2 +- ...qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeQuito.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeRochester.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeRome.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeRomeV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSantiago.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSingapore.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSydney.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeTenerife.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeTokyo.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeToronto.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeValencia.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeVigo.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeVigoV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeWashington.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeYorktown.md | 2 +- .../qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md | 2 +- .../qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md | 2 +- .../qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- ...runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ..._ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...iler.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- .../qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md | 2 +- ...ntime.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- 112 files changed, 112 insertions(+), 112 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md index 83e1bab7dfa..dbe4ffc09ef 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md index 623313e9ade..ac879c9207e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md index bd16922bece..db048ae0ce8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md index 8eb9c39fd00..d65aa3fac3c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md index a52468f6b6e..f38d0cbc3de 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md index 0ce44fee420..68afde165e6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md index 3c6654e21c5..b790df2aa02 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md index 99165b9f4ec..22e1342630c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md index fd22414709d..8cd3725735e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md index 5f13432b2a6..fcf99528e08 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md index 78b313f7d99..8f0a049103f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md index 54ae5f8986d..4ea00a39b95 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md index 07208635031..931d0199473 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md index ef62f4dc010..0491b262261 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md index a6de9e9a634..0cde7143827 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md index b3a9c54044e..4d97679ca8d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md index 38caa7ede02..e72121f1b67 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md index fe0558ebc51..ef44d579a07 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md index 09a4aa827c1..8574bc309ed 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md index b9ff072cd1d..8f7ceef7dab 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md index 52c4bd95927..96edd839cc6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md index 687ffebf080..558504012fc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md index e67f0a4a87c..242df4c19b5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md index 3faf1d78032..2784d5302d5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md index 5b7e7ef4601..2feef8a9c09 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md index b77421c5f8d..ae0b4814b24 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md index e9619a511df..11dee13fb93 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md index 1df6b43760f..f89a0be3da2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md index 137f23d3ca2..b102aef3103 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md index a2d7068f2ee..eb964f2d228 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md index 740ee13ea64..1dc3d0f8ca8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md index 6796607c265..13cc5461fdf 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md index 5b949ec4a04..a4bd0c7f49a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md index 27ef19fd257..a61227a1896 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md index c111a6b978a..eabfa758c04 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md index 7987e86fc9d..017b5a186c3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md index 6f1d5c56f14..da18fed6dfd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md index 2bbacc188f5..0b7c251f9c2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md index e6ee64b54ff..41d4d14ae71 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md index e5c9dc83767..b8290ff151f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md index a3952b4cda6..0c87560121b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md index 4a8d7174eb2..5cfbcef34d2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md index 30ae84bc954..4a8d4bba9ff 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md index a4fb41f7bf9..5dedec432db 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md index 820d32d0345..730b26f868f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md index e5a0a93e604..f9df6b79a19 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md index 291a38c18ad..5cd5ce7431f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md index f864923107a..b200110c452 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md index 403a389e45f..a371ceba2ff 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md index 5f2073f1f00..95e564f20e1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md index 8497173b1e0..872753da8ab 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md index e9b2c3ea34c..db7b5780162 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md index c7fd78bc371..375c33139e7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md index 2cd1845dadc..6c0ab594018 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md index f039eaa83eb..00a769bb870 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md index 23d05011589..3f42be60b64 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md index bfe6299f572..bf23cf2f6b6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md index 38a1e7bb126..ca57260b7e5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md index f2cf68b4dfb..ebe1ba403dc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md index 27c55a24bfc..83511b1eaa6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md index bd4a36780a0..812df39abd6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md index 024ac76ead3..18e9c5b821f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md index 2cb6a31a721..423d7422966 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md index d0dcd69f655..989f708416b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md index 028f278f27c..84d297a7964 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md index 18ed5916937..0116e45fd75 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md index a21a76a91ea..aa81409428a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md index d713bb72507..ee3d41d6e79 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md index d54d51d698d..21226528c80 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md index a31ab0cb430..7772a47cbb3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md index 724fc2ba257..4491c895625 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md index cd00807e3f2..227566a7ef4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") A fake 33 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md index 3578c5311d7..f95f5332131 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md index 74608def0db..9563f5a9d50 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md index c968bdaeb1e..5311f3273bb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md index 6adf3da7839..7848d2045a8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md index 57c996ca823..b571e250ed1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md index 5490a2c4060..450be21474c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md index 9d57c0a3e41..b03ef007cea 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md index d99f49ed2e8..a91558992db 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md index 261f076aa31..2442f21c426 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md index 77312db6dc7..a7688651ad3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md index 18b71e8418d..fabd98809cd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md index be48c3a6bde..82331c4373c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md index 35f9ae040bb..58bfbf75e66 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md index a60f9d33c4c..50990f00848 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md index f957d308d30..6501ffd7838 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md index 57b8c1c2e0a..30eb683f831 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md index 4e7b1ca87f6..d92d05bb0d8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md index 5cfbd8e5c3c..1d02e8efeea 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") A fake 20 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md index e5d81c48474..a39439be196 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md index 6c3f14c761f..033456a9bba 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md index 11166a161c6..d581a925b3d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md index 3b9503838d3..775b1afd6f2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md index 82f91f24cfa..d50bcc3dea8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md index 08327ca3a5b..8d82871effd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md index 8376c8b8bb6..ebd019b3519 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md index 24be562b671..63659beb657 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md index dd8ac21a9ef..6b1f77b50e2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md index 1ad3ac8c5f2..c4aac8ae40c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md index b4353daf2f4..f883f74908c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md index 5a4b67d05df..0636d72efa6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md index 19d43ed4eaa..b840b2448c0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md index 13701d01640..476bddb3234 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md index df220dfce0d..18f8bd6f567 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md index 62e4aa290ba..985be0d8cd9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index a5b9110ff20..078fb7209fa 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index f039f8b70f4..70aba5873c0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md index 58f490d9cc4..575d152b6a4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 35d6002285f..5e479fe016f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md index 1fbfd93b758..85c968d03b8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay -`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md index b24330b91a9..fb1d334711f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. From 0168bcb5f19cfcb479783e3ec294bded40651091 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:06:44 +0100 Subject: [PATCH 36/41] Regenerate qiskit-ibm-runtime 0.20.1-dev --- docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md | 2 +- .../api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../dev/qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md | 2 +- docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeLima.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeManila.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeParis.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakePerth.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakePrague.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md | 2 +- ...qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeRome.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md | 2 +- .../dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md | 2 +- .../dev/qiskit_ibm_runtime.options.EnvironmentOptions.md | 2 +- .../dev/qiskit_ibm_runtime.options.ExecutionOptions.md | 2 +- .../dev/qiskit_ibm_runtime.options.Options.md | 2 +- .../dev/qiskit_ibm_runtime.options.ResilienceOptions.md | 2 +- .../dev/qiskit_ibm_runtime.options.SimulatorOptions.md | 2 +- .../dev/qiskit_ibm_runtime.options.TranspilationOptions.md | 2 +- ...runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ..._ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...iler.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- .../qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md | 2 +- ...ntime.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- 112 files changed, 112 insertions(+), 112 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md index 699545e080a..a7fd9946ce5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator -`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py "view source code") +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py "view source code") Class for interacting with Qiskit Runtime Estimator primitive service. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md index 7d3e54feae8..46e95e7845a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md index f5079be8e2f..7d110710599 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code") Class for interacting with the Qiskit Runtime service. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md index d06453e6a52..12a538763a8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py "view source code") JSON Decoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md index abdf11bdc28..4f0b8cd950d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py "view source code") JSON Encoder used by runtime service. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md index 2a370e59ebe..646146048f0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md index b894ae56a09..d01176dc3ba 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_options.py "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md index d297a95754d..e5e1ee77e52 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler -`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py "view source code") +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md index 68e8a4b2ede..1d57ad53532 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md index f9d80f4b6bd..0a54281c83d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden -`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmaden` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md index a66b7d18b3c..ea105766739 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py "view source code") A fake Almaden V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md index 2a2d3f5a83b..19eaef790b5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk -`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonk` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md index 56732d00f0c..92752cdafe6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 -`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") +`FakeArmonkV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py "view source code") A fake 1 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md index c12bb282b51..67bd7b22b20 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens -`FakeAthens`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthens` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md index 87c01938d75..7ff95b1bc8f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 -`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") +`FakeAthensV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md index 7f6977405cd..6addbd898a6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland -`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") +`FakeAuckland` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md index de20ad2d735..df458d5beb0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem -`FakeBelem`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelem` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md index 02138d01d3a..aea950e8eec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 -`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") +`FakeBelemV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md index b2c8f38b645..7ff55de1141 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen -`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingen` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md index 33578d7e98e..ee875cbf0c3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") A fake Boeblingen V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md index cf9561849c1..0b67788ca19 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota -`FakeBogota`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogota` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md index 9de35af9c7c..4d6857b5f24 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 -`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") +`FakeBogotaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md index aa72304f236..edfa5262f7c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn -`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklyn` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md index 8ebd83e9688..964c4c34075 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") A fake Brooklyn V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md index 9c9c0d1433d..192603dc609 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington -`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md index 28df3998e03..bd85a54816d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md index eab65ea4c04..21c5b0f2ccf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo -`FakeCairo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md index a4865119dee..66e5db42e81 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 -`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") +`FakeCairoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md index ea1ed230bc4..eccde06742e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge -`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridge` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md index 4c22760beee..e44f73ed9f4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py "view source code") A fake Cambridge backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md index 38d61527297..a15d1113030 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca -`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablanca` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md index 195320739d6..f425b7f7e27 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md index 758b873423a..5c4f1890339 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex -`FakeEssex`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssex` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md index e1c5e7b31ea..1cc968dffe4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 -`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") +`FakeEssexV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md index aa9c42bd1e6..d8c86718ad1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva -`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") +`FakeGeneva` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md index fb53520f102..f72e80f83e6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe -`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupe` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md index 3a1d6e4b63b..fc2d4fb6287 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md index 43c58453d4b..4f8779c7c87 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi -`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md index f746a35895a..e05a48e56e1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 -`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`FakeHanoiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md index 5d1bdfc89fa..ba0558cc9b3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta -`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakarta` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md index d0494bbebc5..8734a3882bd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 -`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`FakeJakartaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py "view source code") A fake 7 qubit V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md index 2ba12d8feeb..73ad2debe12 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg -`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburg` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md index 09a4a3f6e46..1f3983293b9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") A fake Johannesburg V2 backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md index 365fe349736..9e5c8fc06d7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata -`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkata` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md index 40649e1d7fd..7a5fcfd423c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 -`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`FakeKolkataV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md index 4f5e821fa78..6adb07fe42d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos -`FakeLagos`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagos` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md index 74c8e1c90b8..ee6c32347a5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 -`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") +`FakeLagosV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md index e3226d35376..3d711cc330c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima -`FakeLima`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLima` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md index 5b53d451136..79d0b5eb2f9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 -`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") +`FakeLimaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md index a61b785b408..14f8bb957f1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon -`FakeLondon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md index bef9766fcbb..e3195f10383 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 -`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") +`FakeLondonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md index 22d15e67cb1..6c77ab57b6e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan -`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattan` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md index 98621b7e935..41170f570d1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 -`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`FakeManhattanV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py "view source code") A fake Manhattan backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md index 903e2f0b720..e0695bad1f2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila -`FakeManila`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManila` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md index 478298b7ff8..2a990fe0742 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 -`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") +`FakeManilaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md index 10f0ce26c04..da6fbd56707 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne -`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourne` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md index c9b129662ed..9cb73035abb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py "view source code") A fake 14 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md index 51ef07b5557..fbcd2987856 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal -`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontreal` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md index 53bf4aa073a..a4c1c9ffb78 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 -`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") +`FakeMontrealV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md index 900a7518b3c..a2535bf8644 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai -`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbai` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md index f6a63b833a2..c370a0d7aff 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md index a3e0155023e..71914d63113 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi -`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobi` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md index 9fbc3f10ee9..9ac2859203d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 -`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`FakeNairobiV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md index c47f6b65a06..60b88b16629 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo -`FakeOslo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") +`FakeOslo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md index b2f4f52cf98..d423b14d005 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense -`FakeOurense`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurense` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md index 878011fc72a..7f0383ae25c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 -`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") +`FakeOurenseV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md index e9fc6e08a99..2063e56f5bc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis -`FakeParis`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParis` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md index 001e8d85051..c28e400462e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 -`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") +`FakeParisV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py "view source code") A fake Paris backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md index 5ee2902c5ca..90ecb0c81b6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth -`FakePerth`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") +`FakePerth` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py "view source code") A fake 7 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md index 34ff6c6b7ff..11fd2421c49 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie -`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md index 874d3b06064..2a005abdb16 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") A fake Poughkeepsie backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md index a0328f2d2ba..b309f1ed2b8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague -`FakePrague`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") +`FakePrague` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py "view source code") A fake 33 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md index 2b95eed433e..a1008216667 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider -`FakeProvider`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProvider` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V1 backends. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md index 862e7f7806b..d9d7b3977cc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py "view source code") Fake provider containing fake V2 backends. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md index 5b38cce5174..c0123a40238 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito -`FakeQuito`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuito` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md index 8c16702d0ef..07305ed35e0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 -`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") +`FakeQuitoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md index 03fd0df4476..a7c93b6c4a2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester -`FakeRochester`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochester` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md index 902a86f2190..9abe5007cd4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 -`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") +`FakeRochesterV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py "view source code") A fake Rochester backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md index a47a1e1db9d..6f0dadc7cf9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome -`FakeRome`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRome` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md index 652904ca477..6701de0075e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 -`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") +`FakeRomeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md index 7ca89c3559d..27d74bb8998 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon -`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`FakeRueschlikon` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md index 235905d5c79..ed022068699 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago -`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiago` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md index 33239aebf93..b4017979acc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py "view source code") A fake Santiago backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md index eb012e8a7f2..153d5e7bd9a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke -`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`FakeSherbrooke` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md index d26091b7e83..c5677d94205 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore -`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingapore` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md index 53941ef809d..67406cf6973 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py "view source code") A fake Singapore backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md index fa9809ce053..fe65945857b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney -`FakeSydney`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydney` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md index 3185cdfc788..50ba03f888c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 -`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") +`FakeSydneyV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md index ee255a20dc9..2cbcfc34fa6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife -`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`FakeTenerife` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md index ca45c56b036..98b31a140b5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo -`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`FakeTokyo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py "view source code") A fake 20 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md index fea69354fdc..e19a0b03479 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto -`FakeToronto`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeToronto` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md index d891128a39b..3db693d46c3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 -`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") +`FakeTorontoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py "view source code") A fake 27 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md index fa38a6b9d5e..6b461c54d47 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia -`FakeValencia`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValencia` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md index 754b2c4030e..c99e3a1f58a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 -`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") +`FakeValenciaV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md index ee81cfd6898..5b957b7f715 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo -`FakeVigo`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigo` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md index b3773cb75d9..f27bd8c878b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 -`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") +`FakeVigoV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md index 5b124e19631..f4a647c1e86 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington -`FakeWashington`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashington` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md index 40529af4abb..41d294193c2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py "view source code") A fake 127 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md index 29634c51b9d..8932f03b82f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown -`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktown` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md index e726e2e7fdf..d83452f3f48 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 -`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`FakeYorktownV2` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py "view source code") A fake 5 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md index 3398a18c521..e60b1c95f06 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/environment_options.py "view source code") +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md index 39c72f06a4c..ecebf55d6c7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py "view source code") +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md index e213d5e461f..d62a399ac95 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md index 2f9e438526f..71742eec226 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py "view source code") +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md index 642eb1f5f88..e6155feeb8c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py "view source code") +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md index 336356d1d67..6a9c91994a4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/transpilation_options.py "view source code") +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index b684811d774..fe0731522d6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index d6f866dadea..63375f91650 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md index b169c12a88d..28a43af38b9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 5dbf15068d9..fd892c4b242 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md index cfeb77aa7d5..33bf5220696 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay -`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 77f918d51f1..3034ccc5a4b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. From b5ff7f17dead2348a52e9e3100873546944986b9 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:06:54 +0100 Subject: [PATCH 37/41] Regenerate qiskit-ibm-provider 0.7.3 --- .../0.7/qiskit_ibm_provider.IBMBackend.md | 30 +++++------ .../qiskit_ibm_provider.IBMBackendApiError.md | 2 +- ...ibm_provider.IBMBackendApiProtocolError.md | 2 +- .../qiskit_ibm_provider.IBMBackendError.md | 2 +- .../qiskit_ibm_provider.IBMBackendService.md | 8 +-- ...iskit_ibm_provider.IBMBackendValueError.md | 2 +- .../0.7/qiskit_ibm_provider.IBMError.md | 2 +- .../0.7/qiskit_ibm_provider.IBMProvider.md | 20 ++++---- .../qiskit_ibm_provider.IBMProviderError.md | 2 +- ...skit_ibm_provider.IBMProviderValueError.md | 2 +- .../0.7/qiskit_ibm_provider.Session.md | 4 +- .../qiskit_ibm_provider.job.IBMCircuitJob.md | 34 ++++++------- ...qiskit_ibm_provider.job.IBMCompositeJob.md | 50 +++++++++---------- .../qiskit_ibm_provider.job.IBMJobApiError.md | 2 +- .../qiskit_ibm_provider.job.IBMJobError.md | 2 +- ...kit_ibm_provider.job.IBMJobFailureError.md | 2 +- ...bm_provider.job.IBMJobInvalidStateError.md | 2 +- ...kit_ibm_provider.job.IBMJobTimeoutError.md | 2 +- .../0.7/qiskit_ibm_provider.job.QueueInfo.md | 4 +- .../qiskit_ibm_provider.job.job_monitor.md | 2 +- .../0.7/qiskit_ibm_provider.least_busy.md | 2 +- ....passes.scheduling.ALAPScheduleAnalysis.md | 4 +- ....passes.scheduling.ASAPScheduleAnalysis.md | 4 +- ...piler.passes.scheduling.BlockBasePadder.md | 4 +- ...ling.DynamicCircuitInstructionDurations.md | 4 +- ...r.transpiler.passes.scheduling.PadDelay.md | 2 +- ...asses.scheduling.PadDynamicalDecoupling.md | 2 +- ..._ibm_provider.utils.seconds_to_duration.md | 2 +- ...ibm_provider.utils.to_python_identifier.md | 2 +- .../qiskit_ibm_provider.utils.utc_to_local.md | 2 +- ...it_ibm_provider.utils.validate_job_tags.md | 2 +- ..._provider.visualization.iplot_error_map.md | 2 +- ...m_provider.visualization.iplot_gate_map.md | 2 +- 33 files changed, 105 insertions(+), 105 deletions(-) diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.md index 9ffaf345302..540771d74c0 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend -`IBMBackend(configuration, provider, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend(configuration, provider, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum device. @@ -372,7 +372,7 @@ A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit -`IBMBackend.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.acquire_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the acquisition channel for the given qubit. @@ -390,7 +390,7 @@ AcquireChannel -`IBMBackend.cancel_session()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.cancel_session()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Cancel session. All pending jobs will be cancelled. @@ -404,7 +404,7 @@ Cancel session. All pending jobs will be cancelled. -`IBMBackend.close_session()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.close_session()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs. @@ -418,7 +418,7 @@ Close the session so new jobs will no longer be accepted, but existing queued or -`IBMBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.configuration()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the backend configuration. @@ -440,7 +440,7 @@ The configuration for the backend. -`IBMBackend.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.control_channel(qubits)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the secondary drive channel for the given qubit. @@ -464,7 +464,7 @@ List\[ControlChannel] -`IBMBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.defaults(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the pulse defaults for the backend. @@ -488,7 +488,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMBackend.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.drive_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the drive channel for the given qubit. @@ -506,7 +506,7 @@ DriveChannel -`classmethod IBMBackend.get_translation_stage_plugin()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`classmethod IBMBackend.get_translation_stage_plugin()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the default translation stage plugin name for IBM backends. @@ -520,7 +520,7 @@ Return the default translation stage plugin name for IBM backends. -`IBMBackend.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.measure_channel(qubit)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -538,7 +538,7 @@ MeasureChannel -`IBMBackend.open_session(max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.open_session(max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Open session @@ -552,7 +552,7 @@ Open session -`IBMBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.properties(refresh=False, datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the backend properties, subject to optional filtering. @@ -611,7 +611,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`IBMBackend.run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. @@ -708,7 +708,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.status()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") Return the backend status. @@ -734,7 +734,7 @@ The status of the backend. -`IBMBackend.target_history(datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend.target_history(datetime=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend.py "view source code") 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 with properties found on datetime diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.md index ddd9eca9b94..7c3cedb45af 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError -`IBMBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.md index d9a8a383a71..e8083f83e9e 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError -`IBMBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.md index 6bf6c75d7bc..04a892e560c 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError -`IBMBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.md index eb0da84b790..682f8499d18 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService -`IBMBackendService(provider, hgp)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService(provider, hgp)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") Backend namespace for an IBM Quantum account. @@ -48,7 +48,7 @@ IBMBackendService constructor. -`IBMBackendService.backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService.backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") Return all backends accessible via this account, subject to optional filtering. @@ -107,7 +107,7 @@ The list of available backends that match the filter. -`IBMBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") Return a list of jobs, subject to optional filtering. @@ -149,7 +149,7 @@ A list of `IBMJob` instances. -`IBMBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_backend_service.py "view source code") Return a single job. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.md index 6b07b48b586..589fe100632 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError -`IBMBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.md index 599a5995d4d..03b3f29344f 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMError -`IBMError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.md index 8dc31ed2c4a..18a04b78e8d 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider -`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Provides access to the IBM Quantum services available to an account. @@ -145,7 +145,7 @@ The backend service instance. -`IBMProvider.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider.active_account()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Return the IBM Quantum account currently in use for the session. @@ -163,7 +163,7 @@ A dictionary with information about the account currently in the session. -`IBMProvider.backends(name=None, filters=None, min_num_qubits=None, instance=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider.backends(name=None, filters=None, min_num_qubits=None, instance=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Return all backends accessible via this account, subject to optional filtering. @@ -213,7 +213,7 @@ The list of available backends that match the filter. -`static IBMProvider.delete_account(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`static IBMProvider.delete_account(name=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Delete a saved account from disk. @@ -235,7 +235,7 @@ True if the account was deleted. False if no account was found. -`IBMProvider.get_backend(name=None, instance=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider.get_backend(name=None, instance=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Return a single backend matching the specified filtering. @@ -264,7 +264,7 @@ Backend -`IBMProvider.instances()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider.instances()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Return the IBM Quantum instances list currently in use for the session. @@ -282,7 +282,7 @@ A list with instances currently in the session. -`IBMProvider.jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider.jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Return a list of jobs, subject to optional filtering. @@ -317,7 +317,7 @@ A list of `IBMJob` instances. -`IBMProvider.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider.retrieve_job(job_id)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Return a single job. @@ -339,7 +339,7 @@ The job with the given id. -`static IBMProvider.save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`static IBMProvider.save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") Save the account to disk for future use. @@ -363,7 +363,7 @@ Save the account to disk for future use. -`static IBMProvider.saved_accounts(default=None, name=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") +`static IBMProvider.saved_accounts(default=None, name=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/ibm_provider.py "view source code") List the accounts saved on disk. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.md index 4596e657c77..4ea70d81f99 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError -`IBMProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raise by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.md index 01ec53a02c3..76833ee0411 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.IBMProviderValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError -`IBMProviderValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.md index cad08074f63..ba77834acd6 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.Session -`Session(max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/session.py "view source code") +`Session(max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/session.py "view source code") Class for creating a flexible Qiskit Runtime session. @@ -99,7 +99,7 @@ Session ID. None until a job runs in the session. -`Session.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/session.py "view source code") +`Session.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/session.py "view source code") Set the session.\_active status to False diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.md index 14289b35968..a625fe2b919 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCircuitJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob -`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Representation of a job that executes on an IBM Quantum backend. @@ -139,7 +139,7 @@ Return the backend where this job was executed. -`IBMCircuitJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the backend configuration options used for this job. @@ -159,7 +159,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMCircuitJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Attempt to cancel the job. @@ -200,7 +200,7 @@ Return whether the job has been cancelled. -`IBMCircuitJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the circuits for this job. @@ -218,7 +218,7 @@ The circuits or for this job. An empty list is returned if the circuits cannot b -`IBMCircuitJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return job creation date, in local time. @@ -250,7 +250,7 @@ Return whether the job has successfully run. -`IBMCircuitJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Provide details about the reason of failure. @@ -268,7 +268,7 @@ An error report if the job failed or `None` otherwise. -`IBMCircuitJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the user header specified for this job. @@ -300,7 +300,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMCircuitJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.job_id()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the job ID assigned by the server. @@ -358,7 +358,7 @@ The backend properties used for this job, at the time the job was run, or `None` -`IBMCircuitJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return queue information for this job. @@ -382,7 +382,7 @@ A [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.Queue -`IBMCircuitJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the position of the job in the server queue. @@ -408,7 +408,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMCircuitJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Obtain the latest job information from the server. @@ -428,7 +428,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMCircuitJob.result(timeout=None, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.result(timeout=None, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the result of the job. @@ -510,7 +510,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMCircuitJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Query the server for the latest job status. @@ -540,7 +540,7 @@ The status of the job. -`IBMCircuitJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Unsupported method. @@ -580,7 +580,7 @@ Tags assigned to this job. -`IBMCircuitJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Return the date and time information on each step of the job processing. @@ -628,7 +628,7 @@ The new name associated with this job. -`IBMCircuitJob.update_tags(new_tags)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.update_tags(new_tags)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Update the tags associated with this job. @@ -655,7 +655,7 @@ The new tags associated with this job. -`IBMCircuitJob.wait_for_final_state(timeout=None, wait=3)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob.wait_for_final_state(timeout=None, wait=3)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") #### Use the websocket server to wait for the final the state of a job. The server diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.md index ad499371585..2ce17571e1e 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMCompositeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob -`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Representation of a set of jobs that execute on an IBM Quantum backend. @@ -97,7 +97,7 @@ Return the backend where this job was executed. -`IBMCompositeJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.backend_options()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the backend configuration options used for this job. @@ -117,7 +117,7 @@ Backend options used for this job. -`IBMCompositeJob.block_for_submit()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.block_for_submit()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Block until all sub-jobs are submitted. @@ -131,7 +131,7 @@ Block until all sub-jobs are submitted. -`IBMCompositeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.cancel()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Attempt to cancel the job. @@ -171,7 +171,7 @@ Return whether the job has been cancelled. -`IBMCompositeJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.circuits()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the circuits for this job. @@ -189,7 +189,7 @@ The circuits for this job. -`IBMCompositeJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.creation_date()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return job creation date, in local time. @@ -221,7 +221,7 @@ Return whether the job has successfully run. -`IBMCompositeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.error_message()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Provide details about the reason of failure. @@ -243,7 +243,7 @@ An error report if the job failed or `None` otherwise. -`classmethod IBMCompositeJob.from_jobs(job_id, jobs, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`classmethod IBMCompositeJob.from_jobs(job_id, jobs, api_client)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return an instance of this class. @@ -269,7 +269,7 @@ An instance of this class. -`IBMCompositeJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.header()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the user header specified for this job. @@ -333,7 +333,7 @@ Job name or `None` if no name was assigned to this job. -`IBMCompositeJob.properties(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.properties(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the backend properties for this job. @@ -365,7 +365,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMCompositeJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.queue_info()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return queue information for this job. @@ -391,7 +391,7 @@ A [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.Queue -`IBMCompositeJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.queue_position(refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the position of the job in the server queue. @@ -419,7 +419,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMCompositeJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.refresh()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Obtain the latest job information from the server. @@ -439,7 +439,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMCompositeJob.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.report(detailed=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return a report on current sub-job statuses. @@ -461,7 +461,7 @@ A report on sub-job statuses. -`IBMCompositeJob.rerun_failed()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.rerun_failed()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Re-submit all failed sub-jobs. @@ -479,7 +479,7 @@ Re-submit all failed sub-jobs. -`IBMCompositeJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.result(timeout=None, wait=5, partial=False, refresh=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the result of the job. @@ -549,7 +549,7 @@ Return whether the job is actively running. -`IBMCompositeJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.scheduling_mode()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the scheduling mode the job is in. @@ -573,7 +573,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMCompositeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.status()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Query the server for the latest job status. @@ -615,7 +615,7 @@ The status of the job. -`IBMCompositeJob.sub_job(circuit_index)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.sub_job(circuit_index)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Retrieve the job used to submit the specified circuit. @@ -641,7 +641,7 @@ The Job submitted for the circuit, or `None` if the job has not been submitted o -`IBMCompositeJob.sub_jobs(block_for_submit=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.sub_jobs(block_for_submit=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return all submitted sub-jobs. @@ -663,7 +663,7 @@ All submitted sub-jobs. -`IBMCompositeJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.submit()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Unsupported method. @@ -703,7 +703,7 @@ Tags assigned to this job. -`IBMCompositeJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.time_per_step()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Return the date and time information on each step of the job processing. @@ -729,7 +729,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMCompositeJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.update_name(name)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Update the name associated with this job. @@ -760,7 +760,7 @@ The new name associated with this job. -`IBMCompositeJob.update_tags(new_tags)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.update_tags(new_tags)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Update the tags associated with this job. @@ -791,7 +791,7 @@ The new tags associated with this job. -`IBMCompositeJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob.wait_for_final_state(timeout=None, wait=None, callback=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.md index a00247d081e..44b6d463e97 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError -`IBMJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.md index 0db698eca26..98114f5b0d0 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError -`IBMJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.md index 6a29845ffd0..9125e7c5f50 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError -`IBMJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.md index 53e1d94f7a8..52bfe481d7d 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError -`IBMJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.md index 921539f26b0..1e01dde2590 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.IBMJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError -`IBMJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.md index bee21730319..7061a3cb703 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo -`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/queueinfo.py "view source code") +`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/queueinfo.py "view source code") Queue information for a job. @@ -66,7 +66,7 @@ Return estimated start time in local time. -`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/queueinfo.py "view source code") +`QueueInfo.format()` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.job_monitor.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.job_monitor.md index c5dbc48f0e4..f3263eb91ae 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.job_monitor.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.job.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/job/job_monitor.py "view source code") Monitor the status of an `IBMJob` instance. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.least_busy.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.least_busy.md index 3db875f86b3..91d44b052dd 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.least_busy.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.least_busy.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.least_busy -`least_busy(backends)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/__init__.py "view source code") +`least_busy(backends)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index e1c2959ff71..42ba3d40560 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. @@ -121,7 +121,7 @@ Name of the pass. -`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.45)") :param dag: DAG to schedule. :type dag: DAGCircuit diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 8f57c9c4540..aa5bc945d5b 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. @@ -121,7 +121,7 @@ Name of the pass. -`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis.run(dag)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v0.45)") :param dag: DAG to schedule. :type dag: DAGCircuit diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md index 404b940b8f6..5f318be23ff 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. @@ -112,7 +112,7 @@ Name of the pass. -`BlockBasePadder.run(dag)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder.run(dag)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 99ea8ed5b11..11b57d7590a 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. @@ -117,7 +117,7 @@ Set of units used in this instruction durations. -`DynamicCircuitInstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations.update(inst_durations, dt=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md index 435234bc4ab..9d9cc31ea96 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay -`PadDelay(fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md index d2793235276..8196b825b4e 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.seconds_to_duration.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.seconds_to_duration.md index dc8305df66c..5b8c6a4e7f3 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.seconds_to_duration.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.seconds_to_duration.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.to_python_identifier.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.to_python_identifier.md index d30697dc36d..2b2c0a271c5 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.to_python_identifier.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.to_python_identifier.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.utc_to_local.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.utc_to_local.md index 5da694da13c..df2a316fdb0 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.utc_to_local.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.utc_to_local.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.validate_job_tags.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.validate_job_tags.md index a9254617954..f9dfc7933e1 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.validate_job_tags.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.utils.validate_job_tags.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_error_map.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_error_map.md index f038a764762..382b7625e6d 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_error_map.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_error_map -`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") +`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") Plot the error map of a device. diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_gate_map.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_gate_map.md index 90b83947e11..1ed9da04d67 100644 --- a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_gate_map.md +++ b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.visualization.iplot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_gate_map -`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") +`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.7/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") Plots an interactive gate map of a device. From 676e3884056e175fa417d10eb0b12e9afc319f5d Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:07:03 +0100 Subject: [PATCH 38/41] Regenerate qiskit-ibm-provider 0.8.0 --- .../qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.md | 2 +- .../0.8/qiskit_ibm_provider.IBMBackendApiError.md | 2 +- .../0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.md | 2 +- .../0.8/qiskit_ibm_provider.IBMBackendError.md | 2 +- .../0.8/qiskit_ibm_provider.IBMBackendService.md | 2 +- .../0.8/qiskit_ibm_provider.IBMBackendValueError.md | 2 +- .../api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.md | 2 +- .../qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.md | 2 +- .../0.8/qiskit_ibm_provider.IBMProviderError.md | 2 +- .../0.8/qiskit_ibm_provider.IBMProviderValueError.md | 2 +- docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMCircuitJob.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMCompositeJob.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMJobApiError.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMJobError.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMJobFailureError.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.md | 2 +- .../0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.md | 2 +- .../0.8/qiskit_ibm_provider.job.QueueInfo.md | 2 +- .../0.8/qiskit_ibm_provider.job.job_monitor.md | 2 +- .../qiskit-ibm-provider/0.8/qiskit_ibm_provider.least_busy.md | 2 +- ...rovider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...rovider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ...ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...iler.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- ...qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md | 2 +- ...vider.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- .../0.8/qiskit_ibm_provider.utils.seconds_to_duration.md | 2 +- .../0.8/qiskit_ibm_provider.utils.to_python_identifier.md | 2 +- .../0.8/qiskit_ibm_provider.utils.utc_to_local.md | 2 +- .../0.8/qiskit_ibm_provider.utils.validate_job_tags.md | 2 +- .../0.8/qiskit_ibm_provider.visualization.iplot_error_map.md | 2 +- .../0.8/qiskit_ibm_provider.visualization.iplot_gate_map.md | 2 +- 33 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.md index 5b8643dc3dd..5df823a15f8 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend -`IBMBackend(configuration, provider, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend(configuration, provider, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum device. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.md index e3273eaa647..7ecf2b3a4a8 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError -`IBMBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.md index c9d5173b594..26392efadf0 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError -`IBMBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.md index 39e5202c6c4..944d84deb6b 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError -`IBMBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.md index 8a16b126f4a..3018960227a 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService -`IBMBackendService(provider, hgp)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService(provider, hgp)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/ibm_backend_service.py "view source code") Backend namespace for an IBM Quantum account. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.md index 99884277f95..373f5500c91 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError -`IBMBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.md index fc152277898..8aa55270cf8 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMError -`IBMError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.md index da0f7ba0274..791d8189d58 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider -`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/ibm_provider.py "view source code") Provides access to the IBM Quantum services available to an account. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.md index 221d8d04435..f7dc3dccf58 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError -`IBMProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raise by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.md index 0d74a62f48e..f078a9de916 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.IBMProviderValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError -`IBMProviderValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.md index 8eb79a68696..ee5f1c7281d 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.Session -`Session(max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/session.py "view source code") +`Session(max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.md index f35ab23b748..61fbc13b31b 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCircuitJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob -`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Representation of a job that executes on an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.md index 011d06ad9e5..2a0eeba6b54 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMCompositeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob -`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Representation of a set of jobs that execute on an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.md index 6ae8160af50..55489113f09 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError -`IBMJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.md index d22be4af676..89538972cce 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError -`IBMJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.md index 7092bc907ae..29b06ab70b6 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError -`IBMJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.md index 2b781424994..0ae61b58ab9 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError -`IBMJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.md index e8ccbc16793..8762b8517d9 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.IBMJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError -`IBMJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.md index d3d38d1581a..27e8f0720d6 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo -`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/queueinfo.py "view source code") +`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.job_monitor.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.job_monitor.md index b68fc874934..24cf5ede658 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.job_monitor.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.job.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/job/job_monitor.py "view source code") Monitor the status of an `IBMJob` instance. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.least_busy.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.least_busy.md index f608296af89..ce5ccf091d6 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.least_busy.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.least_busy.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.least_busy -`least_busy(backends)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/__init__.py "view source code") +`least_busy(backends)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index 30439be9f94..0c94cc34930 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index cc564dc262a..aa17b1750e9 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md index 022083b0050..253e271bbc1 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index f3fc7ec80b1..d7c560371d2 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md index b1dbd725329..c3d9557b397 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay -`PadDelay(fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 8c8356ad6f6..b962ac9cc2b 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.seconds_to_duration.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.seconds_to_duration.md index f508e79035f..7a7deac2b7f 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.seconds_to_duration.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.seconds_to_duration.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.to_python_identifier.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.to_python_identifier.md index 440607a86f6..174b09403a5 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.to_python_identifier.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.to_python_identifier.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.utc_to_local.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.utc_to_local.md index 801b7bd34fb..a65a4fdae2a 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.utc_to_local.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.utc_to_local.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.validate_job_tags.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.validate_job_tags.md index 960f7919dac..471ccb866aa 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.validate_job_tags.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.utils.validate_job_tags.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_error_map.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_error_map.md index dd92148797e..10c1c78914a 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_error_map.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_error_map -`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") +`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") Plot the error map of a device. diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_gate_map.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_gate_map.md index 47ac4a8b95c..3094345f11c 100644 --- a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_gate_map.md +++ b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.visualization.iplot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_gate_map -`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") +`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.8/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") Plots an interactive gate map of a device. From 20ab277a767d1b68ef3ce82b927090146d1c8a53 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:07:13 +0100 Subject: [PATCH 39/41] Regenerate qiskit-ibm-provider 0.9.0 --- docs/api/qiskit-ibm-provider/0.9/ibm_utils.md | 4 ++-- .../qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md | 2 +- .../0.9/qiskit_ibm_provider.IBMBackendApiError.md | 2 +- .../0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.md | 2 +- .../0.9/qiskit_ibm_provider.IBMBackendError.md | 2 +- .../0.9/qiskit_ibm_provider.IBMBackendService.md | 2 +- .../0.9/qiskit_ibm_provider.IBMBackendValueError.md | 2 +- .../qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.md | 2 +- .../0.9/qiskit_ibm_provider.IBMProvider.md | 2 +- .../0.9/qiskit_ibm_provider.IBMProviderError.md | 2 +- .../0.9/qiskit_ibm_provider.IBMProviderValueError.md | 2 +- .../qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMCircuitJob.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMCompositeJob.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMJobApiError.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMJobError.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMJobFailureError.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.md | 2 +- .../0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.md | 2 +- .../0.9/qiskit_ibm_provider.job.QueueInfo.md | 2 +- .../0.9/qiskit_ibm_provider.job.job_monitor.md | 2 +- .../qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md | 2 +- ...vider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...vider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ...m_provider.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...er.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- ...skit_ibm_provider.transpiler.passes.scheduling.PadDelay.md | 2 +- ...der.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- .../0.9/qiskit_ibm_provider.utils.seconds_to_duration.md | 2 +- .../0.9/qiskit_ibm_provider.utils.to_python_identifier.md | 2 +- .../0.9/qiskit_ibm_provider.utils.utc_to_local.md | 2 +- .../0.9/qiskit_ibm_provider.utils.validate_job_tags.md | 2 +- .../0.9/qiskit_ibm_provider.visualization.iplot_error_map.md | 2 +- .../0.9/qiskit_ibm_provider.visualization.iplot_gate_map.md | 2 +- 34 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_utils.md b/docs/api/qiskit-ibm-provider/0.9/ibm_utils.md index d82fd9b3592..8b8a47e611d 100644 --- a/docs/api/qiskit-ibm-provider/0.9/ibm_utils.md +++ b/docs/api/qiskit-ibm-provider/0.9/ibm_utils.md @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism -`Publisher`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/pubsub.py "view source code") +`Publisher` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/pubsub.py "view source code") Represents a “publisher”. @@ -68,7 +68,7 @@ Triggers an event, and associates some data to it, so if there are any subscribe -`Subscriber`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/pubsub.py "view source code") +`Subscriber` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/pubsub.py "view source code") Represents a “subscriber”. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md index e8fc8662310..57e7b5e90a5 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend -`IBMBackend(configuration, provider, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend(configuration, provider, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum device. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.md index 4bc2b74adf6..bee60588b58 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError -`IBMBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.md index 300a83a331d..f061d96df0f 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError -`IBMBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.md index 1743637a528..978751e8c9c 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError -`IBMBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md index ca99c6b0fc8..5ea2323b570 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService -`IBMBackendService(provider, hgp)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService(provider, hgp)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/ibm_backend_service.py "view source code") Backend namespace for an IBM Quantum account. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.md index 32c19357135..a4744ab196f 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError -`IBMBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.md index 1aca2603a0e..182017829e5 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMError -`IBMError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.md index 8e82fdcb9d6..a9621931eaf 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider -`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/ibm_provider.py "view source code") Provides access to the IBM Quantum services available to an account. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.md index 680b1dbfaa9..80905b796f1 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError -`IBMProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raise by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.md index 335ceecc83f..d26360180d9 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.IBMProviderValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError -`IBMProviderValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.md index f1aea9e57e8..c4160b94f88 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.Session -`Session(max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/session.py "view source code") +`Session(max_time=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md index 5b7818816ce..f776c3c7a59 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCircuitJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob -`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Representation of a job that executes on an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md index 7c521bf3b31..36d7dabe2d7 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMCompositeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob -`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Representation of a set of jobs that execute on an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.md index 01d31cbcb05..06136810827 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError -`IBMJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.md index 67c71709c7d..2e217306bb9 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError -`IBMJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.md index 7b39382f374..1cb58285202 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError -`IBMJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.md index 8154950d17e..088d8ca19bd 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError -`IBMJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.md index 0017ef4a500..499c58d3bcb 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.IBMJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError -`IBMJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.md index 831f50b3584..12d7cd93e04 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo -`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/queueinfo.py "view source code") +`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.job_monitor.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.job_monitor.md index 16af83243fe..8508cbdbe4b 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.job_monitor.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.job.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/job/job_monitor.py "view source code") Monitor the status of an `IBMJob` instance. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md index 5a44a82387c..9dfdedd050f 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.least_busy.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.least_busy -`least_busy(backends)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/__init__.py "view source code") +`least_busy(backends)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index 2aa349abcb2..c0e42ef0c40 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 4f3780c1431..93cb8a932d2 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md index b4559faff87..9a7b72fda0c 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index cd306c0fdf4..93bc8b97e8b 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md index 6cce524e135..b0bc27b1bac 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay -`PadDelay(fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 348e6362220..c5669e727b9 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.seconds_to_duration.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.seconds_to_duration.md index 33be2bf3a09..51ca3d6671f 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.seconds_to_duration.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.seconds_to_duration.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.to_python_identifier.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.to_python_identifier.md index 9ea18aaaeae..abfd062d9ba 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.to_python_identifier.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.to_python_identifier.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.utc_to_local.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.utc_to_local.md index 49064cd23ba..e76fefa9e75 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.utc_to_local.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.utc_to_local.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.validate_job_tags.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.validate_job_tags.md index 64f346e6fa4..1a2f894ba42 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.validate_job_tags.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.utils.validate_job_tags.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_error_map.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_error_map.md index 7b644183726..ab33cd20e41 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_error_map.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_error_map -`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") +`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") Plot the error map of a device. diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_gate_map.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_gate_map.md index 355975019ba..6b9d2aeed28 100644 --- a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_gate_map.md +++ b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.visualization.iplot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_gate_map -`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") +`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.9/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") Plots an interactive gate map of a device. From a730cecfd994c5e85139b9504e54f947efaff3cb Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:07:22 +0100 Subject: [PATCH 40/41] Regenerate qiskit-ibm-provider 0.10.0 --- docs/api/qiskit-ibm-provider/ibm_utils.md | 4 ++-- .../api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md | 2 +- .../qiskit_ibm_provider.IBMBackendApiError.md | 2 +- .../qiskit_ibm_provider.IBMBackendApiProtocolError.md | 2 +- .../qiskit_ibm_provider.IBMBackendError.md | 2 +- .../qiskit_ibm_provider.IBMBackendService.md | 2 +- .../qiskit_ibm_provider.IBMBackendValueError.md | 2 +- docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.md | 2 +- .../qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md | 2 +- .../qiskit_ibm_provider.IBMProviderError.md | 2 +- .../qiskit_ibm_provider.IBMProviderValueError.md | 2 +- docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md | 2 +- .../qiskit_ibm_provider.job.IBMCircuitJob.md | 2 +- .../qiskit_ibm_provider.job.IBMCompositeJob.md | 2 +- .../qiskit_ibm_provider.job.IBMJobApiError.md | 2 +- .../qiskit_ibm_provider.job.IBMJobError.md | 2 +- .../qiskit_ibm_provider.job.IBMJobFailureError.md | 2 +- .../qiskit_ibm_provider.job.IBMJobInvalidStateError.md | 2 +- .../qiskit_ibm_provider.job.IBMJobTimeoutError.md | 2 +- .../qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.md | 2 +- .../qiskit_ibm_provider.job.job_monitor.md | 2 +- .../api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md | 2 +- ...vider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md | 2 +- ...vider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md | 2 +- ...m_provider.transpiler.passes.scheduling.BlockBasePadder.md | 2 +- ...er.passes.scheduling.DynamicCircuitInstructionDurations.md | 2 +- ...skit_ibm_provider.transpiler.passes.scheduling.PadDelay.md | 2 +- ...der.transpiler.passes.scheduling.PadDynamicalDecoupling.md | 2 +- .../qiskit_ibm_provider.utils.seconds_to_duration.md | 2 +- .../qiskit_ibm_provider.utils.to_python_identifier.md | 2 +- .../qiskit_ibm_provider.utils.utc_to_local.md | 2 +- .../qiskit_ibm_provider.utils.validate_job_tags.md | 2 +- .../qiskit_ibm_provider.visualization.iplot_error_map.md | 2 +- .../qiskit_ibm_provider.visualization.iplot_gate_map.md | 2 +- 34 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/api/qiskit-ibm-provider/ibm_utils.md b/docs/api/qiskit-ibm-provider/ibm_utils.md index 37c39bbc11a..a43aea45049 100644 --- a/docs/api/qiskit-ibm-provider/ibm_utils.md +++ b/docs/api/qiskit-ibm-provider/ibm_utils.md @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism -`Publisher`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py "view source code") +`Publisher` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py "view source code") Represents a “publisher”. @@ -68,7 +68,7 @@ Triggers an event, and associates some data to it, so if there are any subscribe -`Subscriber`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py "view source code") +`Subscriber` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py "view source code") Represents a “subscriber”. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md index 3ebc950f9c6..5e60cb637e5 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend -`IBMBackend(configuration, provider, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py "view source code") +`IBMBackend(configuration, provider, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py "view source code") Backend class interfacing with an IBM Quantum device. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.md index 82328077eb3..9b8eeeebdfa 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError -`IBMBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.md index 2df9d15877b..12d7ac2fe90 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError -`IBMBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.md index a6d5255fdf9..8b792f474b3 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError -`IBMBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md index beb8d5b4c0d..ff2c4436685 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService -`IBMBackendService(provider, hgp)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py "view source code") +`IBMBackendService(provider, hgp)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py "view source code") Backend namespace for an IBM Quantum account. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.md index eab6e186d65..7de86a58d27 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError -`IBMBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.md index f763c16fdde..d154a6102c8 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMError -`IBMError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md index 35a71cc0945..6bf10cd32dc 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider -`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py "view source code") +`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py "view source code") Provides access to the IBM Quantum services available to an account. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.md index fde539c9e9c..185286d948b 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError -`IBMProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Base class for errors raise by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.md index a99a606cc63..b0654affc19 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError -`IBMProviderValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") +`IBMProviderValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code") Value errors raised by IBMProvider. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md index f65d69a573b..9c4f9b6c82e 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.Session -`Session(max_time=None, session_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py "view source code") +`Session(max_time=None, session_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md index 76e468acd0d..6d8858fab60 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob -`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") +`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") Representation of a job that executes on an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md index a1e2fa9c2ff..58e64793c65 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob -`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") +`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py "view source code") Representation of a set of jobs that execute on an IBM Quantum backend. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.md index 1a7259c2d89..c4341b2da3c 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError -`IBMJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.md index 934286f5ea5..3ee6d057dad 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError -`IBMJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.md index 4286e8ef596..e5c5c7b8c50 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError -`IBMJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.md index eceedd81e33..b86e89ccd57 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError -`IBMJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.md index a69295252bc..31c41a7b51c 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError -`IBMJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") +`IBMJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.md index 06b7f95eb76..29e0c61e0bb 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo -`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/queueinfo.py "view source code") +`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/queueinfo.py "view source code") Queue information for a job. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor.md index da93a8e9776..90979fef3f3 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.job.job_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/job_monitor.py "view source code") +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/job_monitor.py "view source code") Monitor the status of an `IBMJob` instance. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md index 95d2f70ec7b..9c86f10df56 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.least_busy -`least_busy(backends)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/__init__.py "view source code") +`least_busy(backends)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index d310cf01352..f216caee8fb 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn -`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 1823f6e88ef..2a13a765529 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn -`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md index 4d8bce7b64c..fcee9db9d09 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde -`BlockBasePadder(schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code") The base class of padding pass. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 1cf385e1c36..74eed7bffc9 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md index 8d6bde8e250..9260cfabfde 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay -`PadDelay(fill_very_end=True, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") +`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code") Padding idle time with Delay instructions. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md index e53ece63452..6abf481ebc1 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration.md index ba0d4b84551..2604e0e6d20 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.seconds_to_duration -`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py "view source code") +`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier.md index 467ff1fa681..21c0f156a4b 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.to_python_identifier -`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py "view source code") +`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local.md index 535beaa6564..d6fea5c719b 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.utc_to_local -`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py "view source code") +`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags.md index f6bed66dcbf..bb81910708d 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.validate_job_tags -`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py "view source code") +`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map.md index d06491b4de1..b6c64e8b925 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_error_map -`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") +`iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/visualization/interactive/error_map.py "view source code") Plot the error map of a device. diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map.md index 912ea31f42d..0bd62163238 100644 --- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map.md +++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.visualization.iplot_gate_map -`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)`[GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") +`iplot_gate_map(backend, figsize=(None, None), label_qubits=True, qubit_size=None, line_width=None, font_size=None, qubit_color='#2f4b7c', qubit_labels=None, line_color='#2f4b7c', font_color='white', background_color='white', as_widget=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/visualization/interactive/gate_map.py "view source code") Plots an interactive gate map of a device. From d37a9f15984218caafe159b9116ee379a93af71f Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Wed, 28 Feb 2024 18:35:34 +0100 Subject: [PATCH 41/41] fix tests --- scripts/lib/api/htmlToMd.test.ts | 12 ++++++------ scripts/lib/api/processHtml.test.ts | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/scripts/lib/api/htmlToMd.test.ts b/scripts/lib/api/htmlToMd.test.ts index 9a978c75bdc..7b9a77aa029 100644 --- a/scripts/lib/api/htmlToMd.test.ts +++ b/scripts/lib/api/htmlToMd.test.ts @@ -431,7 +431,7 @@ describe("sphinxHtmlToMarkdown", () => { - \`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/options/options.py "view source code") + \`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)\` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/options/options.py "view source code") " `); }); @@ -639,7 +639,7 @@ Can be either (1) a dictionary mapping XX angle values to fidelity at that angle - \`Estimator.run(circuits, observables, parameter_values=None, **kwargs)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/estimator.py "view source code") + \`Estimator.run(circuits, observables, parameter_values=None, **kwargs)\` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/estimator.py "view source code") Submit a request to the estimator primitive program. ", @@ -732,7 +732,7 @@ By default this is sys.stdout.

- \`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/job_monitor.py "view source code") + \`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)\` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/job_monitor.py "view source code") Monitor the status of an \`IBMJob\` instance. @@ -784,7 +784,7 @@ By default this is sys.stdout.

- \`IBMJobError(*message)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/exceptions.py "view source code") + \`IBMJobError(*message)\` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/exceptions.py "view source code") Base class for errors raised by the job modules. @@ -925,7 +925,7 @@ bits.

- \`qiskit.dagcircuit.DAGCircuit\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit/dagcircuit/dagcircuit.py "view source code") + \`qiskit.dagcircuit.DAGCircuit\` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: \`object\` @@ -1408,7 +1408,7 @@ test("test dt tag without id", async () => { ).toMatchInlineSnapshot(` "In addition to the public abstract methods, subclasses should also implement the following private methods: - \`classmethod _default_options()\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit/providers/basicaer/qasm_simulator.py "view source code") + \`classmethod _default_options()\` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit/providers/basicaer/qasm_simulator.py "view source code") Return the default options diff --git a/scripts/lib/api/processHtml.test.ts b/scripts/lib/api/processHtml.test.ts index 699e584f6b6..f0bde94a2cd 100644 --- a/scripts/lib/api/processHtml.test.ts +++ b/scripts/lib/api/processHtml.test.ts @@ -461,7 +461,7 @@ describe("processMembersAndSetMeta()", () => { processMembersAndSetMeta(doc.$, doc.$main, meta); doc.expectHtml(`

Circuit Converters

circuit_to_dag

-qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)GitHub

+qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None) GitHub

Build a DAGCircuit object from a QuantumCircuit.

Parameters:
@@ -508,7 +508,7 @@ backends may not have this attribute.

processMembersAndSetMeta(doc.$, doc.$main, meta); doc.expectHtml(`

least_busy

-least_busy(backends)GitHub

+least_busy(backends) GitHub

Return the least busy backend from a list.

Return the least busy available backend for those that have a pending_jobs in their status. Note that local @@ -570,7 +570,7 @@ particular error, which subclasses both qiskit.exceptions)

All Qiskit-related errors raised by Qiskit are subclasses of the base:

QiskitError

-qiskit.exceptions.QiskitError(*message)GitHub

+qiskit.exceptions.QiskitError(*message) GitHub

Base class for errors raised by Qiskit.

Set the error message.